source: branches/lib/HELP_SOURCE/source/next_neighbours.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
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.2 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      pt_server.hlp
5
6#       sub topics:
7#SUB     subtopic.hlp
8
9# format described in ../help.readme
10
11
12TITLE           Nearest relatives of SELECTED
13
14OCCURRENCE      ARB_NT/Search/More search/Search Next Relatives of SELECTED Species in PT Server
15
16DESCRIPTION     Scans PT_SERVER database for the nearest relatives
17                of the currently LINK{selected.hlp}.
18
19                See LINK{next_neighbours_common.hlp} for a description of the used algorithm
20                and common parameters.
21
22                See LINK{next_neighbours_listed.hlp} for the description of the parameters
23                    - 'Results'
24                    - 'Min. Score'
25
26                When you press the SEARCH button, the next relatives of the selected species are listed
27                in the Hits-box.
28
29                If you check 'Auto search on change' the search will start everytime the currently
30                selected species or any search-relevant parameter changes.
31
32                Then number of species listed there is limited by the number given in
33                the 'Results' field. Enter 0 to get unlimited output.
34
35                You may also limit the listed relatives by specifying a required minimal score.
36
37                When you press the 'Move to hitlist' button, the species list is transferred to
38                the species search result list, where you're able to apply further actions to the
39                found relatives.
40                  * Depending on the settings of 'Search/Add/Keep species' in the main query-window
41                    the species list is either replaced, added or kept.
42                  * Depending on the setting of 'that match/don't match the query' either the list of
43                    found relatives is applied or the rest of the species.
44
45                When you press the 'Mark hits' button, all species listed in the 'Hits' list will be
46                marked (and all other species will be unmarked).
47
48                If you check 'Auto' behind the 'Mark hits' button this will be done automatically
49                after each search.
50
51NOTES           Try auto-mark together with auto-search!
52
53EXAMPLES        None
54
55WARNINGS        None
56
57BUGS            No bugs known yet
Note: See TracBrowser for help on using the repository browser.