source: branches/sina/HELP_SOURCE/source/arb_ntree.hlp

Last change on this file was 19708, checked in by westram, 3 months ago
  • update doc+gui:
    • avoid terms "ARB_NT" (=former name of main arb window), "ARB_NTREE" and similar
      • instead talk about "ARB main window"
    • correct refs to 'ARB/Probes/PT_SERVER Admin'.
    • update 'What are marked species?'.
    • update protection level documentation (parts already done with previous commit).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.8 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      arb.pdf
5UP      save.hlp
6UP      FAQS.hlp
7UP      manual.hlp
8UP      help.hlp
9
10#       sub topics:
11SUB     trees.hlp
12SUB     species.hlp
13SUB     genes.hlp
14SUB     extended.hlp
15SUB     alignment.hlp
16SUB     props_nds.hlp
17SUB     mode.hlp
18SUB     nt_keys.hlp
19
20# format described in ../help.readme
21
22
23
24TITLE           ARB Main Window
25
26DESCRIPTION     The ARB main window provides access to all available ARB tools for
27                analyzing and modifying the data stored in the current ARB database
28                via menus or buttons.
29
30                The tree shown within the tree display area can be used to walk
31                through the database, to structure it according to phylogeny,
32                and to display any information stored within the database at its
33                nodes.
34
35SECTION         ARB menu
36
37        Clicking on the prompts in the horizontal menu bar in the upper part of
38        the window displays the corresponding submenus. The submenus are
39        also available using keyboard shortcuts by pressing the meta and
40        a letter key indicated in the main menu bar by underlining.
41
42            File:
43
44                Save the database, export or import data.
45                Open second window or database.
46                Macro recording and playback.
47
48            Species:
49
50                Create, rename, delete, convert, mark, unmark, colorize, search or
51                display 'species' and their associated fields. Synchronize species IDs.
52
53            Sequence:
54
55                Create, copy, delete, rename, check, concatenate or modify 'alignments'
56                (see LINK{glossary.hlp}). Edit, align, translate or realign sequences.
57                Calculate similarity and distance matrices, profiles or filters.
58
59            SAI:
60
61                Copy, delete, rename, convert or combine SAI (sequence associated information).
62                Calculate consensus and positional variability.
63
64            Probes:
65
66                Probe and Primer design and matching.
67                Handle 'PT_SERVER' (see LINK{glossary.hlp});
68
69            Tree:
70
71                Copy, delete, import, export, print, compare, or modify trees.
72                Reconstruct phylogenetic trees.
73                Calculate consensus trees.
74                Curate taxonomy, fold clades.
75                Configure node display (NDS).
76
77            Tools
78
79                A collection of different functions which did not fit well elsewhere.
80                All external programs configured via GDE are listed here as well.
81
82            Properties:
83
84                Customize display of windows, trees and data.
85                To save these settings for future sessions choose 'Save properties'.
86
87            Many menu entries are linked to explicit help pages.
88            To visit such a help page, click the green '?' and
89            then the menu entry you'd like to read about.
90            See also LINK{help.hlp}.
91
92
93SECTION Top area
94
95        The buttons of the area (called 'top area') between the main menu bar and
96        the tree display area (from left to right):
97
98            First row:
99
100                Red 'X' button:
101
102                    Quit arb.
103
104                First large button:
105
106                    Displays the name of the current database and allows you [or "the user"] to save it.
107
108                Second large button:
109
110                    Indicates the name of the current tree and allows selection of the tree to be displayed.
111
112                Third large button:
113
114                    Indicates the name of the current 'alignment' (see LINK{glossary.hlp}) and allows
115                    switching to another alignment (see LINK{nt_align_select.hlp}).
116
117                'Search' button:
118
119                    Calls LINK{sp_search.hlp}.
120
121                Fourth large button:
122
123                    Displays the ID ('name') of the selected 'species' (see LINK{selected.hlp}) and
124                    provides access to the species information window (see LINK{sp_info.hlp}).
125
126            Second row:
127
128                Green '?' button:
129
130                    Click once and then any other element, to see documentation about
131                    that element (see LINK{help.hlp}). Click twice to see this page.
132
133                Disk buttons:
134
135                    Save database (quick or full save).
136
137                Circle arrow button:
138
139                    Undo/redo last database transaction.
140
141                Tree display buttons:
142
143                    * First displays radial tree.
144                    * Second displays dendrogram tree.
145                    * Third displays IRS tree.
146                    * Fourth displays just a list of species.
147
148                Editor button:
149
150                    Edit primary and secondary structure (see LINK{e4.hlp}).
151
152                Button below lock:
153
154                    Sets the protection level for user actions in ARB main
155                    program (see LINK{security.hlp}).
156
157                Jump button:
158
159                    Scrolls tree display such that the selected species/group
160                    gets visible (see LINK{selected.hlp}).
161
162                Marked button:
163
164                    Shows the number of marked species. Click to manage LINK{species_configs.hlp}.
165
166SECTION Mode buttons
167
168        The buttons of the first column of the ARB main window are used to
169        select different modes for editing and modifying the current tree shown
170        in the tree display area.
171
172
173NOTES           Online help is available for all menu items and buttons (see
174                LINK{help.hlp}).
175
176                The 'ARB main window' formerly has often been referred
177                to as 'ARB_NT' or 'ARB_NTREE' window.
178
179EXAMPLES        None
180
181WARNINGS        None
182
183BUGS            Report any bugs:
184
185                       send bug report to LINK{devel@arb-home.de}
Note: See TracBrowser for help on using the repository browser.