xref: /aoo41x/main/oox/source/dump/dumperbase.ini (revision cdf0e10c)
1
2# dumper settings ============================================================
3#
4# Basic concepts
5#
6# - Character encoding of dumper ini files is UTF-8.
7# - Whitespace characters are generally stripped, e.g. at start and end of
8#   lines, before/after equal signs, commas, etc.
9# - Comments start with the hash (#) or semicolon (;) character. Leading
10#   whitespace characters are ignored.
11#
12# ----------------------------------------------------------------------------
13
14# Enable entire dumper (default=off). This option does not affect the option
15# 'enable-import'.
16#   0=off, 1=on
17enable-dumper=1
18
19# Enable import after dumping (default=on). Disabling this option allows
20# to dump a file without loading it. This option is independent from the
21# 'enable-dumper' option.
22#   0=off, 1=on
23enable-import=1
24
25# Maximum size of binary stream dumps (default=infinite).
26max-binary-stream-size=65536
27
28# Maximum size of binary data blocks in content dumps (default=infinite).
29max-binary-data-size=128
30
31# Shows unknown trailing data as binary dump (default=on).
32#   0=off, 1=on
33show-trailing-unknown=1
34
35# Shows the absolute stream position of records in the record header field
36# (default=on).
37#   0=off, 1=on
38show-record-position=0
39
40# name lists =================================================================
41#
42# Syntax descriptions
43#
44# - Optional items are enclosed in brackets [].
45# - Optional items that may be repeated are marked with an ellipsis (...).
46# - Items in a set to choose from are separated by vertical lines (|).
47# - <LISTNAME> denotes the name of a list. List names may consist of any non-
48#   whitespace characters.
49# - <value>, <firstvalue>, <bitfield>, <bitmask> etc. denote integer values.
50#   Decimal and hexadecimal notation is supported, using C/C++ notation.
51# - <bool> denotes a boolean value. Possible values are 0|1|false|true.
52# - <constname> denotes a literal name for a constant or bit.
53#
54# ----------------------------------------------------------------------------
55#
56# constlist
57#
58# Defines names for a list of specific values.
59#
60# Syntax:
61#
62# constlist = <LISTNAME>
63#   default = <constname>
64#   include = <LISTNAME>[,<LISTNAME>...]
65#   exclude = <value>[,<value>...]
66#   quote-names = <bool>
67#   <value> = <constname>
68# end
69#
70# - default (optional): Declares <constname> as a default name for values not
71#   specified in the name list. <constname> may be the empty string. If not
72#   set, the literal string '?err:no-name' (unquoted) is the default name.
73# - include (optional): Includes the specified name list(s) into the own list.
74# - exclude (optional): Removes values from the name lists, useful e.g. after
75#   a name list has been included.
76# - quote-names (optional): Specifies whether to return the contained names
77#   enclosed in single quote (') characters. Default is false.
78#
79# The order of the declarations is important, later declarations may overwrite
80# names generated from earlier declarations.
81#
82# Example:
83#
84# constlist = EXAMPLE-CONSTLIST
85#   1 = my-value
86#   include = OTHER-LIST
87#   exclude = 2,3
88#   0x0004 = other-value
89# end
90#
91# - Defines the name 'my-value' for the constant 1.
92# - Includes 'OTHER-LIST' which may overwrite the name of the constant 1.
93# - Excludes the names of constants 2 and 3, which may have been included from
94#   the name list 'OTHER-LIST'.
95# - Defines the name 'other-value' for the constant 4, which may overwrite the
96#   name of this constant included from the name list 'OTHER-LIST'.
97#
98# ----------------------------------------------------------------------------
99#
100# multilist
101#
102# Defines names for contiguous ranges of values.
103#
104# Syntax:
105#
106# multilist = <LISTNAME>
107#   default = <constname>
108#   include = <LISTNAME>[,<LISTNAME>...]
109#   exclude = <value>[,<value>...]
110#   ignore-empty = <bool>
111#   <firstvalue> = <constname>[,<constname>...]
112# end
113#
114# - default (optional): See constlist above.
115# - include (optional): See constlist above.
116# - exclude (optional): See constlist above.
117# - ignore-empty (optional): Specifies whether to skip empty names in a list.
118#   - True = skips an empty entry, the default name will be generated.
119#   - False = creates an empty string for the entry.
120#   Default is true (skip empty entries).
121#
122# Examples:
123#
124# multilist = EXAMPLE-MULTILIST
125#   0 = value0,value1,,value3
126#   8 = value8
127# end
128#
129# - Defines the names 'value0' for the constant 0, 'value1' for the constant
130#   1, 'value3' for the constant 3, and 'value8' for the constant 8.
131#
132# multilist = EXAMPLE-MULTILIST-2
133#   include = EXAMPLE-MULTILIST
134#   ignore-empty = false
135#   default = other
136# end
137#
138# - Same as example above (includes EXAMPLE-MULTILIST), but defines the empty
139#   string for the constant 2. Other constants (less than 0 or greater than 3
140#   and not equal to 8) get the default name 'other'.
141#
142# ----------------------------------------------------------------------------
143#
144# shortlist
145#
146# Defines names for a contiguous range of values. The entire list definition
147# is given in a single text line.
148#
149# Syntax:
150#
151# shortlist = <LISTNAME>,<firstvalue>,<constname>[,<constname>...]
152#
153# Uses default settings of the multi-list (i.e. skips empty entries).
154#
155# ----------------------------------------------------------------------------
156#
157# flagslist
158#
159# Defines names for single bits in a bit field.
160#
161# Syntax:
162#
163# flagslist = <LISTNAME>
164#   include = <LISTNAME>[,<LISTNAME>...]
165#   exclude = <bitfield>[,<bitfield>...]
166#   ignore = <bitfield>
167#   <bitmask> = <cname> | !<cname> | :<cname> | !<cname0>!<cname1>
168# end
169#
170# - include (optional): See constlist above.
171# - exclude (optional): See constlist above.
172# - ignore (optional): Specifies bits to be ignored. Bits without an explicit
173#   name and not set in this declaration will be shown as unknown. Default is
174#   to not ignore a bit.
175# - <bitmask>: The bit to be named. Must be a value with a single bit set.
176#   - <cname> - Sets a name for the bit that will be shown if the bit is set.
177#     Does not show anything if the bit is cleared.
178#   - !<cname> - Sets a name for the bit that will be shown if the bit is
179#     cleared. Does not show anything if the bit is set.
180#   - :<cname> - Sets a name for the bit that will always be shown together
181#     with the actual state of the bit, appended as ':on' or ':off'.
182#   - !<cname0>!<cname1> - Sets a name for both the cleared bit (cname0), and
183#     for the set bit (cname1).
184#
185# ----------------------------------------------------------------------------
186#
187# combilist
188#
189# Defines names for single bits and for embedded values in a bit field. This
190# is an extension of the flagslist described above.
191#
192# Syntax:
193#
194# combilist = <LISTNAME>
195#   include = <LISTNAME>[,<LISTNAME>...]
196#   exclude = <bitmask>[,<bitmask>...]
197#   ignore = <bitfield>
198#   <bitmask> = <cname> | !<cname> | :<cname> | !<cname0>!<cname1>
199#   <bitfield> = <datatype>,<dataformat>,<bitfieldname>[,<LISTNAME>[,options...]]
200# end
201#
202# - include (optional): See constlist above.
203# - exclude (optional): See constlist above.
204# - ignore (optional): See flagslist above.
205# - <bitmask>: See flagslist above.
206# - <bitfield>: The mask of the embedded bitfield. Must be a value with
207#   exactly one sequence of at least 2 consecutive bits.
208#   - <datatype>: [u]int8 | [u]int16 | [u]int32 | [u]int64 | float | double
209#   - <dataformat>: dec | hex | shorthex | bin | fix | bool
210#   - <bitfieldname>: The name of the embedded bitfield.
211#   - <LISTAME>: Optional name list with names for the values of the embedded
212#     bitfield.
213#   - options: Additional options for this bitfield:
214#     - filter = <filterbitfield>~<filtervalue>: If set, the entire bitfield
215#       will only be written, if the complete data item currently dumped
216#       contains exactly the value specified in <filtervalue> in the bitfield
217#       specified in <filterbitfield>. Otherwise, nothing is written. It is
218#       possible to specify multiple filter rules for this bitfield. In that
219#       case, the bitfield will be written, if at least one filter rule
220#       applies for the current data item.
221#     - noshift = <bool>: If set to 'true', the extracted value will be
222#       shifted to the right (normalized). If set to 'false', the value will
223#       be written unshifted. Default is 'true'.
224#
225# ----------------------------------------------------------------------------
226#
227# unitconverter
228#
229# Converts values and appends a unit name.
230#
231# Syntax:
232#
233# unitconverter = <LISTNAME>,[/]<factor>[,<unitname>]
234#
235# ----------------------------------------------------------------------------
236
237unitconverter=CONV-DEC,1
238unitconverter=CONV-PERCENT,1,%
239unitconverter=CONV-FLOAT-TO-PERC,100,%
240unitconverter=CONV-DEG,1,°
241unitconverter=CONV-HMM-TO-CM,/1000,cm
242unitconverter=CONV-INCH-TO-CM,2.54,cm
243unitconverter=CONV-PT-TO-CM,/28.346457,cm
244unitconverter=CONV-PT1616-TO-CM,/1857713.4,cm
245unitconverter=CONV-TWIP-TO-CM,/566.92913,cm
246unitconverter=CONV-TWIP-TO-PT,/20,pt
247unitconverter=CONV-EMU-TO-CM,/36000,cm
248
249constlist=BOOLEAN
250  0=FALSE
251  default=TRUE
252end
253
254combilist=RK-FLAGS
255  0x00000001=div-100
256  0x00000002=integer
257  0xFFFFFFFC=int32,hex,value
258end
259
260constlist=CHARSET
261  0=win-1252-latin-1
262  1=system-default
263  2=symbol
264  77=apple-roman
265  128=win-932-japanese-shift-jis
266  129=win-949-korean-hangul
267  130=win-1361-korean-johab
268  134=win-936-chinese-simplified-gbk
269  136=win-950-chinese-traditional-big5
270  161=win-1253-greek
271  162=win-1254-turkish
272  163=win-1258-vietnamese
273  177=win-1255-hebrew
274  178=win-1256-arabic
275  186=win-1257-baltic
276  204=win-1251-cyrillic
277  222=win-874-thai
278  238=win-1250-latin-2-central-european
279  255=ibm-850-latin-1
280end
281
282combilist=FONT-PITCHFAMILY
283  0x0F=uint8,dec,pitch,FONT-PITCH
284  0xF0=uint8,dec,family,FONT-FAMILY
285end
286
287constlist=FONT-WEIGHT
288  400=normal
289  700=bold
290end
291
292shortlist=FONT-PITCH,0,unknown,fixed,variable
293shortlist=FONT-FAMILY,0,unknown,roman,swiss,modern,script,decorative
294
295constlist=CODEPAGES
296  367=ascii
297  437=ibm-437-us
298  708=iso-8859-6
299  720=ibm-720-arabic
300  737=ibm-737-greek
301  775=ibm-775-baltic
302  850=ibm-850-latin-1
303  852=ibm-852-latin-2-central-european
304  855=ibm-855-cyrillic
305  857=ibm-857-turkish
306  858=ibm-858-multilingual-latin-1-with-euro
307  860=ibm-860-portuguese
308  861=ibm-861-icelandic
309  862=ibm-862-hebrew
310  863=ibm-863-canadian-french
311  864=ibm-864-arabic
312  865=ibm-865-nordic
313  866=ibm-866-cyrillic-russian
314  869=ibm-869-greek-modern
315  874=win-874-thai
316  932=win-932-japanese-shift-jis
317  936=win-936-chinese-simplified-gbk
318  949=win-949-korean-wansung
319  950=win-950-chinese-traditional-big5
320  1200=utf-16
321  1250=win-1250-latin-2-central-european
322  1251=win-1251-cyrillic
323  1252=win-1252-latin-1
324  1253=win-1253-greek
325  1254=win-1254-turkish
326  1255=win-1255-hebrew
327  1256=win-1256-arabic
328  1257=win-1257-baltic
329  1258=win-1258-vietnamese
330  1361=win-1361-korean-johab
331  10000=apple-roman
332  10001=apple-japanese
333  10002=apple-chinese-traditional
334  10003=apple-korean
335  10004=apple-arabic
336  10005=apple-hebrew
337  10006=apple-greek
338  10007=apple-cyrillic
339  10008=apple-chinese-simplified
340  10010=apple-romanian
341  10017=apple-ukrainian
342  10029=apple-central-european-with-euro
343  10079=apple-icelandic
344  10081=apple-turkish
345  10082=apple-croatian
346  20127=ascii
347  20866=koi8-r
348  21866=koi8-u
349  28591=iso-8859-1
350  28592=iso-8859-2
351  28593=iso-8859-3
352  28594=iso-8859-4
353  28595=iso-8859-5
354  28596=iso-8859-6
355  28597=iso-8859-7
356  28598=iso-8859-8
357  28599=iso-8859-9
358  28605=iso-8859-15
359  32768=apple-romanian
360  32769=win-1252-latin-1
361  50220=iso-2022-jp
362  50225=iso-2022-kr
363  51932=euc-jp
364  51936=euc-cn
365  51949=euc-kr
366  65000=utf-7
367  65001=utf-8
368end
369
370multilist=COUNTRY
371  1=usa,canada,latin-america,,,,russia
372  20=egypt
373  30=greece,netherlands,belgium,france,spain,,hungary,,,italy
374  40=,switzerland,,austria,uk,denmark,sweden,norway,poland,germany
375  50=,,mexico,,,brazil
376  60=,australia,,,new-zealand,,thailand
377  80=,japan,korea,,vietnam,,china
378  90=turkey
379  210=,,,algeria,,,morocco,,libya
380  350=,portugal,,,iceland,,,,finland
381  420=czech
382  880=,,,,,,taiwan
383  960=,lebanon,jordan,syria,iraq,kuwait,saudi-arabia
384  970=,uae,israel,,qatar
385  980=,iran
386end
387
388multilist=SYSTEMCOLOR
389  0x00=scrollbar,desktop,active-title,inactive-title,menu,window-back,window-frame,menu-text
390  0x08=window-text,active-title-text,active-border,inactive-border,app-workspace,highlight,highlight-text,button-face
391  0x10=button-shadow,disabled-text,button-text,inactive-title-text,button-highlight,button-dark-shadow,button-light-shadow,tooltip-text
392  0x18=tooltip-back,,hot-light,active-title-2,inactive-title-2,menu-highlight,menubar
393end
394
395# ============================================================================
396