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

#       sub topics:
SUB     e4.hlp
SUB     mark.hlp

# format described in ../help.readme


TITLE		Species selections admin

OCCURRENCE      ARB/Species/Selections
                ARB/<number marked button>
                ARB_MERGE/Transfer selections/Edit selection
                ARB_MERGE/Transfer species/<number marked buttons>

DESCRIPTION     Species selections basically are sets of species.

                Technically the terms "species selections" and "editor configurations"
                (or simply "configurations") are synonymic. For a detailed description
                what is stored in an editor configuration see LINK{species_configs_saveload.hlp}.

                You may use species selections to

                    * save/restore which species are currently marked (see LINK{mark.hlp}).
                      Available operations are decribed below.
                    * start the sequence editor on a defined set of species (see LINK{arb_edit4.hlp})
                    * highlight multiple species selections in the tree display
                      using the 'Highlight in tree' button (see LINK{species_configs_highlight.hlp}).
                      Note: this button is not available when called from mergetool.

                This window provides several operations on species selections:

                        - STORE (save a (new) species selection)
                        - EXTRACT (= unmark all, then mark the species stored in the selected species selection)
                        - MARK/UNMARK/INVERT (mix currently marked species with those marked in the selected species selection)
                        - COMBINE (unmarks all that are not in the selected species selection. This generates an intersection
                          between the currently marked species and those from the selected species selection)
                        - DELETE (delete a species selection)
                        - RENAME (rename a species selection)

                Each species selection has a comment which may be changed by
                editing the 'Comment' textfield. The 'Clear' button will remove
                the comment in two steps:
                  * first all dated log entries (1st click)
                  * then the rest of the comment (2nd click)

NOTES           The species selection window is also available via the buttons, that show the number
                of marked species, located in the top area of the main arb window
                and in the LINK{mg_species.hlp} window (<number marked button>).

                The number behind the species selections in the list informs about the
                number of species stored in each selection.

                To test whether a selection contains the currently marked set of species,
                first check whether the number of marked species (displayed on the button in the
                main window) equals the number behind the selection in the list.

                If so, use the INVERT button and check the number of marked species again:
                * if there was a warning about unknown species, the selection differs,
                * if there are no marked species (=button is empty), the selection is equal,
                * otherwise it differs.

                In any case click INVERT again to restore the previously marked set of species.

EXAMPLES	    None

WARNINGS        Unfortunately we use the term 'configuration' for two things:
                  * configurations of settings/properties (as described in LINK{prop_configs.hlp})
                  * species-selections aka editor-configurations (as described here)

                Please do not mix them up.

                Also note that "Species selections" have nothing todo with the LINK{selected.hlp}.

BUGS		    No bugs known

