changeset 43:c79082d0d44d

Add global descriptions about some containers
author Benoît Allard <benoit.allard@greenbone.net>
date Mon, 06 Oct 2014 15:58:25 +0200
parents 3b56ea034f2f
children df5182d0787f 0576cbcd28fe
files farol/templates/document/edit_publisher.j2 farol/templates/document/edit_revision.j2 farol/templates/document/edit_tracking.j2
diffstat 3 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/farol/templates/document/edit_publisher.j2	Mon Oct 06 15:49:59 2014 +0200
+++ b/farol/templates/document/edit_publisher.j2	Mon Oct 06 15:58:25 2014 +0200
@@ -28,6 +28,7 @@
 {% block title %}Edit the type{% endblock %}
 
 {% block content %}
+<p><strong>Document Publisher</strong> is a container that holds all the information about the publisher of the CVRF document, including attributes denoting the <em>Type</em> of publisher and an optional <em>Vendor ID</em> as well as optional elements for <strong>Contact Details</strong> and <strong>Issuing Authority</strong>.</p>
 <form role="form" method="POST">
 
 {% call selectinput("type", "Type", types, publisher._type) %}
--- a/farol/templates/document/edit_revision.j2	Mon Oct 06 15:49:59 2014 +0200
+++ b/farol/templates/document/edit_revision.j2	Mon Oct 06 15:58:25 2014 +0200
@@ -28,6 +28,7 @@
 {% block title %}Edit Revision{% endblock %}
 
 {% block content %}
+<p><strong>Revision</strong> contains all the elements required to track the evolution of a CVRF document. Each change to a CVRF document should be accompanied by <strong>Number</strong>, <strong>Date</strong>, and <strong>Description</strong> elements.</p>
 <form role="form" method="POST">
   {% 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>
--- a/farol/templates/document/edit_tracking.j2	Mon Oct 06 15:49:59 2014 +0200
+++ b/farol/templates/document/edit_tracking.j2	Mon Oct 06 15:58:25 2014 +0200
@@ -28,6 +28,7 @@
 {% block title %}Edit the type{% endblock %}
 
 {% block content %}
+<p>The <strong>Document Tracking</strong> container contains all the attributes necessary to track a CVRF document.</p>
 <form role="form" method="POST">
 
 {% call textinput("id", "ID", value=tracking._identification._id, required=True) %}
@@ -65,6 +66,7 @@
 {% endcall %}
 
 {% call panel(heading="Generator", title=3, collapsible=False) %}
+  <p>The <strong>Generator</strong> container contains all the elements related to the generation of the document. These items will reference when the document was actually created, including the date it was generated and the entity that generated it.</p>
   {% call textinput("gen_engine", "Generator Engine", value=generator._engine or '') %}
   <p><strong>Engine</strong> will refer to the name and optional version of the engine that generated the CVRF document.</p>
   {{ examples(['Mike Schiffman’s sublime fingertips version 1.0']) }}

http://farol.wald.intevation.org