#       main topics:
UP      arb.hlp
UP      glossary.hlp
UP      group_search.hlp

#       sub topics:
SUB     aci.hlp
SUB     srt.hlp
SUB     reg.hlp

# format described in ../help.readme


TITLE           Rename taxonomic groups

OCCURRENCE      ARB/Tree/Search groups/Rename...

DESCRIPTION     Allows to rename
                 * the currently selected group or
                 * all listed groups in one go.

                The input field at 'Selected group name' shows the
                name of the currently selected group.

                  If you modify that field, the group will be renamed.

                The input field at 'Modify using ACI/SRT' allows scripted
                modification of group names:

                  * for the currently selected group, the result (of
                    applying that script to the groups name) will
                    always be displayed behind 'Resulting group name'
                    (if an error occurs, it will show there as well).

                  * if you are satisfied with the result,
                    press 'Apply to selected group' to actually change the
                    groups name.

                  * pressing 'Apply to all listed groups' will perform
                    a batch rename for all listed groups.

NOTES           None

EXAMPLES        Example ACI/SRT expressions:

                   Tag/untag groups by adding/removing prefixes:

# PREFORMATTED WIDTH 120
                        "[TAG] ";dd              will prefix the group-name with "[TAG] " (using LINK{aci.hlp})
                        :[TAG]=                  will remove that prefix again            (using LINK{srt.hlp})
                        /^\[TAG\]//              dito                                     (using LINK{reg.hlp})
                        /\[.*\]//                remove multiple tag-prefixes
# PREFORMATTED RESET

SECTION         Special ACI-commands (only valid in group rename!)

                        hitidx

                                returns the index of the current group (as listed in group-search hitlist).
                                The index runs from 1 to N (with N=number of hits).

                        hitcount

                                returns the overall number of hits (as listed in hitlist).

                        dupidx

                                returns the index of the current group (inside the cluster of all listed
                                duplicates of the current group).
                                The index runs from 1 to N (with N=number of duplicates of the current group).
                                The order of the indices is affected by the sort order of the hit list.

                                Hint: the cluster numbers are displayed when you sort the results 'by cluster'.

                        groupsize

                                returns the size of the group.

                        markedingroup

                                returns the number of marked species in the group.

                        nesting

                                returns the nesting level of the group (=number of parent groups).

                        aid

                                returns the AID (=average ingroup distance) of the group
                                (see LINK{group_search.hlp} for details).


WARNINGS        None

BUGS            No bugs known
