Option Setting File

The Option Setting File is an XML file which describes the operating setup for AH Formatter V6.1. It can be loaded by the -i option in Command-line Interface, etc. In Windows Graphical User Interface, the Option Setting File is loaded automatically if AHFSettings.xml (AHFSettings(x64).xml for Windows x64 version) exists in the application specific data directory. The application data is indicated by the environment variable, APPDATA as follows: [APPDATA]\AntennaHouse\AHFormatter\6.1\

When the content of the Option Setting File is corrected with the editor, etc. while AH Formatter V6.1 is running, the correction is not reflected to AH Formatter V6.1. Please exit AH Formatter V6.1 once or load the Option Setting File from the [Format]-[Import Option Setting Dialog] menu in GUI. (There may be some which cannot be changed by reloading settings.)

The following are the elements of the Option Setting File:

Element Location Description
<formatter-config> root element Root element of the AH Formatter V6.1 Option Setting File.
<formatter-settings> child of <formatter-config> Formatter Settings element.
<font-settings> child of <formatter-config> Font Settings element.
<script-font> child of <font-settings> Generic font mapping settings element.
<font-alias> child of <font-settings> Font alias settings element.
<pdf-settings> child of <formatter-config> The element of PDF Output Settings.
<embed-font> child of <pdf-settings> Embedding font settings element.
<ps-settings> child of <formatter-config> The element of PostScript Output Settings.
<svg-settings> child of <formatter-config> SVG Output Settings element.
<inx-settings> child of <formatter-config> INX Output Settings element.
<mif-settings> child of <formatter-config> MIF Output Settings element.
<text-settings> child of <formatter-config> TEXT Output Settings element. no-LT
<mathml-settings> child of <formatter-config> MathML Settings element.
<xslt-settings> child of <formatter-config> XSLT Settings element.
<param> child of <xslt-settings> The xslt:param settings element.
<stylesheet> child of <xslt-settings> Default stylesheet settings element.

AH Formatter V6.1 allows you to specify one of the following units for the parameter (designated with asterisk * sign) that takes the length value.

Representation Meanings
cm centimeter
mm millimeter. 1 mm = 1/10 cm
in inch. 1 in = 2.54 cm
pt point. 1 pt = 1/72 in
pc pica. 1 pc = 12 pt
jpt 1 jpt = 0.3514 mm
q 1 q = 0.25 mm

Formatter Settings

These settings are used for the formatting.

Element Location Attribute Default Description
<formatter-settings> child of <formatter-config> abbreviation-character-count 3 Specify the number of characters considered to be an abbreviation when a line break is inserted. See also axf:abbreviation-character-count.
append-non-end-of-line-characters Specifies to append the non-end-of-line characters. White spaces, opening brackets, that are originally non-end-of-line, are disregarded even though they are specified. See also axf:append-non-end-of-line-characters in extended FO.
append-non-starter-characters Specifies to append the non-starter characters. White spaces, closing brackets and punctuations, that are originally non-starter, are disregarded even though they are specified. See also axf:append-non-starter-characters in extended FO.
auto-formatter-type html When the detection of formatting type is set automatically and the decision of XHTML or HTML is unclear, the priority can be given by specifying the following values.
  • html
  • xhtml
See also Detection of Formatting Type.
baseline-mode 6 In AH Formatter V6.1, there are some changes from XSL Formatter V4 in deciding the baseline in the text with different scripts like a mixture of Western and Japanese. The following values can be specified.
  1. Operates the same as XSL Formatter V4.
  2. Adds the improved operation by AH Formatter V5.
  3. Adds the improved operation by AH Formatter V6.
See also Difference in Formatting with AH Formatter V6.0. In addition, when baseline-mode="4" is specified, the text-altitude and text-depth properties are invalid.
bidi-override-mode 5 In AH Formatter V6.1, there are some changes from XSL Formatter V4 in the behavior of <fo:bidi-override>. Please specify the value when you want to make it the same operation as V4. The following values can be specified.
  1. Operates the same as XSL Formatter V4.
  2. Adds the modified operation by AH Formatter V5.
See also Difference in Formatting with XSL Formatter V4.
bold-ratio 1.0 Specifies the weight of a font without bold in the font family. When 1.0 is specified, only the amount decided by the system is made thicker. For instance, when 1.5 is specified, it is drawn 1.5 times thicker. When 0.0 or less is specified, it is considered as 1.0 thick. This setting is effective with PDF Output and PostScript Output.
border-medium-width * 3pt Specifies the default border width in medium style with the real-type numeric value.
border-thick-width * 5pt Specifies the default border width in thick style with the real-type numeric value.
border-thin-width * 1pt Specifies the default border width in thin style with the real-type numeric value.
default-CJK Specifies the language (such as jpn or kor) to be applied when a script is ambiguous for CJK. Although the default value is determined from the operating environment, Japanese language is assumed when the operating environment is other than CJK.
default-color #000000 Specifies the default color of text with the format of #RRGGBB.
default-font-size * 10pt Specifies the default font size with the real-type numeric value.
default-from-page-master-region false In XSL1.1, there is no compatibility with XSL1.0 in the method of evaluating writing-mode or reference-orientation. If true is specified, it becomes the same operation as when writing-mode="from-page-master-region()" reference-orientation="from-page-master-region() is specified for fo:page-sequence. Refer to from-page-master-region() for details.
default-html-charset UTF-8 Specifies the default encoding of HTML. This setting is applied to HTML with unknown encoding. When the setting is in HTML, or the encoding can be recognised by BOM, they are adopted. See also <text-settings encoding>. Case insensitive.
default-lang Specifies the default language code. The language code follows ISO 639-2. There is no default value. default-lang specifies the language when FO doesn't have the language specification. This is outputted as the language information to the PDF. The default value of default-lang is empty. At this time, if the language is not specified for FO etc., the language information is not outputted to the PDF. The language specified to default-lang2 is adopted when default-lang is empty.
default-lang2 eng Specifies the language actually adopted when default-lang is empty. When default-lang2 is empty, it depends on the locale of the system.
default-page-height * 297mm Specifies the default page height with the real-type numeric value.
default-page-margin-bottom * 10% Specifies a default page margin with the real-type numeric value. A percent value is considered as a ratio out of the page width or the page height.
default-page-margin-left * 10%
default-page-margin-right * 10%
default-page-margin-top * 10%
default-page-width * 210mm Specifies the default page width with the real-type numeric value.
fixed-width-space-treatment true The glyph such as EM SPACE (U+2003) etc. which corresponds to the white space with fixed width is not contained in many fonts. Therefore, alternative characters, such as an square symbol, will be displayed. In such a case, it specifies whether to put the white space or not without displaying an alternative glyph. If true is specified, an white space will be generated. If false is specified, an alternative glyph will be displayed. The target characters and their widths are as follows. (in units of em)
U+2000EN QUAD1/2
U+2001EM QUAD1
U+2002EN SPACE1/2
U+2003EM SPACE1
U+2004THREE-PER-EM SPACE1/3
U+2005FOUR-PER-EM SPACE1/4
U+2006SIX-PER-EM SPACE1/6
U+2007FIGURE SPACEThe same width of the figure '0'.
U+2008PUNCTUATION SPACEThe same width of the punctuation period '.'.
U+2009THIN SPACEDepends on the setting of thin-space-width.
U+200AHAIR SPACEDepends on the setting of hair-space-width.
U+205FMEDIUM MATHEMATICAL SPACE4/18
hair-space-width 0.1 Specifies the character width of HAIR SPACE (U+200A) in units of em, when fixed-width-space-treatment="true" is specified.
HyphenationOption true Specifies whether to hyphenate words by using the original processing that supports over 40 languages or to use the TeX dictionary. I f false is specified, Words will be hyphenated by using the TeX dictionary. At that time, only the languages that have the dictionaries can be hyphenated.
intrusion-displace-mode 6 In AH Formatter V6.1, there are some changes from AH Formatter V5 in the behavior of the intrusion-displace property. Please specify when you want to make it the same as V5.
  1. Operates the same as AH Formatter V5.
  2. Adds the modified operation by AH Formatter V6.
See also Difference in Formatting with AH Formatter V5.
issue-scale-to-fit false Specifies whether to report the scale-change ratio when the scale ratio of the image is changed by scale-to-fit/scale-down-to-fit/scale-up-to-fit with the value of true or false. If true is specified, the level 1 is reported. V6.1
latin-ligature false Specifies whether to process the ligature in European languages with the value of true or false. If true is specified, the ligature will be processed. If false is specified, it will not be processed. This setting affects the value of axf:ligature-mode="auto".
non-starter-ideographic-space true Specifies whether to treat the ideographic space as a non-starter character. See also Treatment of full-width white space in Technical Notes V6.1
normal-line-height 1.2 Specifies the default line height with the real-type numeric value. A unit is not specified. The value means the ratio to the font size. The initial value is 1.2. Therefore, in case the font size is 10pt, the line height becomes 12pt.
normalize NFC Specifies the method of the normalization to be adopted when axf:normalize="auto" is specified. The following values can be specified: V6.1 no-LT
  • none : Does not normalize text.
  • NFC : Performs NFC.
  • NFD : Performs NFD.
  • NFKC : Performs NFKC.
  • NFKD : Performs NFKD.
See also Difference in Formatting with AH Formatter V6.0.
oblique-skew 0 Specifies the amount of the inclination when using "font-style ="oblique" or "Backslant". When 0 or less is specified, it is considered as the system default. The font is inclined by the system default whenever there is no italic in the font when using "font-style ="italic". This setting is effective in the following outputs.
printer-marks-line-length 10mm Specifies the length of the printer marks.
printer-marks-line-width 0.24pt Specifies the width of the printer marks.
printer-marks-zero-margin 3mm Specifies the margin between the page and the printer marks when bleed is 0. no-LT
PrinterOrientation auto When the paper is placed in landscape in the PS Printer, there may be a case that the printer rotate-output the line and EPS incorrectly because some printers cannot get information. Possible to correct the rotation by specifying one of the following values. (The value should be anti-clockwise rotation degree.)
  • auto
  • 0
  • 90
  • 270
This setting is effective only with Windows version.
PscriptPassThrough true Possible to makes Pass Through output invalid when outputting to PS printer. If true is specified, Pass Through output is executed. If false is specified, Pass Through output is not executed but the output is executed only by GDI operator. This setting is effective only with Windows version.
pair-kerning false Specifies whether to process the pair kerning in European languages with the value of true or false. I f true is specified, the ligature will be processed. If false is specified, it will not be processed. This setting affects the value of axf:kerning-mode="auto".
punctuation-spacing 50% Specifies the space width between the adjacent Japanese full width characters with the percentage value. The value means the ratio to the font size. This setting affects the value of axf:punctuation-spacing="auto" in extended FO.
punctuation-trim true When Japanese full width characters (punctuations, brackets) are used in succession or come at the start of a line, you can specify whether to trim the letter spacing or keep the same letter spacing with the value of true or false. If the value is true, the letter spacing will be tracked narrow. If the value is false, it will be the same as that of other full width characters. This setting affects the values of axf:punctuation-trim="auto" and axf:text-justify-trim="auto" in extended FO.
pxpi 96 In XSL or CSS, you can specify px (pixel) as a unit of measurement. pxpi specifies the coefficient, which converts the value of the specified px, as "the number of pixels per inch" when formatting. It's specified with the real-type numeric value.
ruby-align Specifies the arrangement when axf:ruby-align="auto" is specified. When nothing or "auto" is specified, it is considered as "Distribute-space center".
SeparatePrinterDuplexJob true Specifies whether to batch print without interrupting a job for printing, even if the switching of the printer between simplex/duplex modes is set when axf:printer-duplex is specified. If true is specified, the file is split and outputted, if false is specified the file is batch printed. V6.1
small-caps-emulation-size 70% Specifies the scale-down ratio when the font does not have small-caps when font-variant="small-caps" is specified. V6.1
table-auto-layout-limit 100 When table-layout="auto" is specified, it is necessary to look ahead and read the table to decide the width of column. The number of row to read ahead can be limited because it takes a long time to read all row in a too huge table. After reading ahead up to the number of row specified here, the width of column is decided. If 0 is specified, all row is read, and then the width of column is decided. Refer to Table Auto Layout for details.
table-is-reference-area false In XSL1.1, there is no compatibility with XSL 1.0 about whether to make fo:table a reference area. If true is specified, fo:table will be made a reference area and its operation will be the same as XSL1.0. Refer to Incompatibility of fo:table for more details.
text-autospace true Specifies whether to insert spaces between Japanese characters and Western characters to make them look better with the value of true or false, in the document Japanese and Western are mixed. If the value is true, a space will be inserted to make them look better. If the value is false, a space won't be inserted. This setting affects the value of axf:text-autospace="auto" in extended FO.
text-autospace-width 25% Specifies the space width between Japanese characters and Western characters with the percentage value. The value means the ratio to the font size. This setting affects the value of axf:text-autospace-width="auto" in extended FO.
text-decoration-mode 1 Specifies how much the underline, strikethrough and overline exceed the length of a word.
0.Do not exceed the word length.
1.Exceed half-length of the space between words.
2.Do not exceed the start edge of a word, but exceed the end edge of a word by the full space between words.
text-justify-mode 5 In AH Formatter V6.1, there are some changes from XSL Formatter V4 in trimming a line. Please specify the value when you want to make it the same operation as V4. This adjusts the initial value when axf:text-justify-trim="auto" is specified. The following values can be specified.
  1. Operates the same as XSL Formatter V4. That is, it is considered that ideograph and inter-word are specified.
  2. Adds the improved operation by AH Formatter V5.
See also Difference in Formatting with XSL Formatter V4.
text-kashida-space 100% Specifies the percentage of the Kashida in Arabic justification. The value indicates the percentage of white space and Kashida. If the value is 0%, Kashida is not inserted and only the white space expands as well as the normal justification. If the value is 100%, Kashida is inserted as much as possible. This setting affects the value of axf:text-kashida-space="auto" in extended FO.
text-orientation-mode 6 Specifies whether UTR#50: Unicode Properties for Horizontal and Vertical Text Layout is taken into consideration by the value of axf:text-orientation when rendering alphanumeric characters, etc. upright in vertical writing mode. V6.1 no-LT
5.UTR#50 is not taken into consideration.
6.SVO and MVO are taken into consideration.
Note:
text-underline-mode 6 Some improved changes have been added for the position of underline and overline with AH Formatter V6.1. Please specify when you want to make it the same as V5.
  1. Operates the same as AH Formatter V5.
  2. Adds the improved operation by AH Formatter V6.
See also Difference in Formatting with AH Formatter V5.
thin-space-width 0.2 Specifies the character width of THIN SPACE (U+2009) in units of em, when fixed-width-space-treatment="true" is specified.
two-pass-formatting false When formatting a huge document with a large amount of unresolved <fo:page-number-citation>, a large amount of memories are consumed because the cancellation of the page information is impossible. Therefore, the limit is caused in the number of pages to format. This parameter solves that problem by making the formatting two passes. Although its processing time may be increased, only the page number information which should be solved will consume the memory and the memory consumption will be extremely decreased. When the GUI, this setting is invalid. no-LT
use-default-page-margin-CSS true Specifies whether default-page-margin-* is adopted or not when there is no margin specification in @page in CSS.
use-default-page-margin-XSL false Specifies whether default-page-margin-* is adopted or not when there is no margin specification in fo:simple-page-master in XSL.
vertical-block-width-mode 6 The behavior of the auto value of the width of vertical-text block within horizontal-text flow (or the height of horizontal-text block within vertical-text flow) is changed with AH Formatter V6.1. Please specify when you want to make it the same as V5.
  1. Operates the same as AH Formatter V5. The width of vertical-text block is given by the width of the outer area.
  2. Adds the improved operation by AH Formatter V6. The width of vertical-text block shrinks to fit the content.
See also Difference in Formatting with AH Formatter V5.
vertical-underline-side auto In the XSL specification, there is no description about the underline in vertical writing mode. The vertical-underline-side property is an option which specifies whether to place the underline in vertical writing mode on the right side or on the left side. If left or right is specified, the underline is placed on the left or on the right. If auto is specified, the underline is placed on the right side when the language property is Japanese(jpn) or Korean(kor). The underline is placed on the left side when the language property is other than Japanese(ja) or Korean(ko). If there is no language properties specified, it depends on the standard CJK language setting. This setting affects the value of the extension property, axf:vertical-underline-side="auto".
viewport-length-units-mode 6 Specifies whether to adapt the CSS3 interpretation of the vw and vh units .
  1. Makes the vw and vh units based on the page size.
  2. Makes the vw and vh units based on the size of the area excluding the page margins.
See also Difference in Formatting with AH Formatter V6.0. V6.1
watermark-font-family sans-serif Specifies the font family to the character string which you set to watermark-text.
watermark-font-style normal Specifies the font style to the character string which you set to watermark-text.
watermark-font-weight normal Specifies the font weight to the character string which you set to watermark-text. Possible to specify normal, bold or the numerical value from 100 to 900.
watermark-text Displays the specified watermark text on each page. Possible to make it multiple lines by delimiting with the line feed &#10;. This setting is invalid with the evaluation version. With AH Formatter V6.1 Lite, the watermark that shows the evaluation version is shown after the 300 pages, which is the limited formatted pages with the Lite version. You will need to specify an appropriate watermark-font-family according to the text you specify. Please confirm it by outputting PDF. In addition, complex scripts such as Thai and Arabic cannot be specified. The text that cannot be outputted by a single font cannot be specified.
WindowsFontAPI AH Formatter V6.1 handles Arabic, Hebrew, Hindi, Thai, etc. originally, it's possible to display these languages without depending on the platform. However there are some unsupported scripts and fonts which cannot be displayed correctly. Available to specify the script to be displayed by using WindowsAPI. Specify the scripts using the notation defined by ISO 15924 and putting commas between scripts. The following shows an example of Devanagari.
WindowsFontAPI="Deva"
However in this case, the same result cannot be gained when outputting to PDF. In order to get the same result, please use Adobe Distiller to create PDF. In order to make this setting effective, you need to specify use-windows-api="true" as well. The default value is empty. This setting is effective only with Windows version.
CAUTION: Some fonts may not be displayed correctly.
zwsp-mode 5 The operation of ZERO WIDTH SPACE (U+200B) was corrected with AH Formatter V6.1. However, it's compatible with V5 by default. Please specify when you want make it operate as V6.
  1. Operates the same as AH Formatter V5.
  2. Adds the modified operation by AH Formatter V6.
See also Difference in Formatting with AH Formatter V5. V6.0MR2
<list-style-type> child of <formatter-settings> box Specifies the character to use by list-style-type="box". As for the initial value when a null value being specified or a value not being specified, please refer to (-ah-)list-style-type.
check Specifies the character to use by list-style-type="check". As for the initial value when a null value being specified or a value not being specified, please refer to (-ah-)list-style-type.
circle Specifies the character to use by list-style-type="circle". As for the initial value when a null value being specified or a value not being specified, please refer to (-ah-)list-style-type.
diamond Specifies the character to use by list-style-type="diamond". As for the initial value when a null value being specified or a value not being specified, please refer to (-ah-)list-style-type.
disc Specifies the character to use by list-style-type="disc". As for the initial value when a null value being specified or a value not being specified, please refer to (-ah-)list-style-type.
hyphen Specifies the character to use by list-style-type="hyphen". As for the initial value when a null value being specified or a value not being specified, please refer to (-ah-)list-style-type.
square Specifies the character to use by list-style-type="square". As for the initial value when a null value being specified or a value not being specified, please refer to (-ah-)list-style-type.
<script-chars> child of <formatter-settings> script Evaluates all characters specified to the code as scripts specified to the script. For example, by specifying as follows,

<script-chars script="Jpan" code="&#x5C;"/>

&#x5C; is displayed as ¥. (Note that it is applied only when the font corresponding to Jpan is specified for font-family). When code not being specified, all characters specified to script are cancelled. When script not being specified, all characters specified to code are cancelled.
code
<space-after-punctuation> child of <formatter-settings> language Specifies the language code.
code Specifies the character to be applied. For the specified language, the specified space is placed after the code specified. When code not being specified, all characters specified to script are cancelled.
space Specifies the amount of space with the real type numerical value. The value means the ratio to the fontsize.
<space-before-punctuation> child of <formatter-settings> language Specifies the language code.
code Specifies the character to be applied. The specified space is placed before the specified code for the specified language. When the code is not being specified, all characters specified to script are cancelled.
space Specifies the amount of space with the real type numerical value. The value means the ratio to the fontsize.
<space-between-digit-and-punctuation> child of <formatter-settings> language Specifies the language code.
code Specifies the character to be applied. For the specified language, the specified space is placed between the digit and the code specified. When code not being specified, all characters specified to script are cancelled.
space Specifies the amount of space with the real type numerical value. The value means the ratio to the fontsize.
<space-between-punctuation-and-digit> child of <formatter-settings> language Specifies the language code.
code Specifies the character to be applied. For the specified language, the specified space is placed between the code specified and the digit. When code not being specified, all characters specified to script are cancelled.
space Specifies the amount of space with the real type numerical value. The value means the ratio to the fontsize.
<usercss> child of <formatter-settings> Specifies the CSS user stylesheet you want to add by &lt;css&gt;. See also Cascading Order of CSS.
<css> child of <usercss> path Specifies the path of the CSS user stylesheet.
<script-language-in-CJK> child of <formatter-config> script When the script specified to the script attribute appears in the sentence of CJK languages, the character string of the script is considered as the language that is specified to the language attribute. For example,

<script-language-in-CJK script="Latn" language="eng"/>

The Latn character string that appears in Japanese or Chinese sentences can be recognized as English. If hyphenate="true" is specified, the hyphenation can be processed by considering this part as English. The CJK languages cannot be specified to language. When nothing is specified to the language attribute, the language specification to the script attribute is canceled.
language
<multimedia> child of <formatter-config> video When specifying multimedia, such as video or audio as graphics, the setting of content-type is indispensable. AH Formatter V6.1 may not sometimes recognize if the content-type other than video/* or audio/* formats indicates the multimedia automatically. For such content-type, please specify video or audio explicitly as follows:
<multimedia video="application/x-shockwave-flash"/>
V6.1
audio
<GS1-128> child of <formatter-config> AI Registers the format of application identifier (AI) of GS1-128. Some formats of AI has been already registered, but you can specify when you change the format or the format is not registered. AI is a number with 2 to 4 digits. AI starting from 0 should be two digits. The last digit can be set as * if AI is a 3 or 4 digit number. For instance, AI="380*" indicates 3800 to 3809. The following formats can be specified to the format attribute.
  • n3 : 3-digit numbers
  • x3 : 3-digit arbitrary characters
  • n-10 : Numbers with greater than or equal to 1 and less than or equal to 10 digits.
  • x3-10 : Arbitrary characters with greater than or equal to 3 and less than or equal to 10 digits.
For example, specify as follows;

<GS1-128 AI="380*" format="n-15"/>

format
<UTR50> child of <formatter-config> code Specifies the code point to code you change. The code point can be specified as follows: Characters greater than U+10000 cannot be specified.
  • One character : or &#x201C;, etc.
  • 4-digit hexadecimal numbers : 201C
  • Set of 4-digit hexadecimal numbers : 202A..202E
U or R can be specified to SVO or MVO. It means that U renders upright, R rotates 90-degree clockwise. V6.1 no-LT
SVO
MVO

Font Settings

These settings are used for the fonts.

Element Location Attribute Default Description
<font-settings> child of <formatter-config> auto-fallback-font true Specifies whether to look for a fall back font automatically when a font with a glyph cannot be found in the font family which was specified by FO or CSS. See also Font Selection to learn more about the fall back method.
barcode-text-font OCRB,monospace Specifies the font used when you add the text of an original code to the linear barcode with Barcode Generator Option.
default-font-family serif Specifies the default font family. Usually, it is one of the generic font families: serif, sans-serif, cursive, fantasy or monospace. See also Font Selection.
fallback-glyph 1 Specifies whether to report it or not when the glyph is found in a fall back font. When the glyph corresponding to the specified character in the font family is not found, if auto-fallback-font is specified, a fall back font will be looked for. The following either can be specified.
0.No error message will be reported.
1.The level 1 error message will be reported.
2.The level 2 error message will be reported.
font-selection-mode 6 Specifies the selection method of fonts. The following values can be specified.
  1. The setting of font-selection-strategy is disregarded and always considered as auto.
  2. When font-selection-strategy="character-by-character" is specified, the first font that has a glyph is adopted.
See also Font Selection. V6.1
font-stretch-mode 6 Specifies whether the information on font-stretch is used when selecting fonts. The following values can be specified.
  1. The information on font-stretch will not be used. The operation is the same as AH Formatter V5.
  2. The information on font-stretch will be used.
See also Difference in Formatting with AH Formatter V6.0. V6.1
missing-font 1 Specifies whether to warn when a font is not found from the specified font family. The following either can be specified.
0.No error message will be reported.
1.The level 1 error message will be reported.
2.The level 2 error message will be reported.
missing-glyph 1 Specifies whether to warn when the glyph corresponding to the specified character is not found in the specified font family or the fallback font. The following either can be specified.
0.No error message will be reported.
1.The level 1 error message will be reported.
2.The level 2 error message will be reported.
missing-glyph-all false Usually the report on missing-glyph is given only once to the same character. However, by specifying missing-glyph-all="true", the report can be given to all. Please note that careless specification could cause huge amount of error. This setting is similarly applied to fallback-glyph as well.
use-windows-api false Specifies true when you want to use Windows API with the Windows version, without using the original API for the acquisition of the font information. Since Windows API and the original API are not completely the same, some difference may occur in the formatted result. Effective only with the Windows version. If false is specified, the setting of <formatter-serrings WindowsFontAPI> is invalid.
<script-font> child of <font-settings> script Specifies the script codes for multilingual setting. The available scripts conform to ISO 15924. However, the AH Formatter V6.1 does not support all scripts. The following scripts can be specified here.
  • Latn : Latin
  • Grek : Greek
  • Cyrl : Cyrillic
  • Arab : Arabic
  • Hebr : Hebrew
  • Deva : Devanagari
  • Beng : Bengali V6.1
  • Guru : Gurmukhi V6.1
  • Gujr : Gujarati V6.1
  • Orya : Oriya V6.1
  • Taml : Tamil V6.1
  • Telu : Telugu V6.1
  • Knda : Kannada V6.1
  • Mlym : Malayalam V6.1
  • Thai : Thai
  • Khmr : Khmer V6.1
  • Laoo : Lao V6.1
  • Hang : Hangul
  • Hans : Han (Chinese Simplified)
  • Hant : Han (Chinese Traditional)
  • Jpan : Japanese (Han+Hira+Kana)
  • Hrkt : Hiragana+Katakana
For generic fonts you may omit the setting of the script or specifyas script=".".
serif Specifies the generic serif font when specified by the script.
sans-serif Specifies the generic sans-serif font when specified by the script.
monospace Specifies the generic monospace font when specified by the script.
cursive Specifies the generic cursive font when specified by the script.
fantasy Specifies the generic font for fantasy when specified by the script.
fallback Specifies the fall back font of the script specified by script. Two or more fonts can be enumerated by comma separated values.
<font-alias> child of <font-settings> src Formats the font name src (source) appearing in FO (or HTML etc.) by replacing with dst (destination). This is achieved by specifying an arbitrary font name for src and dst. This makes it possible to substitute an unknown font in a document made in a different environment, without modifying the document. However, in the following sample,
<font-alias src="A" dst="B">
<font-alias src="B" dst="C">
"A" would never be replaced with "C". Moreover, the setting for <font-alias> doesn't affect the font name in the Option file.
dst

PDF Output Settings

These settings are used for PDF Output.

Element Location Attribute Default Description
<pdf-settings> child of <formatter-config> convert-colorspace true If the value is true, RGB images are converted into CMYK images automatically when outputting PDF/X, PDF/A. This setting is not effective with AH Formatter V6.1 Lite.
default-output-intent #OutputConditionIdentifier​=​CGATS TR 001 Sets the default value when the output intent is not specified in FO while outputting PDF/X. Values that can be specified are equal to the ones that can be specified to the src property for fo:color-profile. See also PDF/X
embed-all-fonts false Specifies whether to embed the all fonts in PDF or not with one of the following values, which are embeddable fonts in the formatted result.
  • false
  • true
  • base14
If the value is false, only fonts specified in <embed-font> are embedded. If the value is true, all fonts that can be embedded except Standard 14 Fonts will be embedded. If the value is base14, all fonts including Standard 14 Fonts that can be embedded will be embedded.
embed-font-encoding Specifies the encoding when the TrueType font is embedded. When nothing is specified, Identity-H/V is the default.
  • WinAnsiEncoding
    Specifies WinAnsiEncoding for encoding. If WinAnsiEncoding cannot be specified, Identity-H/V is considered as specified.
embed-std-output-intent false Specifies whether to embed the ICC color profile specified for the standard output intent into PDF/X output. It is necessary to specify the actual file of the ICC color profile when embedding it. If false is specified, it is not embedded. This setting is invalid when outputting PDF/A because the embedding of the color profile is indispensable with PDF/A or PDF/X-4 output. Also it's not available to specify the output intent to the PDF versions other than PDF/X, PDF/A according to the PDF specification.
embed-subset-font-percentage 100 Finds the percent of the character used in PDF against the entire characters that the font has. When the percent of characters used is greater than or equal to the specified value, embeds all font characters including characters not used. If not, embeds only characters that are actually used.
encryption-level 128rc4 Specifies the key length when encrypting the PDF file.
  • 40rc4
  • 128rc4 (Effective with PDF1.4 or later)
  • 128aes (Effective with PDF1.5 or later)
  • 256aes (Effective with PDF1.7 or later)
EPS-processor none Specifies whether to output PDF after changing into PDF using an external processor when outputting EPS to PDF in the formatted result.
  • none
  • distiller
  • ghostscript
These have the following meanings.
  • none : Use nothing. The same way in the past.
  • distiller : Use Adobe Distiller in the environment where Adobe Distiller is installed. acrodist.exe is used. Effective only with the Windows version. EPS support at this time has a little restrictions.
    • PS-Adobe-2.0 or later required.
    • %%BeginProlog and %%EndProlog should be included.
    joboptions
  • ghostscript : Use Ghostscript in the environment where Ghostscript is installed. Use gswin32c.exe with the Windows version and use gs with non-Windows. Since the program is invoked by fork() etc. and used, there is no problem with GPL license. The operation is tested with AFPL Ghostscript 8.54.
    ghostscript
Invalid in the environment where each processor is not installed. Moreover, it’s necessary to set the PATH etc. of the program to use. The value is case-insensitive.
error-on-embed-fault true When an error occurs while embedding fonts, specifies whether to stop the job as an error or to continue embedding by replacing the character with a white space using the value of true or false. If the value is true, stops executing as an error. If the value is false, continues executing and outputs PDF by replacing the character with a white space.
error-on-missing-glyph false When the corresponding glyph for the specified character does not exist in the specified font, specifies whether to break off the processing as an error or to continue the processing by using true or false. When true is specified, the processing will end as an error. When false is specified, although PDF is outputted, the character will be displayed as a white space or a small box in PDF for missing glyph.
error-on-pdfx-fault true Specifies whether to stop formatting as an error or ignore the unsuitable content and continue formatting when a content which is unsuitable for PDF/X or PDF/A is detected while creating PDF/X or PDF/A, such like PDF/X or PDF/A that contains non-embeddable fonts. If false is specified, the processing is continued, a generated PDF may be incongruent as PDF/X or PDF/A. If true is specified, PDF will not be generated as an error. When the unsuitable content is avoidable, the formatting continues. For example, annotations in PDF/X are thrown away. When an incongruent image is specified, the processing of an image differ by false or true. If false is specified, an image will be embedded as is, a generated PDF may be incongruent as PDF/X or PDF/A. When true is specified, the image format, the color space, etc. will be changed to make it suit. Note that the color may be changed in this case. no-LT
ghostscript When converting EPS into PDF using Ghostscript, the full path to Ghostscript can be specified. For example, specify as follows; ghostscript="/usr/local/bin/gs." Thereby, Ghostscript can be invoked even if the PATH does not set to Ghostscript. Specify gswin32c.exe in Windows version.
gif-pass-through true GIF image can be embedded into PDF directly. However the I/O error might occur if that PDF is printed on the PostScript printer. Please specify false when you want to avoid this.
grayscale-compression auto When the grayscale image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
  • auto
  • jpeg
  • zlib
  • jpeg2000
  • keeplzw
When auto is selected, the process is automatically done and creates the image data according to the setting of grayscale-jpeg-quality and rasterize-resolution. When keeplzw is specified, if the original image is LZW compressed, it becomes the LZW compression. If not, it becomes the same as auto. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. See also Image Output to learn about the file formats which can be stored directly in PDF. This is the setting for the grayscale image. Specifies image-compression for the color image, and monochrome-compression for the monochrome image. JPEG2000 is effective only for PDF1.5 or later.
grayscale-downsampling none Specifies the method to downsample the raster grayscale image that is put into PDF. The options are:
  • none
  • average
  • bicubic
  • subsampling
When a value other than none is specified, the image that has resolution larger than the one specified by grayscale-downsampling-above-dpi will be downsampled to the resolution specified by grayscale-downsampling-target-dpi. This is the setting for the grayscale image. Specifies image-downsampling for the color image, and monochrome-downsampling for the monochrome image.
grayscale-downsampling-above-dpi 108
grayscale-downsampling-target-dpi 72
grayscale-jpeg-quality 80 For the grayscale image format that cannot be stored directly in PDF, specifies the image quality by a numerical value within the range of 1-100 when jpeg is specified by grayscale-compression. The higher the number the better the quality in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
This is the setting for the grayscale image. Specifies jpeg-quality for the color image.
gs-add-options When converting EPS into PDF using Ghostscript, AH Formatter V6.1 specifies the following parameters and starts Ghostscript.
-dPDFSETTINGS=/printer
-dNOPAUSE
-dBATCH
-dSAFER
-sDEVICE=pdfwrite
-dDEVICEWIDTHPOINTS=Width
-dDEVICEHEIGHTPOINTS=Height
-dEPSFitPage
-q
-sOutputFile=Temporary Output File
-c
.setpdfwrite
-f Input EPS
An additional parameter can be specified as gs-add-options. The parameters specified here will be added before -q stated above. Two or more parameters can be specified by being separated with U+000A. The operation with an inaccurately specified parameter is not guaranteed.
image-color-profile true Specifies whether to embed in the PDF the color profile of the color image that will be embedded. If the value is true it is embedded. If the value is false it is not embedded.
image-compression auto When the color image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
  • auto
  • jpeg
  • zlib
  • jpeg2000
  • keeplzw
When auto is selected, the process is automatically done and creates the image data according to the setting of jpeg-quality and rasterize-resolution. When keeplzw is specified, if the original image is LZW compressed, it becomes the LZW compression. If not, it becomes the same as auto. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. See also Image Output to learn about the file formats which can be stored directly in PDF. This is the setting for the color image. Specifies grayscale-compression for the grayscale image, and monochrome-compression for the monochrome image. JPEG2000 is effective only for PDF1.5 or later.
image-downsampling none Specifies the method to downsample the raster color image that is put into PDF.
  • none
  • average
  • bicubic
  • subsampling
When a value other than none is specified, the image that has resolution larger than the one specified by image-downsampling-above-dpi will be downsampled to the resolution specified by image-downsampling-target-dpi. This is the setting for the color image. Specifies grayscale-downsampling for the grayscale image, and monochrome-downsampling for the monochrome image.
image-downsampling-above-dpi 108
image-downsampling-target-dpi 72
import-3D-annotation false If the value is true, imports 3D object to PDF. This setting is not available with AH Formatter V6.1 Lite.
import-textmarkup-annotation false If the value is true, imports the following annotations to PDF.
  • Highlight
  • Underline
  • Squiggly
  • StrikeOut
This setting is not available with AH Formatter V6.1 Lite. V6.0MR1
jpeg-quality 80 For the color image format that cannot be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when jpeg is specified by image-compression. The higher the number the better the quality in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: This is not for changing the quality of a JPEG format image.
This is the setting for the color image. Specifies grayscale-jpeg-quality for the grayscale image.
joboptions Specifies Adobe PDF Settings File which is passed to Distiller when converting EPS into PDF using Distiller. Only a local file can be specified. When specifying the relative path, the target EPS file is being considered a relative. However, when EPS itself is a relative path, the operation is instable. Please specify the joboptions with absolute path preferably. Please refer to the manual of Acrobat etc. for Adobe PDF Settings File. The operation when specifying an inaccurate file etc. will not be guaranteed. When this file is not specified, the following contents which are not almost specified at all will be assumed.
<<
  /CompatibilityLevel 1.3
  /AutoRotatePages /None
>> setdistillerparams
<<
>> setpagedevice
Effective only with the Windows version.
linearized false Specifies whether to create linearized PDF. If the value is true, creates linearized PDF that is optimized for Web display. If the value is false, creates normal PDF.
monochrome-compression ccitt4 When the monochrome image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
  • ccitt4
  • ccitt3
  • runlength
  • zlib
  • none
Refer to the Image Output for the image format that can be stored directly in PDF. This is the setting for monochrome images. Specifies image-compression for the color image, and grayscale-compression for the grayscale image.
monochrome-downsampling none Specifies the method to downsample the raster monochrome image that is put into PDF.
  • none
  • average
  • bicubic
  • subsampling
When a value other than none is specified, an image that has resolution larger than the one specified by monochrome-downsampling-above-dpi will be downsampled to the resolution specified by monochrome-downsampling-target-dpi. This is the setting for the monochrome image. Specifies image-downsampling for the color image, and grayscale-downsampling for the grayscale image.
monochrome-downsampling-above-dpi 450
monochrome-downsampling-target-dpi 300
no-accessibility false Specifies whether to permit text access for screen reader devices of PDF files with the value of true or false. If false is specified, it is permitted. If true is specified, it is not permitted. This attribute is effective only when you specify PDF1.4 or later. owner-password is required for the permission settings of text access for screen reader devices to be effective.
no-adding-or-changing-comments false Specifies whether to permit adding or changing comments and form fields in the PDF or not with the value of true or false. If the value is false, permits adding or changing. If the value is true, permits no changes or additions are allowed. owner-password is required for the permission settings of adding or changing comments and form fields to be effective.
no-assemble-doc false Specifies whether to permit inserting, deleting and rotating of PDF pages with the value of true or false. If false is specified, it is permitted. If true is specified, it is not permitted. This attribute is effective only when you specify PDF1.4 or later. owner-password is required for the permission settings of inserting, deleting and rotating of PDF pages to be effective.
no-changing false Specifies whether or not to permit making form field and making other changes in the PDF file or not with the value of true or false. If the value is false, changes are permitted. If the value is true, no changes are permitted. owner-password is required for the permission settings of making form field and making other changes to be effective.
no-content-copying false Specifies whether to permit copying the text and the graphics in PDF or not with the value of true or false. If the value is false, permits copying. If the value is true, permits no copying. owner-password is required for the permission settings of copying the text and the graphics to be effective.
no-fill-form false Specifies whether to permit filling in of form fields and signing of the PDF file with the value of true or false. If false is specified, it is permitted. If true is specified, it is not permitted. This attribute is effective only when you specify PDF1.4 or later. owner-password is required for the permission settings of filling in of form fields and signing to be effective.
object-compression false Compresses the object in PDF. It is effective with PDF1.5 or later and text-and-lineart-compression="true" is specified. If true is specified, the object will be compressed, if false is specified, it will not be compressed.
owner-password Sets the strings specified as a master password. Specify the strings up to 32bytes. The characters with the code in the range of 0x20 to 0x7E, 0xA1 to 0xDF are effective. If the characters other than the above are included, it becomes invalid and no password is set. The default value is no-password.
CAUTION: The password is described in plaintext in the file. Please use care in managing the file.
page-labels true Specifies whether to apply the page labels to the page numbers with the value of true or false. If true is specified the page labels are applied, if false is specified, they are not applied.
pdf-version PDF1.4 Specifies the version of the PDF to create with one of the following values.
  • PDF1.3
  • PDF1.4
  • PDF1.5
  • PDF1.6
  • PDF1.7
  • PDF/X-1a:2001 no-LT
  • PDF/X-3:2002 no-LT
  • PDF/X-1a:2003 no-LT
  • PDF/X-2:2003 no-LT
  • PDF/X-3:2003 no-LT
  • PDF/X-4:2008 V6.1 no-LT
  • PDF/A-1a:2005 no-LT
  • PDF/A-1b:2005 no-LT
PDF/X or PDF/A cannot be selected with AH Formatter V6.1 Lite.
printing-allowed high-resolution Specifies whether to print the resulting PDF file or not. If high-resolution is specified, it allows to printing in high resolution. low-resolution is effective with PDF1.4 or later. If low-resolution is specified, it allows printing in low resolution. If the PDF version is 1.3, it is handled as hi-resolution. If none is specified, it does not allow printing. owner-password is required for the permission settings of printing the PDF file to be effective.
rasterize-resolution 108 If part of a vector image is transformed to a raster image and stored in the PDF. Specifies the value of the rasterize-resolution of the transformed raster images in the range from 70 to 500(dpi). This setting is effective only with Windows version. The vector format image which cannot be stored directly in PDF is not supported with non-Windows version. See also Image Output to learn about the file formats which can be stored directly in PDF.
reverse-page false If the value is true, outputs pages in reverse order to PDF.
rgb-conversion none Specifies how to convert the RGB color space to DeviceGray.
  • none
    Does no conversion. DeviceRGB is outputted.
  • black
    Converts Black to DeviceGray, converts the others to DeviceRGB before outputting.
  • gray
    Converts Gray color (mono tone) to DeviceGray, converts the others to DeviceRGB before outputting.
  • all
    Converts the all color spaces to DeviceGray before outputting. This conversion is based on the following formula: gray = 0.3×red + 0.59×green + 0.11×blue (0.0 ≤ red,green,blue ≤ 1.0).
  • cmyk
    Converts the all color spaces to CMYK before outputting.
As for the images other than SVG, MathML, EMF or WMF, which are drawn using their own drawing engine, there is no conversion.
tagged-pdf false Specifies whether to make the Tagged PDF file or not. PDF may not be able to be tagged depending on the PDF versions. In this case this setting will be ignored. no-LT
text-and-lineart-compression true Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not. If the value is true, it is compressed. If the value is false, it is not compressed.
transparency-color-space DeviceRGB Specifies the color space when processing the transparency in PDF. Either of the following can be specified. V6.1
  • None
  • DeviceRGB
  • DeviceCMYK
use-launch-for-relative-uri true Specifies whether the external link (external-destination property) specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties with the value of true or false. If the value is true, it is transformed to 'Open the file'. If the value is false, it is transformed to 'World Wide Web link'.
user-password Sets the strings specified as a user password. Specify the strings up to 32bytes. The characters with the code in the range of 0x20 to 0x7E, 0xA1 to 0xDF are effective. If the characters other than the above are included, it becomes invalid and does not count as a password setting. The default value is no-password.
CAUTION: The password is described in plaintext in the file. Please use care in managing the file.
<embed-font> child of <pdf-settings> font Specifies the fonts which are embedded in the PDF. This element can be specified without limit and is effective only when embed-all-fonts="false" is specified. When embed-all-fonts="false" is specified and this element is not specified, only the glyph of the character which is needed in the PDF output is embedded. When the element is specified and if the font indicated here is used within the formatted results, the glyph of the character currently used will be embedded. For a font which is not specified, embedding is performed only for the glyph of the character which is needed in the PDF output.

PostScript Output Settings

These settings are used for PostScript Output.

Element Location Attribute Default Description
<ps-settings> child of <formatter-config> noembed-font false Specifies whether fonts are embedded in the outputted PostScript. When true is specified, the font information is not embedded and the font must be referred to only by the PostScript name. Followings are restrictions.
  • The PostScript interpreter may not be correctly processed when the font includes a multi-byte code like Japanese, etc. With Distiller, an error like
    MS-Mincho not found and using Courier.
    may be generated.
  • Character-codes greater than 255 cannot be outputted.
When using non-Type1 fonts, it's not recommended to specify noembed-font.
use-launch-for-relative-uri Specifies whether the external link (external-destination property) specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties with the value of true or false. If the value is true, it is transformed to 'Open the file'. If the value is false, it is transformed to 'World Wide Web link'. When nothing is specified, follows the specification of use-launch-for-relative-uri in PDF Output Settings.

SVG Output Settings

These settings are used for SVG Output.

Element Location Attribute Default Description
<svg-settings> child of <formatter-config> copy-image-path Specifies the destination directory to copy images to as specified by "copy-all" or "copy" by image-processing.
copy-image-prefix When images are copied to the directory specified by copy-image-path and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.
embed-all-fonts false By using true or false, specifies whether to embed in the SVG all the outline data of TrueType and Type1 fonts which are not limited to embed among fonts used in the formatted result. If the value is false, only the font specified by <embed-font> is embedded. If the value is true, all fonts that can be embedded are embedded.
error-on-embed-fault true When an error occurs while embedding fonts, specifies whether to stop the job as an error or to continue embedding by replacing the character with a white space using the value of true or false. If the value is true, stops executing as an error. If the value is false, continues executing and outputs SVG by replacing the character with a white space.
format 1 When the formatted result is output to multiple SVG files specified by "false" in singlefile, specifies the format of the additional character string to output to the file name. This character string adopts the character string same as the format property of FO. Each file name is automatically determined based on the output file name. The character string as formatted by the value specified by format will be inserted just before the extension of the output file. For example, if the file name is document.svg, and format="-1" is specified, the file become document-1.svg and document-2.svg and so on.
gzip-compression false If the value is true, creates SVG compressed in gzip format. If the value is false, it is not compressed.
image-conversion auto When the image format to be embedded is a raster image other than JPEG or PNG, it is converted into JPEG or PNG and embedded. The following either can be specified.
  • auto
  • jpeg
  • png
When auto is selected, images of monochrome, grayscale or 256-or-less-color are converted into PNG, and the rest are converted into JPEG.
image-processing embed-all Specifies how to treat the referred image.
  • embed-all
    Embeds all images in the SVG.
  • link
    Links images that have been linked, and embeds the embedded image. Raster images other than JPEG and PNG are always embedded.
  • copy-all
    Copies all image files to the destination that is specified by copy-image-path, and then links.
  • copy
    Copies images that have been linked to the destination that is specified by copy-image-path, and links. The embedded image are embedded.
Refer to Image Output in SVG Output for details of operation.
jpeg-quality 80 For images that cannot be embedded directly in SVG, specifies the image quality by the numerical value within the range of 1-100 when "jpeg" or "auto" is specified by image-conversion. The higher the number the better the quality in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
rename-copy-image false When images are copied to the directory specified by copy-image-path etc. and processed, specifies whether to rename all file name to prefix specified by copy-image-prefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed.
singlefile false Specifies whether the formatted result composed of multiple pages is output as a single SVG file or as multiple SVG files.
If the value is true, outputs as a single SVG file. If the value is false, outputs as multiple SVG files. When multiple files are output, the file is named by the format specified by format.
Effective only when outputting to a file. It is invalid in the output without the file name like the stream etc.
singlefile-number true When singlefile="false" is specified, specifies whether to add sequential number to the output SVG even if it has only one-page. It is not added in case of false.
rasterize-resolution 108 If part of a vector image is transformed to a raster image and stored in the SVG. Specifies the value of the rasterized-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in SVG as vectors without being transformed to raster images. This setting is effective only with Windows version. The vector format image which cannot be stored directly in SVG is not supported with non-Windows version.
svg-version 1.1 Specifies the version of the SVG to create with one of the following values.
  • 1.1
  • Basic
  • Tiny
<embed-font> child of <pdf-settings> font Specifies the fonts which are embedded in the SVG. This element can be specified without limit and is effective only when embed-all-fonts="false" is specified. When embed-all-fonts="false" is specified and this element is not specified, only the outline of the glyph of the character which is needed in the SVG output is embedded. When the element is specified and if the font indicated here is used within the formatted results, the outline of the glyph of the character currently used will be embedded. For a font which is not specified, embedding is performed only for the glyph of the character which is needed in the SVG output.

INX Output Settings

These settings are used for INX Output.

Element Location Attribute Default Description
<inx-settings> child of <formatter-config> output-mode text Specify how to generate the text frame of InDesign® from text.
  • text
    Text frame is generated from each text area. This mode can convert most closely to the formatting result. It is sometimes difficult to edit the result using InDesign®.
  • line
    Text frame is generated from each line area.
  • block
    Text frame is generated from each block area. It is easy to edit the result using InDesign®. Instead the conversion precision is lost at expense.

MIF Output Settings

These settings are used for MIF Output.

Element Location Attribute Default Description
<mif-settings> child of <formatter-config> output-mode text Specify how to generate the ParaLine of FrameMaker® from text.
  • text
    ParaLine is generated from each text area. This mode can convert most closely to the formatting result. It is sometimes difficult to edit the result using FrameMaker®.
  • line
    ParaLine is generated from each line area.
  • block
    ParaLine is generated from each block area. It is easy to edit the result using FrameMaker®. Instead the conversion precision is lost at expense.
image-processing embed Specifies how to treat the referred image.
  • embed
    Embeds all images in the MIF.
  • link
    Links images as external files.
char-units pt Specifies a value of CharUnits used as a unit of fontsize etc.
  • pt
  • q
units in Specifies a value of Units used as a unit of display.
  • in
  • cm
  • mm
  • pt
  • pc
  • dd
  • cc

TEXT Output Settings

These settings are used for TEXT Output. These settings are not effective with AH Formatter V6.1 Lite. no-LT

Element Location Attribute Default Description
<text-settings> child of <formatter-config> encoding UTF-8 Specifies the encoding of the output text. The following encodings are available. They are not case sensitive.
  • UTF-8
  • UTF-16
  • UTF-16BE
  • UTF-16LE
  • UTF-32
  • UTF-32BE
  • UTF-32LE
  • ISO-10646-UCS-2
  • ISO-10646-UCS-4
  • ANSI_X3.4
  • ISO_646.irv
  • ISO646-US
  • US-ASCII
  • ISO_8859-1
  • latin1
  • Windows-31J
  • Shift_JIS
  • EUC-JP
  • ISO-2022-JP
Endian of UTF-16, UTF-32 etc. depends on the processor in the operating system.
eol-marker CRLF or LF Specifies the linefeed code of the output text. The followings can be specified. They are not case sensitive.
  • CRLF
  • LF
  • CR
The default value is CRLF in Windows, LF in others.

MathML Settings

These settings are used for MathML.

Element Location Attribute Default Description
<mathml-settings> child of <formatter-config> mode STIX You can specify the MathML rendering method by either of the following. (case insensitive) V6.1
  • STIX

    Makes adjustment suitable for STIX fonts in this mode. STIX fonts are free fonts for math expressions. You can download them from STIX Fonts Project Website. This setting is equivalent to the following settings:

    mode="font-specified"
    fontfamily="STIXGeneral"
    

    If something is specified to fontfamily, it will be ignored.

  • font-specified

    Performs rendering using the font family specified to fontfamily.

  • v60-compatible

    Performs rendering in AH Formatter V6.0 compatibility mode. See also the documentation of AH Formatter V6.0 for settings. All descriptions about MathML settings written here will be invalid.

fontfamily You can specify a font family to use with MathML. The font family specified here will be added to the head of the font family specified in the higher level (FO or HTML) and will be used for the selection of a font. V6.1
<math> child of <mathml-settings> small 0.8 Specifies the font size in units of em when mathsize="small" is specified.
normal 1.0 Specifies the font size in units of em when mathsize="normal" is specified.
big 1.25 Specifies the font size in units of em when mathsize="big" is specified.
<mfrac> child of <mathml-settings> bar-width 0.02 Specifies the form of the fraction. All the values should be in units of em.
numerator-space 0.1
denominator-space 0.1
bar-lspace 0.1
bar-rspace 0.1
bar-padding 0.1
thin 0.6 Specifies the bar width when linethickness="thin" is specified by the ratio against bar-width.
medium 1.0 Specifies the bar width when linethickness="medium" is specified by the ratio against bar-width.
thick 1.7 Specifies the bar width when linethickness="thick" is specified by the ratio against bar-width.
<mroot> child of <mathml-settings> padding-left 0.0 Specifies the position of the base part and index part against the root sign.
padding-right 0.0
padding-top 0.1
padding-bottom 0.0
index-rspace 0.1
index-shift 0.1
root-pos1.x 0.0 Specifies the form of root sign. The height values (*.y) should be specified by the ratio against the height of the area (= 'the height of the base part' + 'padding-top'+ 'padding-bottom'). Other values are specified by units of em.
root-pos1.y 0.4
root-pos2.x 0.1
root-pos2.y 0.5
root-pos3.x 0.3
root-pos3.y 0.1
root-pos4.x 0.6
root-pos4.y 0.1
root-width1 0.02
root-width2 0.1
root-width3 0.03
root-width4 0.03
<mscript> child of <mathml-settings> script-rspace 0.02 Specifies the space between the base character and subscript of the <msup> <msub> <msubsup> <mmultiscripts> elements in units of em.
script-rspace2 0.01
script-lspace 0.02
script-lspace2 0.01
<mtable> child of <mathml-settings> border-width 0.04 Specifies the border width of <mtable> in units of em.

XSLT Settings

These settings are used for XSLT Processor.

Element Location Attribute Default Description
<xslt-settings> child of <formatter-config> msxml true Specifies whether to use MSXML or not. If true is specified, MSXML is used as an XSLT Processor. Specification of command is disregarded at this time. If false is specified, the external XSLT Processor specified from command will be used, but when nothing is specified from command, it is considered that true is specified and MSXML is used. The version of MSXML actually used can be checked on the XSLT page of the Format Option Setting Dialog. This setting is ignored in non-Windows environment.
command The command line of the External XSLT Processor is specified here. The command line strings must include at least three identifiers, %1, %2 and %3.
  • %1 : XML document
  • %2 : XSL stylesheet
  • %3 : XSLT Output File
  • %param : Parameter of xsl:param
If nothing is specified, or "@MSXML" is specified, the external processor is not used but the internal processor, MSXML is used. This setting is effective only with Windows version. It's an initial setting of XSLT Processor with all kinds of interfaces. If nothing is specified in non-Windows environment, XSLT transformation is not performed.
param-option Specifies the parameter type of xsl:param given to the external XSLT Processor. The strings must include at least two identifiers, %p and %v. These values are as follows:
  • %p : Value of <param name>
  • %v : Value of <param value>
These values affect the part of %param in the command line strings. When two or more <param>s are specified, they are divided by the white space and repeated.
<param> child of <xslt-settings> name Specifies the parameter name of xsl:param for XSLT Processor.
value Specifies the parameter value of xsl:param for XSLT Processor. When the value includes a white space, please explicitly enclose in quotation marks.
<stylesheet> child of <xslt-settings> ns Possible to specify the stylesheet applied to a specific XML document. Specifies the name space of the XML document by ns, and specifies the URI of the stylesheet by href. The following shows the example of XHTML and WordML.
<stylesheet ns="http://www.w3.org/1999/xhtml" href="xhtml2fo.xsl"/>
<stylesheet ns="http://schemas.microsoft.com/office/word/2003/wordml" href="[WordMLToFO install directory]/WordMLToFO.xsl"/>
If the XML document has the name space specified here, it can be formatted by itself, without specifying the stylesheet. If the stylesheet is specified when formatting or the stylesheet is specified in the XML document, these are adopted and the setting here will be ignored.
href

Suppose XSLT setting is as follows:

<xslt-settings command="xslt -o &#34;%3&#34; &#34;%1&#34; &#34;%2&#34; %param" param-option="%p=%v">
  <param name="foo" value="123"/>
  <param name="bar" value="&#34;Hello, World&#34;"/>
</xslt-settings>

XSLT Processor executes as follows in order to transform file.xml and file.xsl into file.fo.

xslt -o "file.fo" "file.xml" "file.xsl" foo=123 bar="Hello, World"

As described in the example here, the actual file name given to %1 or %2 includes white space, it's necessary to enclose the file name with quotation mark, &#34;.

Example for Option Setting File

<?xml version="1.0"?>
<formatter-config>
  <formatter-settings
      default-page-width="210mm"
      default-page-height="297mm"
      default-font-size="10pt"
      normal-line-height="1.2"
      default-color="#000000"
      border-thin-width="1pt"
      border-medium-width="3pt"
      border-thick-width="5pt"
      pxpi="96"
      default-lang=""
      default-CJK="ja"
      punctuation-trim="true"
      text-autospace="true"
      vertical-underline-side="auto"
      punctuation-spacing="0.5"
      text-autospace-width="0.25"/>
  <pdf-settings
      embed-all-fonts="false"
      error-on-embed-fault="false"
      user-password=""
      master-password=""
      no-printing="false"
      no-changing="false"
      no-content-copying="false"
      no-adding-or-changing-comments="false"
      image-compression="auto"
      jpeg-quality="80"
      text-and-lineart-compression="true"
      use-launch-for-relative-uri="true"
      rasterize-resolution="108">
    <embed-font font="Arial"/>
    <embed-font font="Courier New"/>
  </pdf-settings>
  <font-settings default-font-family="serif">
    <script-font
      serif="Times New Roman"
      sans-serif="Arial"
      monospace="Courier New"
      cursive="Times New Roman"
      fantasy="Times New Roman"/>
    <script-font
      script="jpn"
      serif="MS Mincho"
      sans-serif="MS Gothic"
      monospace="MS Mincho"/>
    <script-font
      script="kor"
      serif="Batang"
      sans-serif="Gulim"
      monospace="BatangChe"/>
    <script-font
      script="zho-CN"
      serif="SimSun"
      sans-serif="SimHei"
      monospace="SimSun"/>
    <script-font
      script="zho-TW"
      serif="MingLiU"
      sans-serif="MingLiU"
      monospace="MingLiU"/>
  </font-settings>
  <xslt-settings command="xslt -o &#34;%3&#34; &#34;%1&#34; &#34;%2&#34; %param"
                 param-option="%p=%v">
    <param name="foo" value="123"/>
    <param name="bar" value="XYZ"/>
  </xslt-settings>
</formatter-config>