source: branches/lib/HELP_SOURCE/source/mergetaggedfield.hlp

Last change on this file was 19532, checked in by westram, 4 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
File size: 2.2 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           Merge tagged fields
12
13OCCURRENCE      ARB_MERGE/Transfer species .../Source->Target/Merge tagged field
14
15DESCRIPTION     Allows to merge the contents of two fields: one from source database, the
16                other from target database.
17
18                This function will only operate on those species listed in
19                the hitlist of the source database.
20
21                The field contents will be tagged (with the specified Source- and Targettag).
22                If you use e.g. 'DB1' and 'DB2' as tags the merged result will look like:
23
24                  Sourcefield   source-content
25                  Targetfield   target-content
26                  Result        [DB1] source-content [DB2] target-content
27
28                If both fields have the same content, it will be merges like:
29
30                  Sourcefield   content
31                  Targetfield   content
32                  Result        [DB1,DB2] content
33
34                The result will be written into the selected target database field.
35
36                You may also specify a tag (mask) to be deleted.
37
38NOTES           This feature works as well when merging several databases (more than two).
39                If the target field already contains tags, they will be preserved
40                and the new sourcetag will be added like:
41
42                  Sourcefield   third-content
43                  Targetfield   [DB1] source-content [DB2] target-content
44                  Result        [DB1] source-content [DB2] target-content [DB3] third-content
45
46                  Sourcefield   third-content
47                  Targetfield   [DB1,DB2] content
48                  Result        [DB1,DB2] content [DB3] third-content
49
50                  Sourcefield   content
51                  Targetfield   [DB1] content [DB2] other-content
52                  Result        [DB1,DB3] content [DB2] other-content
53
54                Tags should start with an alpha character and should at least be 2 characters long.
55
56                See also LINK{tags.hlp}.
57
58EXAMPLES        None
59
60WARNINGS        None
61
62BUGS            No bugs known
63
Note: See TracBrowser for help on using the repository browser.