benoit@0: {# benoit@0: # Description: benoit@0: # Web Template used in Farol Design benoit@0: # benoit@0: # Authors: benoit@0: # Benoît Allard benoit@0: # benoit@0: # Copyright: benoit@0: # Copyright (C) 2014 Greenbone Networks GmbH benoit@0: # benoit@0: # This program is free software; you can redistribute it and/or benoit@0: # modify it under the terms of the GNU General Public License benoit@0: # as published by the Free Software Foundation; either version 2 benoit@0: # of the License, or (at your option) any later version. benoit@0: # benoit@0: # This program is distributed in the hope that it will be useful, benoit@0: # but WITHOUT ANY WARRANTY; without even the implied warranty of benoit@0: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the benoit@0: # GNU General Public License for more details. benoit@0: # benoit@0: # You should have received a copy of the GNU General Public License benoit@0: # along with this program; if not, write to the Free Software benoit@0: # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. benoit@0: -#} benoit@0: benoit@0: {% extends "base.j2" %} benoit@36: {% from "macros.j2" import textinput, textarea, selectinput, panel, examples %} benoit@0: {% block title %}Edit the type{% endblock %} benoit@0: benoit@0: {% block content %} benoit@43:

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

benoit@0:
benoit@0: benoit@36: {% call textinput("id", "ID", value=tracking._identification._id, required=True) %} benoit@36:

ID 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.

benoit@36: {{ examples(['01', '29834841', '0xABCDEF', '100-200-301']) }} benoit@36: {% endcall %} benoit@36: {% call textinput("id_aliases", "Aliases", value=', '.join(tracking._identification._aliases), benoit@36: help="Multiple aliases should be separated by commas.") %} benoit@36:

Alias 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 Alias presents an interface to publish those alongside the primary ID.

benoit@36: {% endcall %} benoit@36: {% call selectinput("status", "Status", statuses, tracking._status) %} benoit@36:

Status refers to the condition of the document with regard to completeness and the likelihood of future editions.

benoit@36:

Status types are:

benoit@40:
benoit@40:
Draft:
benoit@40:
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.
benoit@40:
Interim:
benoit@40:
The issuing party believes the content is subject to change.
benoit@40:
Final:
benoit@40:
The issuing party asserts the content is unlikely to change. Final status is an indication only, and does not preclude updates.
benoit@40:
benoit@36:

Issuing parties are strongly recommended to set Status to Draft 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.

benoit@36: {% endcall %} benoit@126: {% call textinput("version", "Version", value=version, required=True, regex='(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*)){0,3}') %} benoit@36:

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: (0|[1-9][0-9]*)(\.(0|[1-9][0-9]*)){0,3}.

benoit@36: {{ examples(['1.0', '1.0.1', '1.0.0.1']) }} benoit@36: {% endcall %} benoit@36: {% call textinput("initial", "Initial Release Date", value=tracking._initialDate.isoformat(), required=True, type="datetime") %} benoit@36:

Initial Release Date 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.

benoit@36: {{ examples(['2011-11-26T00:00:00+00:00']) }} benoit@36: {% endcall %} benoit@36: {% call textinput("current", "Current Release Date", value=tracking._currentDate.isoformat(), required=True, type="datetime") %} benoit@36:

Current Release Date 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.

benoit@36: {{ examples(['2011-11-26T00:00:00+00:00']) }} benoit@36: {% endcall %} benoit@0: benoit@0: {% call panel(heading="Generator", title=3, collapsible=False) %} benoit@43:

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.

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

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

benoit@36: {{ examples(['Mike Schiffman’s sublime fingertips version 1.0']) }} benoit@36: {% endcall %} benoit@36: {% call textinput("gen_date", "Generator Date", now.isoformat(), generator._date and generator._date.isoformat() or None, type="datetime") %} benoit@36:

Date 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 Initial Release Date. 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.

benoit@36: {{ examples(['2012-02-27T00:00:00+00:00']) }} benoit@36: {% endcall %} benoit@0: {% endcall %} benoit@0: benoit@0: benoit@10: Cancel benoit@0:
benoit@0: {% endblock %}