source: trunk/HELP_SOURCE/source/tags.hlp

Last change on this file was 19532, checked in by westram, 3 months ago
  • reintegrates 'help' into 'trunk'
    • tweak arb documentation:
      • automatically link
        • ticket references to arb bug tracker (only affects html version).
        • found URLs.
      • page titles
        • warn about long titles.
        • introduce SUBTITLEs (automatically triggered by multi-line titles in source files).
        • increase allowed length (limited by subwindow width).
      • cleanup header sections in all helpfiles.
      • fix and/or update several help files.
      • document syntax of help sources.
      • build issues:
        • when xml validation fails, next build no longer uses invalid xml ⇒ keeps failing.
        • remove output files on error (including files below ARBHOME/lib).
        • pipe output through logs to ensure proper wrapping in Entering/Leaving lines.
    • moves Tree admin + NDS menu entries to top of menu
  • adds: log:branches/help@18783:19531
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 1.5 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6#SUB     subtopic.hlp
7
8# format described in ../help.readme
9
10
11TITLE           TAGS: Subfields
12
13OCCURRENCE      ARB_NT/Search/More functions/Modify Fields of Listed Species
14                ARB_MERGE/Transfer species .../Source->Target/Merge tagged fields
15
16DESCRIPTION     Tags are used to subdivide fields into subfields, which
17                often have the same value. E.g. after merging the 16s databases
18                from RDP and DeWachter all species have two full_names:
19                The RDP and DeWachter version which should be equal but which
20                are often not. So we 'TAG' the dewachter database using the
21                tag 'DEW' and the RDP with the tag 'RDP'. Say one species has
22                the full_names "escherichia_RDP" and "escherichia_DEW".
23                Using the tags mechanism the final field will look like this:
24
25                        ' [DEW] escherichia_DEW [RDP] escherichia_RDP'
26
27                Tags are sourrounded by brackets and put in front of the
28                corresponding field value. If both subfields have the same
29                value (e.g. "escherichia_coli") fields get merged:
30
31                        ' [DEW,RDP] escherichia_coli'
32
33NOTES           Operating on tags from LINK{mod_field_list.hlp} allows to modify single
34                subfields only (i.e. not touch other subfields).
35                If there are no tags used yet, the default tag will be added.
36
37                Using LINK{mergetaggedfield.hlp} always operates on all found tags.
38                If source- or target-field does not contain tags, the specified
39                source- or target-tag will be added.
40
41EXAMPLES        None
42
43BUGS            Square Brackets in the fields get replaced by '{}'
Note: See TracBrowser for help on using the repository browser.