source: tags/ms_r16q4/HELP_SOURCE/oldhelp/export_format.hlp

Last change on this file was 15354, checked in by westram, 8 years ago
  • fix import/export filter documentation
    • link import ↔ export
    • user filter location
      • mention in export
      • typo in import
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.1 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)
7#SUB    subtopic.hlp
8
9# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
10
11#************* Title of helpfile !! and start of real helpfile ********
12TITLE           Export File Formats
13
14OCCURRENCE      ARB_NT/File/Export Foreign 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                SYSTEM "command"
45
46                                First a output is created using
47                                xxx.eft. Then command is used to convert the
48                                result into the wanted result.
49
50                                In command use
51
52                                        $< as input-filename
53
54                                        $> as output-filename
55
56                INTERNAL type
57
58                                used for formats hardcoded in ARB_NT.
59
60                                Supported types:
61
62                                          'xml_write' Writes all none-hidden fields to XML.
63
64NOTES           The best ways to design new formats are:
65
66                        1. Copy an existing format and modify it step by step.
67                        2. Design a simple format and modify it step by step.
68
69                For a list of common database entries see LINK{sp_info.hlp}.
70
71EXAMPLES        Edit the files in '$ARBHOME/lib/export'
72
73WARNINGS        Don't change an '*.eft' file, if you don't understand how
74                it works.
75                Be careful when using ':' or '"' symbols.
76                Escape them if those symbols don't have a meaning.
77
78BUGS            No bugs known
79
Note: See TracBrowser for help on using the repository browser.