source: branches/lib/HELP_SOURCE/source/tr_import.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.9 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      treeadm.hlp
5
6#       sub topics:
7#SUB     subtopic.hlp
8
9# format described in ../help.readme
10
11
12TITLE           Load tree from file
13
14OCCURRENCE      ARB_NT/Tree Admin/Import
15
16DESCRIPTION     Allows to import a tree written in Newick format.
17
18                Press the 'IMPORT' button to display the 'TREE LOAD' window.
19
20                Select a tree file from the 'Directories and Files' subwindow or
21                        type the file name to the 'FILE NAME' subwindow.
22
23                Specify a tree name ('tree_*') by typing it to the 'tree_name:'
24                        subwindow.
25
26                Press the 'LOAD' button.
27
28NOTES           If a suffix is displayed in or typed to the 'SUFFIX' subwindow,
29                only the corresponding file names will be displayed. The suffix
30                is automatically appended to the file name typed to the 'FILE
31                NAME' subwindow.
32
33SECTION FORMAT
34
35                The format recognized by ARB is a slightly enhanced Newick format.
36
37                Newick format specification:
38
39                       LINK{http://evolution.genetics.washington.edu/phylip/newick_doc.html}
40
41                ARB enhancement:
42
43                    If the 'internal_node_label' contains 'number' it is interpreted as bootstrap value.
44
45                    If the 'internal_node_label' contains 'number:name' number is interpreted as bootstrap value,
46                    and name is interpreted as group name.
47
48                    If the 'internal_node_label' contains 'name' it is interpreted as group name.
49
50EXAMPLES        None
51
52WARNINGS        The IDs associated with terminal nodes have to be
53                consistent with those of the current database!
54
55                Never give your groups numeric names or the ARB Newick enhancement will not work for you!
56
57BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.