# HG changeset patch
# User Benoît Allard <benoit.allard@greenbone.net>
# Date 1412600018 -7200
# Node ID 0c726d873c7a0a55c5a77a928ba921b9b9cb9752
# Parent  3b49063d76e04c070dae84573840bab095cdff39
Add Description fields for the edit_revision fields

diff -r 3b49063d76e0 -r 0c726d873c7a farol/templates/document/edit_revision.j2
--- a/farol/templates/document/edit_revision.j2	Mon Oct 06 14:44:33 2014 +0200
+++ b/farol/templates/document/edit_revision.j2	Mon Oct 06 14:53:38 2014 +0200
@@ -24,14 +24,29 @@
 -#}
 
 {% extends "base.j2" %}
-{% from "macros.j2" import textinput, textarea %}
+{% from "macros.j2" import textinput, textarea, examples %}
 {% block title %}Edit Revision{% endblock %}
 
 {% block content %}
 <form role="form" method="POST">
-  {{ textinput("number", "Version", "a.b.c.d", number, required=True) }}
-  {{ textinput("date", "Date", "", date and date.isoformat() or '', required=True, type="datetime") }}
-  {{ textarea("description", "Description", "", description, 3, required=True) }}
+  {% call textinput("number", "Number", "a.b.c.d", number, required=True) %}
+  <p><strong>Number</strong> should contain the numeric version of the document. Like the <strong>Version</strong> element above, it is a numeric tokenized field of the format “nn” with up to four fields “nn.nn.nn.nn”. It is recommended that this be a monotonically increasing value. Minor revisions should be used for less-significant changes (for example, <samp>1.0.0.0</samp> to <samp>1.0.0.1</samp>). Major, actionable changes should lead to a major increase of the version number (for example, <samp>1.0</samp> to <samp>2.0</samp>).</p>
+  <p>Examples of such changes include:</p>
+  <ul>
+    <li>Any change to severity or impact</li>
+    <li>The announcement of additional vulnerabilities</li>
+    <li>The announcement of additional vulnerable products</li>
+    <li>A significant change in remediation status</li>
+  </ul>
+  <p>The most recent <strong>Number</strong> element should <em>always</em> match the <strong>Version</strong> element. It is validated using the following regular expression: <code>(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*)){0,3}</code>.</p>
+  {% endcall %}
+  {% call textinput("date", "Date", "", date and date.isoformat() or '', required=True, type="datetime") %}
+  <p><strong>Date</strong> should record the date the revision was made. All dateTime values in CVRF require a time, and we recommend the inclusion of a time zone as well (ICASI endorses the use of Greenwich mean time [GMT] or “Zulu time”). If a time zone is excluded, Zulu should be assumed.</p>
+  {% endcall %}
+  {% call textarea("description", "Description", "", description, 3, required=True) %}
+  <p><strong>Description</strong> should be a short description of the changes made. It can describe the conditions that prompted the change or be a short list of the items changed.</p>
+  {{ examples(['initial public release']) }}
+  {% endcall %}
   {% if action == 'Add' %}
     <div class="form-group">
       <div class="checkbox">