Mercurial > farol > farol
annotate farol/templates/document/edit_tracking.j2 @ 36:3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
| author | Benoît Allard <benoit.allard@greenbone.net> |
|---|---|
| date | Mon, 06 Oct 2014 14:44:33 +0200 |
| parents | 4219d6fb4c38 |
| children | 5e6eed63ff07 |
| rev | line source |
|---|---|
| 0 | 1 {# |
| 2 # Description: | |
| 3 # Web Template used in Farol Design | |
| 4 # | |
| 5 # Authors: | |
| 6 # Benoît Allard <benoit.allard@greenbone.net> | |
| 7 # | |
| 8 # Copyright: | |
| 9 # Copyright (C) 2014 Greenbone Networks GmbH | |
| 10 # | |
| 11 # This program is free software; you can redistribute it and/or | |
| 12 # modify it under the terms of the GNU General Public License | |
| 13 # as published by the Free Software Foundation; either version 2 | |
| 14 # of the License, or (at your option) any later version. | |
| 15 # | |
| 16 # This program is distributed in the hope that it will be useful, | |
| 17 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 19 # GNU General Public License for more details. | |
| 20 # | |
| 21 # You should have received a copy of the GNU General Public License | |
| 22 # along with this program; if not, write to the Free Software | |
| 23 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 24 -#} | |
| 25 | |
| 26 {% extends "base.j2" %} | |
|
36
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
27 {% from "macros.j2" import textinput, textarea, selectinput, panel, examples %} |
| 0 | 28 {% block title %}Edit the type{% endblock %} |
| 29 | |
| 30 {% block content %} | |
| 31 <form role="form" method="POST"> | |
| 32 | |
|
36
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
33 {% call textinput("id", "ID", value=tracking._identification._id, required=True) %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
34 <p><strong>ID</strong> is a short, unique identifier used to refer to the document unambiguously in any context. The ID is a simple label. It is a string data type to provide for a wide range of numbering values, types, and schemes. Typically, the ID should be assigned and maintained by the original document issuing authority. It is recommended that the ID be a monotonically increasing value, or increasing in such a predictable manner that it does not contribute toward confusion or misnumbering. Careful consideration is required to ensure that construction of the ID does not contribute to confusion or collision with other labels.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
35 {{ examples(['01', '29834841', '0xABCDEF', '100-200-301']) }} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
36 {% endcall %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
37 {% call textinput("id_aliases", "Aliases", value=', '.join(tracking._identification._aliases), |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
38 help="Multiple aliases should be separated by commas.") %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
39 <p><strong>Alias</strong> is an optional alternative ID used to refer to the document. Many vendors have one or more alternative or secondary IDs for documents and the <strong>Alias</strong> presents an interface to publish those alongside the primary ID.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
40 {% endcall %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
41 {% call selectinput("status", "Status", statuses, tracking._status) %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
42 <p><strong>Status</strong> refers to the condition of the document with regard to completeness and the likelihood of future editions.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
43 <p>Status types are:</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
44 <ul> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
45 <li><strong>Draft</strong>: Pre-release, intended for issuing party’s internal use only, or possibly used externally when the party is seeking feedback or indicating its intentions regarding a specific issue.</li> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
46 <li><strong>Interim</strong>: The issuing party believes the content is subject to change.</li> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
47 <li><strong>Final</strong>: The issuing party asserts the content is unlikely to change. “Final” status is an indication only, and does not preclude updates.</li> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
48 </ul> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
49 <p>Issuing parties are strongly recommended to set <strong>Status</strong> to <samp>Draft</samp> when initiating a new document and to implement procedures to ensure that the status is changed to the appropriate value before the document is released.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
50 {% endcall %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
51 {% call textinput("version", "Version", value=version, required=True) %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
52 <p>Version is a simple counter to track the version of the document. This is a numeric tokenized field of the format “nn” – “nn.nn.nn.nn”. It may be incremented in either major or minor notation to denote clearly the evolution of the content of the document. Issuing parties must ensure that this field is incremented appropriately, even for the least editorial or grammatical changes, when the field is used. It is validated using the following regular expression: <code>(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*)){0,3}</code>.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
53 {{ examples(['1.0', '1.0.1', '1.0.0.1']) }} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
54 {% endcall %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
55 {% call textinput("initial", "Initial Release Date", value=tracking._initialDate.isoformat(), required=True, type="datetime") %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
56 <p><strong>Initial Release Date</strong> is the date (and time, optionally) that the document was initially released by the issuing party. All dateTime values in CVRF require a time, and we recommend the inclusion of a time zone as well (ICASI endorses the use of GMT or “Zulu time”). If a time zone is excluded, Zulu should be assumed.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
57 {{ examples(['2011-11-26T00:00:00+00:00']) }} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
58 {% endcall %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
59 {% call textinput("current", "Current Release Date", value=tracking._currentDate.isoformat(), required=True, type="datetime") %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
60 <p><strong>Current Release Date</strong> is the current date (and time, optionally) that the document was released by the issuing party. All dateTime values in CVRF require a time, and we recommend the inclusion of a time zone as well (ICASI endorses the use of GMT or “Zulu time”). If a time zone is excluded, Zulu should be assumed.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
61 {{ examples(['2011-11-26T00:00:00+00:00']) }} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
62 {% endcall %} |
| 0 | 63 |
| 64 {% call panel(heading="Generator", title=3, collapsible=False) %} | |
|
36
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
65 {% call textinput("gen_engine", "Generator Engine", value=generator._engine or '') %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
66 <p><strong>Engine</strong> will refer to the name and optional version of the engine that generated the CVRF document.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
67 {{ examples(['Mike Schiffman’s sublime fingertips version 1.0']) }} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
68 {% endcall %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
69 {% call textinput("gen_date", "Generator Date", now.isoformat(), generator._date and generator._date.isoformat() or None, type="datetime") %} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
70 <p><strong>Date</strong> will refer to the date the CVRF document was generated. Because documents are often generated internally by a document producer and exist for a nonzero amount of time before being released, this field can be different from the <strong>Initial Release Date</strong>. All dateTime values in CVRF require a time, and we recommend the inclusion of a time zone as well (ICASI endorses the use of GMT or “Zulu time”). If a time zone is excluded, Zulu should be assumed.</p> |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
71 {{ examples(['2012-02-27T00:00:00+00:00']) }} |
|
3b49063d76e0
Add Descriptions for the fields of the edit_tracking section
Benoît Allard <benoit.allard@greenbone.net>
parents:
12
diff
changeset
|
72 {% endcall %} |
| 0 | 73 {% endcall %} |
| 74 | |
| 75 <button class="btn btn-primary" type="submit">Update</button> | |
| 10 | 76 <a class="btn btn-danger" href="{{ url_for('.view') }}">Cancel</a> |
| 0 | 77 </form> |
| 78 {% endblock %} |