Ignore:
Timestamp:
May 29, 2007, 8:47:04 AM (14 years ago)
Author:
Nicklas Nordborg
Message:

Fixes #534.

File:
1 edited

Legend:

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

    r3396 r3400  
    3434    <title>Annotation Types</title>
    3535
    36     <helptext id="annotationtype.view.properties"
     36    <helptext external_id="annotationtype.view.properties"
    3737      title="Annotation types">
    3838    <para>
     
    565565     
    566566      <para>
    567         Annotation types marked with angle brackets are protocol
    568         parameters.
     567        Annotation types marked with angle brackets
     568        <nohelp>
     569        (<inlinemediaobject>
     570          <imageobject><imagedata fileref="figures/parameter.gif" format="GIF"
     571          /></imageobject>
     572        </inlinemediaobject>)</nohelp>
     573        are protocol parameters.
    569574      </para>
    570575     
     
    589594        <listitem>
    590595          <para>
    591           <guilabel>uncategorized</guilabel>: Display only annoatation types
     596          <guilabel>uncategorized</guilabel>: Display only annotation types
    592597          that hasn't been put into a category.
    593598          </para>
     
    596601      </para>
    597602     
     603      <seeother>
     604        <other external_id="annotations.edit.inherited">Inherit annotations</other>
     605      </seeother>
    598606     
    599607    </helptext>
     
    601609    <sect2 id="annotations.inheriting">
    602610      <title>Inheriting annotations from other items</title>
     611     
     612      <helptext external_id="annotations.edit.inherited"
     613        title="Inherit annotations">
     614        <para>
     615          An item may inherit annotations from any of it's parent items.
     616          E.g. an extract can inherit annotations from the sample or biosource
     617          it was created from. This is an important feature to make the
     618          experimental factors work. Annotations that should be used as
     619          experimental factors must be inherited to the raw bioassay level.
     620          <nohelp>See <xref linkend="experiments_analysis.experiment.factors" /> for more
     621          information about experimental factors.</nohelp>
     622        </para>
     623       
     624        <nohelp>
     625        <figure
     626          id="annotations.figures.inherit">
     627          <title>Inheriting annotations from a parent item</title>
     628          <screenshot>
     629            <mediaobject>
     630              <imageobject>
     631                <imagedata
     632                  fileref="figures/inherit_annotations.png" format="PNG" />
     633              </imageobject>
     634            </mediaobject>
     635          </screenshot>
     636        </figure>
     637        </nohelp>
     638   
     639        <para>
     640          On this screen is a tree-like structure in two levels. The first level
     641          lists all parent items which has at least one annotations. The second
     642          level lists the annotations and protocol parameters for the item.
     643          Selecting an item in the first level will inherit all annotations
     644          from that item, including those that you maybe add later.
     645          Selecting an annotation or protocol parameter at the second level
     646          will inherit only the selected one.
     647        </para>
     648       
     649        <note>
     650          <itemizedlist>
     651          <listitem>
     652            <para>
     653            The inheritance is implemented by reference. This means that if
     654            you change the value of an annotation the new value is automatically
     655            picked up by those inheriting it.
     656            </para>
     657          </listitem>
     658          <listitem>
     659            <para>
     660            You can't inherit annotations from an item which doesn't have
     661            annotations.
     662            </para>
     663          </listitem>
     664          <listitem>
     665            <para>
     666            If you delete an annotation from a parent item, the inheritance will
     667            be lost, even if you later add a value again.
     668            </para>
     669          </listitem>
     670          </itemizedlist>
     671        </note>
     672       
     673        <warning>
     674          <para>
     675          If you rearrange links to parent items after you have
     676          specified inheritance, it may happen that you are inheriting
     677          annotation from non-parent items. This will be flagged with a warning
     678          icon in the list, and must be fixed manually. The experiment validation
     679          tool is an excellent help for locating this kind of problems.
     680          <nohelp>See <xref linkend="experiments_analysis.experiment.overview" />.</nohelp>
     681          </para>
     682        </warning>
     683   
     684        <seeother>
     685          <other external_id="annotations.edit">Annotations and parameters</other>
     686          <other external_id="experiment.edit.factors">Experimental factors</other>
     687          <other external_id="experiment.overview">Experiment validation tool</other>
     688        </seeother>
     689     
     690      </helptext>     
     691     
    603692    </sect2>
    604693   
Note: See TracChangeset for help on using the changeset viewer.