source: branches/lib/HELP_SOURCE/source/sp_sort_fld.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: 1.2 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6#SUB     subtopic.hlp
7SUB     sp_sort_phyl.hlp
8
9# format described in ../help.readme
10
11
12TITLE           Sort Species According Database Entries
13
14OCCURRENCE      ARB_NT/Species/Sort Species/According to Database Entries
15
16DESCRIPTION     Arranges the species entries according to species associated
17                field entries. Up to three fields can be specified in a
18                hierarchical order (1st sort key = dominant sort criterion, ...).
19
20                The arrangement is done in the alphabetical
21                or numerical order of the field entries (see WARNINGS below).
22
23                Check 'Reverse' below a field selection box to reverse the sort
24                criterion (i.e. sort from big to small).
25
26                Missing fields are ALWAYS sorted behind existing fields, then they'll be
27                sorted by the next sort criterion.
28
29NOTES           None
30
31EXAMPLES        None
32
33WARNINGS        To sort entries in numerical order make sure that the field is
34                a numerical field (see LINK{spaf_convert.hlp}).
35
36                Example for which sorting a non-numerical field might lead to
37                unexpected results:
38
39                   numerical field:    981  <  1277
40                   string field       "981" > "1277"
41
42BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.