source: branches/lib/HELP_SOURCE/source/sp_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: 2.6 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      species.hlp
5UP      mark.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.hlp
14
15# format described in ../help.readme
16
17
18TITLE           Search Database for Species
19
20OCCURRENCE      ARB_NT/Species/search
21                ARB_NT/<species button: 4th broad rectangular button in
22                top area>
23
24DESCRIPTION     Searches for a (set of) species (not SAIs)
25                that match (don't match) a query or are marked.
26
27                The database is scanned for 'species' (see 'HELP')
28                which contain (or do not contain) the search string within the
29                specified 'field' (see LINK{glossary.hlp}). The corresponding
30                species and the respective 'field' entries are listed in the
31                'HIT LIST' subwindow. The number of hits is displayed after the
32                'Hits:' prompt.
33
34                Define whether matching or non-matching species should be
35                        listed by pressing the appropriate combination of left
36                        and right buttons in the top area. When performing
37                        multiple searches, define whether the list of 'species'
38                        should be replaced by the new results, and whether newly
39                        found 'species' should be removed from or appended
40                        to the existing list.
41
42                Select a 'field' from the 'Search Field' subwindow.
43
44                Type the search string in the 'Search string' subwindow.
45
46                Press the <SEARCH> button.
47
48NOTES           see LINK{searching.hlp} for details about searching.
49
50                see LINK{search_duplicates.hlp}
51
52EXAMPLES
53
54                1. Search for a species called 'Pseudomonas tolaasii'
55
56                        Select:                    Search all species that match the query
57                        Select search field:       'full_name'
58                        Type search expression:    'pseu*tol*'
59                        Press:                     'SEARCH'
60
61                2. Search for all species that are marked:
62
63                        Select:                    Search all species that are marked
64                        Press:                     'SEARCH'
65
66                3. Search for all species that are marked and for which
67                an entry is present in the field 'reference'
68
69                        Select:                    Search all species that are marked
70                        Press:                     'SEARCH'
71                        Select:                    Keep species that match the query
72                        Select search field:       'reference'
73                        Type search string:        '*' (=search existing entry)
74                        Press:                     'SEARCH' again
75
76
77WARNINGS        If the hitlist becomes too long, it will be truncated.
78                Nevertheless all operations work on non-truncated hitlist!
79
80                Changing the sort order will most likely show different items, because the
81                list gets truncated after it was sorted.
82
83BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.