source: trunk/HELP_SOURCE/source/group_rename.hlp

Last change on this file was 19499, checked in by westram, 8 weeks ago
  • implements #863
    • add new ACI command "dupidx" (active in group search).
    • update group-enumeration presets: use '~' instead of '_'. use new ACI command 'dupidx'.
File size: 3.5 KB
Line 
1#Please insert up references in the next lines (line starts with keyword UP)
2UP      arb.hlp
3UP      glossary.hlp
4UP      group_search.hlp
5
6#Please insert subtopic references  (line starts with keyword SUB)
7SUB    aci.hlp
8SUB    srt.hlp
9SUB    reg.hlp
10
11# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
12
13#************* Title of helpfile !! and start of real helpfile ********
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                        "[TAG] ";dd              will prefix the group-name with "[TAG] " (using LINK{aci.hlp})
49                        :[TAG]=                  will remove that prefix again            (using LINK{srt.hlp})
50                        /^\[TAG\]//              dito                                     (using LINK{reg.hlp})
51                        /\[.*\]//                remove multiple tag-prefixes
52
53SECTION         Special ACI-commands (only valid in group rename!)
54
55                        hitidx
56
57                                returns the index of the current group (as listed in group-search hitlist).
58                                The index runs from 1 to N (with N=number of hits).
59
60                        hitcount
61
62                                returns the overall number of hits (as listed in hitlist).
63
64                        dupidx
65
66                                returns the index of the current group (inside the cluster of all listed
67                                duplicates of the current group).
68                                The index runs from 1 to N (with N=number of duplicates of the current group).
69                                The order of the indices is affected by the sort order of the hit list.
70
71                                Hint: the cluster numbers are displayed when you sort the results 'by cluster'.
72
73                        groupsize
74
75                                returns the size of the group.
76
77                        markedingroup
78
79                                returns the number of marked species in the group.
80
81                        nesting
82
83                                returns the nesting level of the group (=number of parent groups).
84
85                        aid
86
87                                returns the AID (=average ingroup distance) of the group
88                                (see LINK{group_search.hlp} for details).
89
90
91WARNINGS        None
92
93BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.