# HG changeset patch
# User Benoît Allard <benoit.allard@greenbone.net>
# Date 1412686021 -7200
# Node ID 309330b215d300f9eb32595111157155b568e50f
# Parent  086e35c4aee70cec26b943727da13ae317d173d3
Add description fields to edit_group and edit_relationship

diff -r 086e35c4aee7 -r 309330b215d3 farol/templates/producttree/edit_group.j2
--- a/farol/templates/producttree/edit_group.j2	Tue Oct 07 14:07:57 2014 +0200
+++ b/farol/templates/producttree/edit_group.j2	Tue Oct 07 14:47:01 2014 +0200
@@ -24,14 +24,25 @@
 -#}
 
 {% extends "base.j2" %}
-{% from "macros.j2" import textinput, textarea, selectinput2 %}
+{% from "macros.j2" import textinput, selectinput2, examples %}
 {% block title %}Edit the product{% endblock %}
 
 {% block content %}
+<p>If groups are defined, products can be referred to using the Group ID attribute in many other parts of the document, rather than repeatedly having to list all members individually.</p>
+<p>Whether groups are defined or not, the ability to reference each product individually in other parts of the document is not affected. In fact, the creator of a document can choose to use either direct product references or group references.</p>
+<p><strong>Note:</strong></p>
+<p>Given that a single product can be a member of more than one group, some areas of the CVRF document may not allow product references by group to avoid ambiguity.</p>
+<p>Each <strong>Group</strong> container defines a new logical group of products that can then be referred to in other parts of the document to address a group of products with a single identifier. <strong>Group</strong> members are defined by adding one <strong>Product ID</strong> element for each member of the group.</p>
 <form role="form" method="POST">
 
-{{ textinput('groupid', "Group ID", value=groupid, required=True) }}
-{{ textarea('description', "Description", '', description, 3) }}
+{% call textinput('groupid', "Group ID", value=groupid, required=True) %}
+<p>The <em>Group ID</em> attribute is required to identify a <strong>Group</strong> so that it can be referred to from other parts in the document. There is no predefined or required format for the <em>Group ID</em> as long as it uniquely identifies a group in the context of the current document. Examples include incremental integers or GUIDs.</p>
+{{ examples(['CVRFGID-0001', 'GRP-0001']) }}
+{% endcall %}
+{% call textinput('description', "Description", '', description) %}
+<p><strong>Description</strong> is a short, optional description of the group.</p>
+{{ examples(['The x64 versions of the operating system.']) }}
+{% endcall %}
 {{ selectinput2('products', "Products", products, productids, multiple=True) }}
 
 <button class="btn btn-primary" type="submit">{{ action or 'Update' }}</button>
diff -r 086e35c4aee7 -r 309330b215d3 farol/templates/producttree/edit_relationship.j2
--- a/farol/templates/producttree/edit_relationship.j2	Tue Oct 07 14:07:57 2014 +0200
+++ b/farol/templates/producttree/edit_relationship.j2	Tue Oct 07 14:47:01 2014 +0200
@@ -28,10 +28,22 @@
 {% block title %}Edit the product{% endblock %}
 
 {% block content %}
+<p>The <strong>Relationship</strong element establishes a link between two existing <strong>Full Product Name</strong> elements, allowing the document producer to define a combination of two products that form a new <strong>Full Product Name</strong> entry.</p>
+<p>This situation arises when a product is vulnerable only when installed together with another, or to describe operating system components. As a <strong>Relationship</strong> connects two existing products with each other, there need to be at least two <strong>Full Product Name</strong> entries present in the <strong>Product Tree</strong> before a Relationship element can be created.</p>
+<p><strong>Relationship</strong> elements live at the root of a <strong>Product Tree</strong>, and they have three mandatory attributes: Product Reference and Relates To Product Reference each contain the Product ID token for the two products that will form the relationship, and the Type attribute defines how the products are related.</p>
 <form role="form" method="POST">
 
 {{ selectinput2('productreference', "ProductReference", products, productreference) }}
-{{ selectinput('relationtype', "Relation Type", types, relationtype) }}
+{% call selectinput('relationtype', "Relation Type", types, relationtype) %}
+<p>Consider two previously constructed products with <em>Product IDs</em> CVRFPID-0001 and CVRFPID-0002. CVRF v1.1 supports the following <strong>Relationship</strong> <em>Type</em> values:</p>
+<dl class="dl-horizontal">
+  <dt>default component of:</dt><dd>CVRFPID-0001 is a default component of CVRFPID-0002</dd>
+  <dt>optional component of:</dt><dd>CVRFPID-0001 is an optional component of CVRFPID-0002</dd>
+  <dt>external component of:</dt><dd>CVRFPID-0001 is an external component of CVRFPID-0002</dd>
+  <dt>installed on:</dt><dd>CVRFPID-0001 is installed on CVRFPID-0002</dd>
+  <dt>installed with:</dt><dd>CVRFPID-0001 is installed with CVRFPID-0002</dd>
+</dl>
+{% endcall %}
 {{ selectinput2('relatestoproductreference', "Relates to Product Reference", products, relatestoproductreference) }}
 
 <button class="btn btn-primary" type="submit">{{ action or 'Update' }}</button>