Changeset 3396


Ignore:
Timestamp:
May 28, 2007, 3:34:23 PM (14 years ago)
Author:
Nicklas Nordborg
Message:

References #534. Added section about annotating items.

Location:
trunk/doc/src/docbook
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/userdoc/annotations.xml

    r3395 r3396  
    518518    </para>
    519519  </sect1>
     520 
     521  <sect1 id="annotations.annotating">
     522    <title>Annotating items</title>
     523   
     524    <para>
     525      Entering annotation values follow the same pattern
     526      for all items that can have annotations. They all have
     527      a <guilabel>Annotations &amp; parameters</guilabel> tab
     528      in their edit view. On this tab you can specify values
     529      for all annotation types assigned to the type of item,
     530      and all parameters that are attached to the protocol
     531      used to create the item. Some items, for example
     532      <emphasis>biosources</emphasis> and <emphasis>array designs</emphasis>
     533      can't have a protocol. In their case the tab is labelled
     534      <guilabel>Annotations</guilabel>.
     535    </para>
     536   
     537    <figure
     538      id="annotations.figures.annotate">
     539      <title>Annotating a sample</title>
     540      <screenshot>
     541        <mediaobject>
     542          <imageobject>
     543            <imagedata
     544              fileref="figures/annotate.png" format="PNG" />
     545          </imageobject>
     546        </mediaobject>
     547      </screenshot>
     548    </figure>
     549
     550    <helptext external_id="annotations.edit"
     551      title="Annotations &amp; parameters">
     552
     553      <para>
     554        Click on an entry in the list of annotation types to show a
     555        form for entering a value for it to the right. Depending
     556        on the options set on the annotation type the form may be a simple
     557        free text field, a list of checkboxes or radiobuttons, or
     558        something else.
     559      </para>
     560     
     561      <para>
     562        Annotation types with an <guilabel>X</guilabel> in front
     563        of their names already have a value.
     564      </para>
     565     
     566      <para>
     567        Annotation types marked with angle brackets are protocol
     568        parameters.
     569      </para>
     570     
     571      <para>
     572        Select an option in the <guilabel>Categories</guilabel> list to filter the
     573        annotation types based on the categories
     574        they belong to. This list contains all available
     575        categories, and three special ones:
     576        <itemizedlist>
     577        <listitem>
     578          <para>
     579          <guilabel>all</guilabel>: Display all annotatation types
     580          </para>
     581        </listitem>
     582        <listitem>
     583          <para>
     584          <guilabel>protocol parameters</guilabel>: Display only
     585          those annotation types that are parameters to the current
     586          protocol.
     587          </para>
     588        </listitem>
     589        <listitem>
     590          <para>
     591          <guilabel>uncategorized</guilabel>: Display only annoatation types
     592          that hasn't been put into a category.
     593          </para>
     594        </listitem>
     595        </itemizedlist>
     596      </para>
     597     
     598     
     599    </helptext>
     600   
     601    <sect2 id="annotations.inheriting">
     602      <title>Inheriting annotations from other items</title>
     603    </sect2>
     604   
     605  </sect1>
    520606
    521607</chapter>
Note: See TracChangeset for help on using the changeset viewer.