Changeset 6725

Timestamp:

Feb 12, 2015, 2:11:06 PM (9 years ago)

Author:

Nicklas Nordborg

Message:

References #1908: Batch inheriting multiple annotations

Added section about this feature to the documentation.

Location:

trunk/doc/src/docbook

Files:

• figures/batch_inherit_annotations.png (added)
• user/annotations.xml (modified) (1 diff)

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

@@ -756 +756 @@
           <other external_id="annotations.edit">Annotations and parameters</other>
           <other external_id="experiment.edit.factors">Experimental factors</other>
+          <other external_id="annotations.batch_inherit">Batch inherit annotations</other>
           <other external_id="item.overview">Item overview tool</other>
         </seeother>
       
       </helptext>     
+      
+    </sect2>
+    
+    <sect2 id="annotations.batch-inherit">
+      <title>Batch inherit annotations</title>
+      
+      <helptext external_id="annotations.batch_inherit" 
+        title="Batch inherit annotations">
+        <para>
+          Manually inheriting annotations on a per-item basis will quickly become a time-consuming
+          and boring task as the project gets larger. Typically, there is a given set of annotations
+          that should be inherited from different levels in the parent chain. This is possible
+          with the batch inherit feature. Open this dialog by selecting at least one item in the
+          list-view and then use the <guibutton>Inherit annotations&hellip;</guibutton> button
+          in the toolbar.
+        </para>
+        
+        <nohelp>
+        <figure
+          id="annotations.figures.batch_inherit">
+          <title>Batch inherit annotations</title>
+          <screenshot>
+            <mediaobject>
+              <imageobject>
+                <imagedata
+                  fileref="figures/batch_inherit_annotations.png" format="PNG" />
+              </imageobject>
+            </mediaobject>
+          </screenshot>
+        </figure>
+        </nohelp>
+        
+        
+        <variablelist>
+        <varlistentry>
+          <term><guilabel>Select annotation types</guilabel></term>
+          <listitem>
+            <para>
+              Use this button to select one or more annotation types that you want to inherit.
+              Once the selection has been made, the selected annotation types will be added to
+              the table in the dialog as shown on the screen shot.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><guilabel>Action</guilabel></term>
+          <listitem>
+            <para>
+              For each annotation type you can select if you want to
+              <guilabel>inherit</guilabel> new annotations or <guilabel>remove</guilabel>
+              existing inherited annotations. It is possible to use different
+              actions for different annotation types.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><guilabel>Parent item type</guilabel></term>
+          <listitem>
+            <para>
+              In this list you can select if you want to inherit from
+              any type of parent or only from a specific type. This is
+              useful if the same annotation is present on multiple parent
+              levels. If the annotation type has been added to a category,
+              BASE will automatically try to guess the parent type (=the 
+              parent type that has the same name as the category). This
+              option is disabled when removing annotations.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><guilabel>Options</guilabel></term>
+          <listitem>
+            <para>
+              You may specify if existing inherited annotations should be
+              replaced and if duplicate inheritance should be allowed or not.
+              The default is to replace existing annotations and not allow
+              duplicates. 
+            </para>
+          </listitem>
+        </varlistentry>
+        </variablelist>
+        
+        <para>
+          Click on <guibutton>Ok</guibutton> to finish. The work is performed as a background job
+          on the server. The progress can be followed in the dialog. It may take a while to
+          complete if several items was selected since BASE will need to look up all parents
+          and determine if they have any annotations that match the critera that was set up.
+        </para>
+      </helptext>
       
     </sect2>