Mercurial > farol > farol
comparison farol/templates/common_edits.j2 @ 49:5583ddcd6164
Unify the edit_note page
| author | Benoît Allard <benoit.allard@greenbone.net> |
|---|---|
| date | Tue, 07 Oct 2014 16:15:43 +0200 |
| parents | 22d89f53e34c |
| children | e6da0705a47c |
comparison
equal
deleted
inserted
replaced
| 48:c6753fb93b3b | 49:5583ddcd6164 |
|---|---|
| 21 # You should have received a copy of the GNU General Public License | 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 | 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. | 23 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 24 -#} | 24 -#} |
| 25 | 25 |
| 26 {% from "macros.j2" import textinput, examples %} | 26 {% from "macros.j2" import textinput, textarea, selectinput, examples %} |
| 27 | 27 |
| 28 {% macro edit_title_type(doctitle, doctype) %} | 28 {% macro edit_title_type(doctitle, doctype) %} |
| 29 {% call textinput("title", "Document Title", "", doctitle, required=True) %} | 29 {% call textinput("title", "Document Title", "", doctitle, required=True) %} |
| 30 <p><strong>Document Title</strong> is a definitive canonical name for the document, providing enough descriptive content to differentiate from other similar documents, ideally providing a unique “handle.” While this field is largely up to the document producer, ICASI has some recommendations:</p> | 30 <p><strong>Document Title</strong> is a definitive canonical name for the document, providing enough descriptive content to differentiate from other similar documents, ideally providing a unique “handle.” While this field is largely up to the document producer, ICASI has some recommendations:</p> |
| 31 <p>The title should be succinct and promptly give the reader an idea of what is to come. If the document producer also publishes a human-friendly document that goes hand-in-hand with a CVRF document, it is recommend that both documents use the same title. It is further recommended to include the manufacturer name with any product names mentioned in the title.</p> | 31 <p>The title should be succinct and promptly give the reader an idea of what is to come. If the document producer also publishes a human-friendly document that goes hand-in-hand with a CVRF document, it is recommend that both documents use the same title. It is further recommended to include the manufacturer name with any product names mentioned in the title.</p> |
| 34 {% call textinput("type", "Document Type", "Security Advisory", doctype, required=True) %} | 34 {% call textinput("type", "Document Type", "Security Advisory", doctype, required=True) %} |
| 35 <p><strong>Document Type</strong> is a short canonical name, chosen by the document producer, which will inform the end user as to the type of document.</p> | 35 <p><strong>Document Type</strong> is a short canonical name, chosen by the document producer, which will inform the end user as to the type of document.</p> |
| 36 {{ examples(['Vulnerability Report', 'Security Bulletin', 'Security Notice']) }} | 36 {{ examples(['Vulnerability Report', 'Security Bulletin', 'Security Notice']) }} |
| 37 {% endcall %} | 37 {% endcall %} |
| 38 {% endmacro %} | 38 {% endmacro %} |
| 39 | |
| 40 {% macro edit_note(types, note, ordinal) %} | |
| 41 <p><strong>Note</strong> is a place to put all manner of text blobs related to the document as a whole. It can be a concise summary of the overall document or a more compartmentalized and area-specific textual discussion. Depending on the need, there can be zero, one, or several <strong>Note</strong> elements in a given CVRF document. | |
| 42 | |
| 43 <p>The note should contain a compartmentalized textual discussion constrained by its <em>Type</em> attribute.</p> | |
| 44 {% call selectinput("type", "Type", types, note and note._type or '') %} | |
| 45 <p><em>Type</em> can be one of the following:</p> | |
| 46 <dl class="dl-horizontal"> | |
| 47 <dt>General:</dt> | |
| 48 <dd>A general, high-level note (<em>Title</em> may have more information).</dd> | |
| 49 <dt>Details:</dt> | |
| 50 <dd>A low-level detailed discussion (<em>Title</em> may have more information).</dd> | |
| 51 <dt>Description:</dt> | |
| 52 <dd>A description of something (<em>Title</em> may have more information).</dd> | |
| 53 <dt>Summary:</dt> | |
| 54 <dd>A summary of something (<em>Title</em> may have more information).</dd> | |
| 55 <dt>FAQ:</dt> | |
| 56 <dd>A list of frequently asked questions.</dd> | |
| 57 <dt>Legal Disclaimer:</dt> | |
| 58 <dd>Any possible legal discussion, including constraints, surrounding the document.</dd> | |
| 59 <dt>Other:</dt> | |
| 60 <dd>Something that doesn’t fit (<em>Title</em> should have more information).</dd> | |
| 61 </dl> | |
| 62 {% endcall %} | |
| 63 {% call textinput("ordinal", "Ordinal", "", ordinal or note._ordinal, type="number", required=True, extras={'min': '1'}) %} | |
| 64 <p><em>Ordinal</em> is a mandatory, locally significant value used to track notes inside a CVRF document at the root (document) level. It is provided to uniquely identify a <strong>Note</strong>.</p> | |
| 65 <p>There should be one of these values for every <strong>Note</strong> inside <strong>Document Notes</strong>, and it is recommended that <em>Ordinal</em> should be instantiated as a monotonically increasing counter, indexed from 1. Each <em>Ordinal</em> that tracks a <strong>Note</strong> inside <strong>Document Notes</strong> is completely independent from an <em>Ordinal</em> tracking a <strong>Note</strong> inside <strong>Vulnerability/Notes</strong>.</p> | |
| 66 {% endcall %} | |
| 67 {% call textinput("title", "Title", "", note and note._title or '') %} | |
| 68 <p><em>Title</em> should be a concise description of what is contained in the text.</p> | |
| 69 {% endcall %} | |
| 70 {% call textinput("audience", "Audience", "", note and note._audience or '') %} | |
| 71 <p><em>Audience</em> will indicate who is intended to read it.</p> | |
| 72 {% endcall %} | |
| 73 {% call textarea("note", "Note", "", note and note._note or '', 10, required=True) %} | |
| 74 <p><strong>Note</strong> is a place to put all manner of text blobs related to the document as a whole. It can be a concise summary of the overall document or a more compartmentalized and area-specific textual discussion.</p> | |
| 75 <p>The note should contain a compartmentalized textual discussion constrained by its <em>Type</em> attribute.</p> | |
| 76 {% endcall %} | |
| 77 {% endmacro %} |