source: branches/sina/HELP_SOURCE/source/sp_info.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.3 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      arb_ntree.hlp
5UP      arb_edit4.hlp
6UP      mode_info.hlp
7UP      security.hlp
8UP      sp_search.hlp
9UP      Protection.hlp
10
11#       sub topics:
12SUB     spaf_reorder.hlp
13SUB     spaf_delete.hlp
14SUB     spaf_create.hlp
15SUB     spa_delete.hlp
16SUB     spa_rename.hlp
17SUB     spa_copy.hlp
18SUB     spa_create.hlp
19SUB     sp_sp_2_ext.hlp
20SUB     scandb.hlp
21
22
23# format described in ../help.readme
24
25
26TITLE           SPECIES INFORMATION
27
28OCCURRENCE      ARB/<INFO> button (top area; showing the short name of the selected species)
29                ARB/Species/Species Information
30                ARB/Species/Search/Info button
31                ARB/Info mode button (in the button bar on the left side)
32                ARB_EDIT4/Info mode button
33                ARB_PARSIMONY/Info mode button
34
35DESCRIPTION     Displays species information stored within the 'fields' (see
36                LINK{glossary.hlp}).
37
38                The particular 'species' (see LINK{glossary.hlp})
39                can be 'marked' or 'unmarked' (see LINK{glossary.hlp})
40                by pressing the checkbox after the 'Marked?' prompt.
41
42                Editing of 'field' entries is enabled or prevented by
43                pressing the 'Edit enabled?' checkbox.
44
45                The entries of a 'field' are modified by choosing it from
46                the 'DATABASE FIELDS' subwindow and modifying the entries
47                displayed in the 'Edit box' subwindow.
48
49NOTES           The 'SEARCH & QUERY' window can be displayed by pressing the <SEARCH>
50                button.
51
52                For modification of 'field' entries, a protection level has to be
53                selected from the protection selector below the lock in the ARB main
54                window, which is equal to or higher than that assigned to the selected 'field'
55
56                LINK{copyNpaste.hlp} can be used in the 'Edit box' subwindow.
57                This provides is easy way to manually export/import (sequence) data.
58
59SECTION         Locking information window to a specific species
60
61                When you open this window it will always show the information of
62                the currently LINK{selected.hlp}. That means if you select another species (in
63                the tree or in the editor) this window will follow your selection and display
64                the information of the newly selected species.
65
66                By pressing the 'Lock view' button you will open a second information
67                window which will be LOCKED TO the currently selected species.
68                That second information window will NOT FOLLOW the selected species (as the
69                primary information window does). Instead of the 'Lock view' button, it
70                shows an 'Update' button. Pressing the 'Update' button will change the
71                displayed species to the species currently selected.
72
73                You can distinguish the two types of information windows by their window
74                title and by the color of the area showing the ID of the selected species.
75
76
77SECTION         STANDARD ENTRIES
78
79                The following database entries have a special meaning in ARB:
80
81                name            unique species ID (generated by ARB)
82                full_name       full species name (generated by the user)
83                acc             Accession number (automatically generated by ARB if missing)
84
85                Entries relevant for DNA->AminoAcid encoding:
86
87                codon_start     contains the base inside the gene at which the
88                                first codon starts (valid: 1,2,3)
89                                if this entry is missing 1 is assumed
90                transl_table    the number of the translation table to be used
91                                (1 = Standard, ...)
92
93                Commonly used database entries (e.g. by import/export):
94
95                entry           EMBL           Genebank
96
97                author          RA             REFERENCE/AUTHORS
98                title           RT             REFERENCE/TITLE
99                journal         RL             REFERENCE/JOURNAL
100                refgrp          RG             REFERENCE/CONSRTM
101                pubmed_id       RX PUBMED      REFERENCE/PUBMED
102                medline_id      RX MEDLINE     REFERENCE/PUBMED
103                version         SV             VERSION
104                keywd           KW             KEYWORDS
105                tax             OC             ORGANISM
106                comment         CC             COMMENT
107
108                description     DE
109                auth_comm       RC
110                nuc_rp          RP
111                db_xref         DR             DBLINK
112                date            DT
113                organelle       OG
114                definition                     DEFINITION
115
116EXAMPLES        Update the 'full_name' 'Pseudomonas cepacia' to 'Comamonas
117                cepacia':
118                        Select FIELDS:  'full_name'
119                        Move cursor into the 'Edit box' subwindow
120                        Delete:         'Pseudomonas'
121                        Type:           'Comamonas'
122
123WARNINGS        It is recommended to reset the protection level after
124                modifying entries to prevent unintentional modification
125                or loss of data.
126
127BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.