Changeset 3396

Timestamp:

May 28, 2007, 3:34:23 PM (16 years ago)

Author:

Nicklas Nordborg

Message:

References #534. Added section about annotating items.

Location:

trunk/doc/src/docbook

Files:

• figures/annotate.png (added)
• userdoc/annotations.xml (modified) (1 diff)

trunk/doc/src/docbook/userdoc/annotations.xml

@@ -518 +518 @@
     </para>
   </sect1>
+  
+  <sect1 id="annotations.annotating">
+    <title>Annotating items</title>
+    
+    <para>
+      Entering annotation values follow the same pattern
+      for all items that can have annotations. They all have 
+      a <guilabel>Annotations &amp; parameters</guilabel> tab
+      in their edit view. On this tab you can specify values
+      for all annotation types assigned to the type of item,
+      and all parameters that are attached to the protocol
+      used to create the item. Some items, for example 
+      <emphasis>biosources</emphasis> and <emphasis>array designs</emphasis> 
+      can't have a protocol. In their case the tab is labelled
+      <guilabel>Annotations</guilabel>.
+    </para>
+    
+    <figure
+      id="annotations.figures.annotate">
+      <title>Annotating a sample</title>
+      <screenshot>
+        <mediaobject>
+          <imageobject>
+            <imagedata
+              fileref="figures/annotate.png" format="PNG" />
+          </imageobject>
+        </mediaobject>
+      </screenshot>
+    </figure>
+
+    <helptext external_id="annotations.edit" 
+      title="Annotations &amp; parameters">
+
+      <para>
+        Click on an entry in the list of annotation types to show a
+        form for entering a value for it to the right. Depending
+        on the options set on the annotation type the form may be a simple 
+        free text field, a list of checkboxes or radiobuttons, or 
+        something else.
+      </para>
+      
+      <para>
+        Annotation types with an <guilabel>X</guilabel> in front
+        of their names already have a value.
+      </para>
+      
+      <para>
+        Annotation types marked with angle brackets are protocol 
+        parameters.
+      </para>
+      
+      <para>
+        Select an option in the <guilabel>Categories</guilabel> list to filter the
+        annotation types based on the categories
+        they belong to. This list contains all available
+        categories, and three special ones:
+        <itemizedlist>
+        <listitem>
+          <para>
+          <guilabel>all</guilabel>: Display all annotatation types
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          <guilabel>protocol parameters</guilabel>: Display only
+          those annotation types that are parameters to the current 
+          protocol.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          <guilabel>uncategorized</guilabel>: Display only annoatation types
+          that hasn't been put into a category.
+          </para>
+        </listitem>
+        </itemizedlist>
+      </para>
+      
+      
+    </helptext>
+    
+    <sect2 id="annotations.inheriting">
+      <title>Inheriting annotations from other items</title>
+    </sect2>
+    
+  </sect1>
 
 </chapter>