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

Last change on this file was 19575, checked in by westram, 3 weeks ago
  • reintegrates 'help' into 'trunk'
    • preformatted text gets checked for width now (to enforce it fits into the arb help window).
    • fixed help following these checks, using the following steps:
      • ignore problems in foreign documentation.
      • increase default help window width.
      • introduce control comments to
        • accept oversized preformatted sections.
        • enforce preformatted style for whole sections.
        • simply define single-line preformatted sections
          Used intensive for definition of internal script languages.
    • fixed several non-related problems found in documentation.
    • minor layout changes for HTML version of arb help (more compacted; highlight anchored/all sections).
    • refactor system interface (GUI version) and use it from help module.
  • adds: log:branches/help@19532:19574
File size: 3.4 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      group_search.hlp
5
6#       sub topics:
7SUB     aci.hlp
8SUB     srt.hlp
9SUB     reg.hlp
10
11# format described in ../help.readme
12
13
14TITLE           Rename taxonomic groups
15
16OCCURRENCE      ARB_NT/Tree/Search groups/Rename...
17
18DESCRIPTION     Allows to rename
19                 * the currently selected group or
20                 * all listed groups in one go.
21
22                The input field at 'Selected group name' shows the
23                name of the currently selected group.
24
25                  If you modify that field, the group will be renamed.
26
27                The input field at 'Modify using ACI/SRT' allows scripted
28                modification of group names:
29
30                  * for the currently selected group, the result (of
31                    applying that script to the groups name) will
32                    always be displayed behind 'Resulting group name'
33                    (if an error occurs, it will show there as well).
34
35                  * if you are satisfied with the result,
36                    press 'Apply to selected group' to actually change the
37                    groups name.
38
39                  * pressing 'Apply to all listed groups' will perform
40                    a batch rename for all listed groups.
41
42NOTES           None
43
44EXAMPLES        Example ACI/SRT expressions:
45
46                   Tag/untag groups by adding/removing prefixes:
47
48# PREFORMATTED WIDTH 120
49                        "[TAG] ";dd              will prefix the group-name with "[TAG] " (using LINK{aci.hlp})
50                        :[TAG]=                  will remove that prefix again            (using LINK{srt.hlp})
51                        /^\[TAG\]//              dito                                     (using LINK{reg.hlp})
52                        /\[.*\]//                remove multiple tag-prefixes
53# PREFORMATTED RESET
54
55SECTION         Special ACI-commands (only valid in group rename!)
56
57                        hitidx
58
59                                returns the index of the current group (as listed in group-search hitlist).
60                                The index runs from 1 to N (with N=number of hits).
61
62                        hitcount
63
64                                returns the overall number of hits (as listed in hitlist).
65
66                        dupidx
67
68                                returns the index of the current group (inside the cluster of all listed
69                                duplicates of the current group).
70                                The index runs from 1 to N (with N=number of duplicates of the current group).
71                                The order of the indices is affected by the sort order of the hit list.
72
73                                Hint: the cluster numbers are displayed when you sort the results 'by cluster'.
74
75                        groupsize
76
77                                returns the size of the group.
78
79                        markedingroup
80
81                                returns the number of marked species in the group.
82
83                        nesting
84
85                                returns the nesting level of the group (=number of parent groups).
86
87                        aid
88
89                                returns the AID (=average ingroup distance) of the group
90                                (see LINK{group_search.hlp} for details).
91
92
93WARNINGS        None
94
95BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.