# HG changeset patch # User Benoît Allard # Date 1412603905 -7200 # Node ID c79082d0d44d608a9ede03e02bef90000f089eee # Parent 3b56ea034f2fe65f847ac9a57464dfdab769d3c1 Add global descriptions about some containers diff -r 3b56ea034f2f -r c79082d0d44d farol/templates/document/edit_publisher.j2 --- 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 %} +

Document Publisher is a container that holds all the information about the publisher of the CVRF document, including attributes denoting the Type of publisher and an optional Vendor ID as well as optional elements for Contact Details and Issuing Authority.

{% call selectinput("type", "Type", types, publisher._type) %} diff -r 3b56ea034f2f -r c79082d0d44d farol/templates/document/edit_revision.j2 --- 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 %} +

Revision contains all the elements required to track the evolution of a CVRF document. Each change to a CVRF document should be accompanied by Number, Date, and Description elements.

{% call textinput("number", "Number", "a.b.c.d", number, required=True) %}

Number should contain the numeric version of the document. Like the Version 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, 1.0.0.0 to 1.0.0.1). Major, actionable changes should lead to a major increase of the version number (for example, 1.0 to 2.0).

diff -r 3b56ea034f2f -r c79082d0d44d farol/templates/document/edit_tracking.j2 --- 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 %} +

The Document Tracking container contains all the attributes necessary to track a CVRF document.

{% call textinput("id", "ID", value=tracking._identification._id, required=True) %} @@ -65,6 +66,7 @@ {% endcall %} {% call panel(heading="Generator", title=3, collapsible=False) %} +

The Generator 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.

{% call textinput("gen_engine", "Generator Engine", value=generator._engine or '') %}

Engine will refer to the name and optional version of the engine that generated the CVRF document.

{{ examples(['Mike Schiffman’s sublime fingertips version 1.0']) }}