source: branches/lib/HELP_SOURCE/source/export_format.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.0 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      arb_export.hlp
5
6#       sub topics:
7#SUB     subtopic.hlp
8
9# format described in ../help.readme
10
11
12TITLE           Export File Formats
13
14OCCURRENCE      ARB_NT/File/Export/Export to external format
15
16DESCRIPTION     The export format description file (*.eft) describes
17                the format.
18                It contains different sections:
19
20        SECTIONS
21
22                SUFFIX          suffix          ;The suggested file suffix
23                #               headerinfo      ;Header information
24                BEGIN ...                       ;the main section
25
26                The main section is part of a 'SRT' (see LINK{srt.hlp})
27                conversion (in fact the main section S is replaced by "*=S" and
28                the SRT is started on an empty string).
29                That means:
30
31                        1. All simple 'text' is written to the output file.
32
33                        2. All references '*([ref][:|#modifier])' are replaced
34                           by the [modified] value of the reference
35
36                        3. All lines containing the word '$$DELETE_LINE$$' are deleted.
37
38                        4. Lines ending with a \ are joined with the next line.
39
40        SPECIAL SECTIONS
41
42                PRE_FORMAT xxx.eft
43
44                [ DESCRIPTION "text describing generated export format" ]+
45
46                SYSTEM "command"
47
48                                First a output is created using
49                                xxx.eft. Then command is used to convert the
50                                result into the wanted result.
51
52                                In command use
53
54                                        $< as input-filename
55
56                                        $> as output-filename
57
58                INTERNAL type
59
60                                used for formats hardcoded in ARB_NT.
61
62                                Supported types:
63
64                                          'xml_write' Writes all none-hidden fields to XML.
65
66NOTES           The best ways to design new formats are:
67
68                        1. Copy an existing format and modify it step by step.
69                        2. Design a simple format and modify it step by step.
70
71                For a list of common database entries see LINK{sp_info.hlp}.
72
73EXAMPLES        Edit the files in '$ARBHOME/lib/export'
74
75WARNINGS        Don't change an '*.eft' file, if you don't understand how
76                it works.
77                Be careful when using ':' or '"' symbols.
78                Escape them if those symbols don't have a meaning.
79
80BUGS            No bugs known
81
Note: See TracBrowser for help on using the repository browser.