source: branches/lib/HELP_SOURCE/source/submission.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.7 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6#SUB     subtopic.hlp
7
8# format described in ../help.readme
9
10
11TITLE           Write to Submission Forms
12
13OCCURRENCE      ARB_NT/Species/Submission
14
15DESCRIPTION     First you have to select the species you want to submit (or
16                enter the species ID (shortname) of the species by hand).
17
18                Then click on 'READ INFO' to extract some needed data from that species. The extracted
19                data will show up in the nearby edit field.
20
21                Select the form you want to use for submission.
22
23                Press fill the form. This replaces all search strings (which are defined
24                in 'Your private data' and next to 'READ INFO') with their values and shows
25                the filled-out form in the third textbox.
26
27                At last enter a name, press save file and send that file by email
28                to some submission address.
29
30SECTION FILLING
31                The forms provided with ARB contain fields in the form $(SOME_ID)
32                These fields are replaced by the respective values from 'Your private data'
33                and 'READ INFO'.
34
35                The format of these sections is
36
37                    search1=replacewith1:
38                    search2=replacewith2:
39                    search3=replacewith3:
40
41                For a detailed description refer to LINK{srt.hlp}.
42
43NOTES           None
44
45EXAMPLES        None
46
47WARNINGS        Before submitting you should check the filled-out form for any un-replaced fields.
48                If you find any, define them in the 'Your private data' section.
49
50BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.