source: tags/arb_5.1/HELP_SOURCE/oldhelp/export_format.hlp

Last change on this file was 4306, checked in by westram, 17 years ago
  • trailing backslashes
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.0 KB
Line 
1#Please insert up references in the next lines (line starts with keyword UP)
2UP      arb.hlp
3UP      glossary.hlp
4UP      arb_export.hlp
5
6#Please insert subtopic references  (line starts with keyword SUB)
7SUB     parser.hlp
8SUB     commands.hlp
9
10# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
11
12#************* Title of helpfile !! and start of real helpfile ********
13TITLE           Export File Formats
14
15OCCURRENCE      ARB_NT/File/Export Foreign Format
16
17DESCRIPTION     The export format description file (*.eft) describes
18                the format.
19                It contains different sections:
20
21        SECTIONS
22
23                SUFFIX          suffix          ;The suggested file suffix
24                #               headerinfo      ;Header information
25                BEGIN ...                       ;the main section
26
27                The main section is part of a 'SRT' (see LINK{glossary.hlp})
28                conversion (in fact the main section S is replaced by "*=S" and
29                the SRT is started on an empty string).
30                That means:
31
32                        1. All simple 'text' is written to the output file.
33
34                        2. All references '*([ref][:|#modifier])' are replaced
35                           by the [modified] value of the reference
36
37                        3. All lines containing the word '$$DELETE_LINE$$' are deleted.
38
39                        4. Lines ending with a \ are joined with the next line.
40
41        SPECIAL SECTIONS
42
43                PRE_FORMAT xxx.eft
44
45                SYSTEM "command"
46
47                                First a output is created using
48                                xxx.eft. Then command is used to convert the
49                                result into the wanted result.
50
51                                In command use
52
53                                        $< as input-filename
54
55                                        $> as output-filename
56
57                INTERNAL type
58
59                                used for formats hardcoded in ARB_NT.
60
61                                Supported types:
62
63                                          'xml_write' Writes all none-hidden fields to XML.
64
65NOTES           The best ways to design new formats are:
66
67                        1. Copy an existing format and modify it step by step.
68                        2. Design a simple format and modify it step by step.
69
70EXAMPLES        Edit the files in '$ARBHOME/lib/export'
71
72WARNINGS        Don't change an '*.eft' file, if you don't understand how
73                it works.
74                Be careful when using ':' or '"' symbols.
75                Escape them if those symbols don't have a meaning.
76
77BUGS            No bugs known
78
Note: See TracBrowser for help on using the repository browser.