source: branches/lib/HELP_SOURCE/source/arb_intro.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.8 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      copyright.hlp
4UP      arb_commands.hlp
5UP      arb.pdf
6UP      glossary.hlp
7UP      help.hlp
8
9#       sub topics:
10SUB     arb_import.hlp
11SUB     arb_merge.hlp
12
13# format described in ../help.readme
14
15
16TITLE           ARB intro window
17
18                Open, merge or create ARB databases.
19
20DESCRIPTION     Allows to open an existing 'ARB' database, to merge two 'ARB'
21                databases, and to create a new 'ARB' database importing external
22                data.
23
24                To open an existing 'ARB' database, select a '*.arb' file from
25                the 'Existing Files and Directories' subwindow and press
26                the 'OPEN SELECTED' button to display the 'ARB_NT' main
27                window.
28
29                To merge (parts of) two 'ARB' databases,
30                press the 'MERGE TWO ARB DATABASES' button.
31
32                To create a new 'ARB' database, press the 'CREATE AND IMPORT'
33                button to display the 'ARB IMPORT' window.
34
35NOTES           A suffix typed or displayed in the 'Suffix' subwindow is used as
36                a filter for the file names to be displayed in the 'Existing
37                Files and Directories' subwindow.
38
39                If you want to load a specified ARB quick-save file, remove the
40                suffix and select the wanted file.
41
42                ARB databases stored in any directory with read and write
43                permission can be opened starting 'arb' from the current
44                directory. Find the path by successively selecting the
45                corresponding directories from the 'Existing Files and
46                Directories' subwindow.
47
48                You might also specify the name of a database or just a directory
49                in the command line.
50
51                Details can be found in the command line help.
52                Goto a shell and type
53
54                        arb --help
55
56EXAMPLES        None
57
58WARNINGS        The suffix of 'ARB' database files has to be '.arb'!
59
60BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.