Mercurial > farol > farol
annotate farol/templates/document/edit_note.j2 @ 40:5e6eed63ff07
Replace lists with definition lists in descriptions
| author | Benoît Allard <benoit.allard@greenbone.net> |
|---|---|
| date | Mon, 06 Oct 2014 15:40:14 +0200 |
| parents | debdea976b8a |
| children | 5583ddcd6164 |
| 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" %} | |
| 27 {% from "macros.j2" import textinput, textarea, selectinput %} | |
| 28 {% block title %}Edit the type{% endblock %} | |
| 29 | |
| 30 {% block content %} | |
| 31 <form role="form" method="POST"> | |
| 32 | |
|
38
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
33 {% call selectinput("type", "Type", types, note and note._type or '') %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
34 <p><em>Type</em> can be one of the following:</p> |
|
40
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
35 <dl class="dl-horizontal"> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
36 <dt>General:</dt> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
37 <dd>A general, high-level note (<em>Title</em> may have more information).</dd> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
38 <dt>Details:</dt> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
39 <dd>A low-level detailed discussion (<em>Title</em> may have more information).</dd> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
40 <dt>Description:</dt> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
41 <dd>A description of something (<em>Title</em> may have more information).</dd> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
42 <dt>Summary:</dt> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
43 <dd>A summary of something (<em>Title</em> may have more information).</dd> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
44 <dt>FAQ:</dt> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
45 <dd>A list of frequently asked questions.</dd> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
46 <dt>Legal Disclaimer:</dt> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
47 <dd>Any possible legal discussion, including constraints, surrounding the document.</dd> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
48 <dt>Other:</dt> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
49 <dd>Something that doesn’t fit (<em>Title</em> should have more information).</dd> |
|
5e6eed63ff07
Replace lists with definition lists in descriptions
Benoît Allard <benoit.allard@greenbone.net>
parents:
38
diff
changeset
|
50 </dl> |
|
38
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
51 {% endcall %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
52 {% call textinput("ordinal", "Ordinal", "", ordinal or note._ordinal, type="number", required=True, extras={'min': '1'}) %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
53 <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> |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
54 <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> |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
55 {% endcall %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
56 {% call textinput("title", "Title", "", note and note._title or '') %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
57 <p><em>Title</em> should be a concise description of what is contained in the text.</p> |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
58 {% endcall %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
59 {% call textinput("audience", "Audience", "", note and note._audience or '') %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
60 <p><em>Audience</em> will indicate who is intended to read it.</p> |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
61 {% endcall %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
62 {% call textarea("note", "Note", "", note and note._note or '', 10, required=True) %} |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
63 <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> |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
64 <p>The note should contain a compartmentalized textual discussion constrained by its <em>Type</em> attribute.</p> |
|
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
65 {% endcall %} |
| 0 | 66 |
| 67 <button class="btn btn-primary" type="submit">{{ action or 'Update' }}</button> | |
|
38
debdea976b8a
Add Descriptions for the edit_note fields
Benoît Allard <benoit.allard@greenbone.net>
parents:
10
diff
changeset
|
68 <a class="btn btn-danger" href="{% if action=='Add' %}{{ url_for('.view') }}{% else %}{{ url_for('.view_note', ordinal=note._ordinal) }}{% endif %}">Cancel</a> |
| 0 | 69 </form> |
| 70 {% endblock %} |