source: branches/lib/HELP_SOURCE/source/resorttree.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.4 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           Sort Tree Topology
12
13OCCURRENCE      ARB_NT/Tree/Beautify tree/...
14
15                ARB_PARSIMONY/Tree/Beautify tree
16
17DESCRIPTION     Arranges branches and groups according to the size of each
18                subtree. If the size doesn't differ at a furcation, subtrees
19                will be sorted alphabethically. This ensures the sorting is stable.
20
21                Sorting does not change the tree topology, it only swaps branches!
22               
23SECTION         Available sort modes
24
25                The first sort mode sorts the bigger branches to the top,
26                the third sorts them to the bottom.
27
28                The second sort mode sorts the bigger branches to the edges of the
29                tree and the smaller branches to the center.
30
31                The fourth and fifth mode are designed to sort the tree for
32                the radial tree display mode.
33
34                The fourth mode does the opposite of the second mode: it sorts
35                bigger branches to the center and smaller ones to the borders
36                of the tree.
37
38                The fifth mode alternates between second and fourth mode.
39
40NOTES           This facilitates the comparison of tree topologies resulting
41                from different treeing approaches.
42
43                See also LINK{resortbyother.hlp}.
44
45                In ARB_PARSIMONY you cannot select the beautification method: it will
46                always sort bigger branches to top. This will also happen automatically
47                after LINK{pa_optimizer.hlp}.
48
49EXAMPLES        None
50
51WARNINGS        None
52
53BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.