source: branches/lib/HELP_SOURCE/source/gene_search.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.6 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      genes.hlp
5UP      mark_genes.hlp
6
7#       sub topics:
8SUB     mark_list.hlp
9SUB     unmark_list.hlp
10SUB     del_list.hlp
11SUB     write_field_list.hlp
12SUB     mod_field_list.hlp
13SUB     selected_gene.hlp
14
15# format described in ../help.readme
16
17
18TITLE           Search Database for Genes
19
20OCCURRENCE      ARB_NT/Genome/Search and Query
21                ARB_NT/Genome/Gene information/Search
22                ARB_GENEMAP/Genome/Search and Query
23                ARB_GENEMAP/Genome/Gene information/Search
24
25DESCRIPTION     Searches for a (set of) genes
26                that match (don't match) a query or are marked.
27               
28                The database is scanned for 'genes' which contain (or do not
29                contain) the search string within the specified 'field'.
30                The corresponding genes and the respective 'field' entries are
31                listed in the 'HIT LIST' subwindow. The number of hits is
32                displayed after the 'Hits:' prompt.
33
34                Define whether matching or non-matching genes should
35                be listed by pressing the appropriate combination of buttons
36                in the top area.
37
38                Define whether genes are searched in the current, in all
39                marked or in all species.
40
41                When performing multiple searches, define whether the list of
42                'genes' should be replaced by the new results, and whether
43                newly found 'genes' should be removed from or appended to the
44                existing list.
45
46                Select a 'field' from the 'Search Field' subwindow.
47
48                Type the search string in the 'Search string' subwindow.
49
50                Press the <SEARCH> button.
51                       
52NOTES           see LINK{searching.hlp} for details
53
54EXAMPLES        None
55
56WARNINGS        If the hitlist becomes too long, it will be truncated.
57
58BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.