source: trunk/HELP_SOURCE/source/next_neighbours_listed.hlp

Last change on this file was 19532, checked in by westram, 5 weeks 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
File size: 1.9 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6#SUB     subtopic.hlp
7
8# format described in ../help.readme
9
10
11TITLE           Nearest relatives of LISTED
12
13OCCURRENCE      ARB_NT/Search/More search/Search Next Relatives of LISTED Species in PT Server
14
15DESCRIPTION     Scans PT_SERVER database for the nearest relatives
16                of the species currently listed in search window and writes
17                them into a field of each of those species.
18
19                See LINK{next_neighbours_common.hlp} for a description of the used algorithm
20                and common parameters.
21
22SECTION         SPECIFIC PARAMETERS
23
24                Results
25
26                        Maximum number of relatives written into the DB field.
27                        Use 0 (or empty field) for unlimited number of relatives.
28
29                Min. Score
30
31                        Sets a lower limit for the relative or absolute score. Relatives
32                        with lower score are NOT written into the DB field.
33
34                Add score?
35
36                        Whether to add score information to the DB field or not.
37
38                Result field
39
40                        Specifies the field into which the information about found relatives
41                        is written.
42
43
44NOTES           You may use the generated database entries to mark species (see LINK{markbyref.hlp}).
45
46EXAMPLES        None
47
48WARNINGS        Storing IDs in a field will not survive complete ID renames (e.g. if nameserver changes).
49
50                If the results are stored without score, you may use the following ACI expressions
51                with LINK{mod_field_list.hlp} to convert the IDs into accession numbers
52
53                     | split(";") | findspec("readdb(acc)") | merge(";")
54
55                and vice versa:
56
57                     | split(";") | findacc("readdb(name)") | merge(";")
58
59BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.