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