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

{% from "macros.j2" import textinput, textarea, selectinput, examples %}

{% macro edit_title_type(doctitle, doctype) %}
{% call textinput("title", "Document Title", "", doctitle, required=True) %}
<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>
<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>
{{ examples(['Cisco IPv6 Crafted Packet Vulnerability', 'CERT Vulnerabilities in Kerberos 5 Implementation', 'Cisco Content Services Switch 11000 Series DNS Negative Cache of Information Denial-of-Service Vulnerability', 'Symantec Brightmail AntiSpam Static Database Password', 'HPSBUX02697 SSRT100591 rev.1 - HP-UX Running Java, Remote Unauthorized Access, Disclosure of Information, and Other Vulnerabilities', 'Microsoft Vulnerability in the Microsoft Data Access Components (MDAC) Function Could Allow Code Execution', 'Microsoft Vulnerability in Windows Explorer Could Allow Remote Code Execution' ]) }}
{% endcall %}
{% call textinput("type", "Document Type", "Security Advisory", doctype, required=True) %}
<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>
{{ examples(['Vulnerability Report', 'Security Bulletin', 'Security Notice']) }}
{% endcall %}
{% endmacro %}

{% macro edit_note(types, note, ordinal) %}
<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.

<p>The note should contain a compartmentalized textual discussion constrained by its <em>Type</em> attribute.</p>
{% call selectinput("type", "Type", types, note and note._type or '') %}
<p><em>Type</em> can be one of the following:</p>
<dl class="dl-horizontal">
  <dt>General:</dt>
  <dd>A general, high-level note (<em>Title</em> may have more information).</dd>
  <dt>Details:</dt>
  <dd>A low-level detailed discussion (<em>Title</em> may have more information).</dd>
  <dt>Description:</dt>
  <dd>A description of something (<em>Title</em> may have more information).</dd>
  <dt>Summary:</dt>
  <dd>A summary of something (<em>Title</em> may have more information).</dd>
  <dt>FAQ:</dt>
  <dd>A list of frequently asked questions.</dd>
  <dt>Legal Disclaimer:</dt>
  <dd>Any possible legal discussion, including constraints, surrounding the document.</dd>
  <dt>Other:</dt>
  <dd>Something that doesn’t fit (<em>Title</em> should have more information).</dd>
</dl>
{% endcall %}
{% call textinput("ordinal", "Ordinal", "", ordinal or note._ordinal, type="number", required=True, extras={'min': '1'}) %}
<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>
<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>
{% endcall %}
{% call textinput("title", "Title", "", note and note._title or '') %}
<p><em>Title</em> should be a concise description of what is contained in the text.</p>
{% endcall %}
{% call textinput("audience", "Audience", "", note and note._audience or '') %}
<p><em>Audience</em> will indicate who is intended to read it.</p>
{% endcall %}
{% call textarea("note", "Note", "", note and note._note or '', 10, required=True) %}
<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>
<p>The note should contain a compartmentalized textual discussion constrained by its <em>Type</em> attribute.</p>
{% endcall %}
{% endmacro %}