source: branches/lib/HELP_SOURCE/source/resortbyother.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
File size: 1.3 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 by other tree
12
13OCCURRENCE      ARB_NT/Tree/Beautify tree/By other tree
14
15DESCRIPTION     Works similar to LINK{resorttree.hlp}, but here branches are rearranged
16                according to the mean position of their leafs in another given tree.
17
18                Select the tree you want to use as reference for ordering,
19                then click 'Sort according to source tree' to apply the order to
20                the currently displayed tree (target tree).
21
22NOTES           This also works fine when the source tree DOES NOT contain all species
23                of the target tree. Wherever the source tree does not define any ordering,
24                the order of the target tree is kept.
25
26                This function is e.g. useful after you have added some species to a (copy of a)
27                tree and then have optimized the tree: now you may want to sort the copied tree
28                according to the original tree. That reduces the unwanted re-ordering caused by
29                tree-optimization, without affecting the topology.
30
31                If you call the function several times with different source trees, the last
32                call will be most dominant. Ordering effects of foregoing calls will
33                remain in tree-regions uncovered by source-trees used in subsequent calls.             
34
35EXAMPLES        None
36
37WARNINGS        None
38
39BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.