XSL Extensions

Specifies how to include bookmarks in multi separate volume. no-LT

Values have the following meanings.

first

Adds a bookmark to the first separate volume.

all

Adds bookmarks to all the separate volumes.

separate

Adds each bookmark to each separate volume. Bookmarks are added to the volume where axf:outline-level="1" appears. The bookmark that goes across the volume is added to the previous volume. For that reason, the external link to the other volume may be included even though axf:bookmark-include="separate" is specified.

This property is not available with AH Formatter V5.0 Lite.

Specifies the initial volume number in multi separate volume. no-LT

This value is applied for the format property and utilized for the PDF file name to output. In the following example, the file name of the separate volume is document-2.pdf, document-3.pdf, document-4.pdf,...

<axf:output-volume-info
  initial-volume-number="2"
  format="-1"
/>

This property is not available with AH Formatter V5.0 Lite.

Separates the file in multi volume. no-LT

Values have the following meanings.

true

Separates the volume newly from this fo:page-sequence.

false

Do not separates the volume newly from this fo:page-sequence.

Specifies axf:output-volume-break="true" to fo:page-sequence where you want to start separating the volume. The document number increases one by one. When separating the volume, axf:output-volume-break="true" is regarded as always being specified to the first fo:page-sequence. If axf:output-volume-break="false" is specified explicitly, it is ignored.

This property is not available with AH Formatter V5.0 Lite.

Specifies the document file name in multi separate volume. no-LT

If nothing specified, the automatic file name using the format property is adopted. If this property is specified, the specified name is adopted. This property is effective only with the top fo:page-sequence or with the fo:page-sequence where axf:output-volume-break="true" is specified.

In the following example, suppose that if document.pdf is specified as the file name of the PDF output, the separated file names will be document-2.pdf, chapterX.pdf, document-4.pdf,...

<axf:output-volume-info
  initial-volume-number="2"
  format="-1"
/>

<fo:page-sequence>
  ...
</fo:page-sequence>
<fo:page-sequence axf:output-volume-break="true" axf:output-volume-filename="ChapterX.pdf">
  ...
</fo:page-sequence>
<fo:page-sequence axf:output-volume-break="true">
  ...
</fo:page-sequence>

The original PDF file name cannot be omitted even though axf:output-volume-filename is specified to all the fo:page-sequence. This property is not available with AH Formatter V5.0 Lite.

Specifies the language code (RFC3066). It is not possible to omit it.

Specifies the amount of space. Specification is invalid when 0 or less.

Values have the following meanings.

figure

Indicates the same amount as U+2007.

punctuation

Indicates the same amount as U+2008.

thin

Indicates the same amount as U+2009.

hair

Indicates the same amount as U+200A.

Specifies the code point to be applied.

language and space are applied to all the specified code points.

The axf:outline-expand specifies whether to display the lower hierarchy of bookmark items or not.

True specifies to display the lower hierarchy in the expanded state. False specifies to display in the collapsed state.

The axf:outline-group groups bookmark items, and outputs them collectively.

If this property is omitted or specifies empty string, bookmark items are not grouped. If this specifies any string, the string is used as the name of group. The group with the same name is outputted collectively. The non-grouped bookmark is outputted as the group without the group name.

The axf:outline-level indicates the hierarchy level of bookmark items.

The <number> must be a non-negative integer. Initial value is zero and it means that bookmarks should not be created. The highest level of bookmarks is 1 and it becomes 2 or more according to the hierarchy level of the bookmarks.

The axf:outline-title specifies the string which appears as a title of bookmarks.

If this property is omitted or has an empty string, the text of the object to which the property is added will become the title. In other words, the following two samples create the same bookmark.

The axf:outline-color specifies the color which appears as a title of bookmarks. no-LT

This property is effective with PDF 1.4 or later. This property is not available with AH Formatter V5.0 Lite.

The axf:outline-font-style specifies the font style which appears as a title of bookmarks. no-LT

Values have the following meanings.

normal

Specifies normal style.

italic

Specifies italic.

This property is effective with PDF 1.4 or later. This property is not available with AH Formatter V5.0 Lite.

The axf:outline-font-weight specifies the font weight which appears as a title of bookmarks. no-LT

Values have the following meanings.

normal

Specifies normal weight.

bold

Specifies bold weight.

This property is effective with PDF 1.4 or later. This property is not available with AH Formatter V5.0 Lite.

• These three object properties have to be created in block areas or inline areas. (fo:block, fo:inline ...) If you specify them in an fo:wrapper, for example, they are not effective.
• When the language is not supported in Acrobat and the font that belongs to the unsupported language is specified for the bookmark, there may be a possibility of the font displaying incorrectly in Adobe Acrobat or Reader.

Specifies the action of external link or form action.

Values have the following meanings.

gotor

Opens the link destination by the "GoToR" action as PDF. The URI of the destination is regarded as PDF.

launch

Opens the link destination by the "Launch" action as the file.

uri

Opens the link destination by the "URI" action as URI (World Wide Web).

reset no-LT

Resets a form filed as a form action and can be specified to axf:form-field.

submit no-LT

Submits a form filed as a form action and can be specified to axf:form-field.

auto

Dependent on the system setting.

When the link destination is not a local file, such as http:, the action type is "URI" at any time. When axf:action-type="auto" specified, the external link specified by the relative address is transformed into either 'Open the file' or 'World Wide Web link' by the use-launch-for-relative-uri property in PDF Output Setting. The external link specified by the absolute address is always transformed into 'World Wide Web link'.

Specifies the type of destination for the external link. These are the types of destination for PDF as the external link. no-LT

The destination type has the following options. If nothing specified, it's accounted as axf:destination-type="xyz-top". The case sensitivity is ignored.

This property is not available with AH Formatter V5.0 Lite.

Sets the external link in the PDF bookmark. no-LT

Values have the following meanings.

<uri-specification>

Specifies the URI of the link destination.

This property is not available with AH Formatter V5.0 Lite.

Sets the internal link in the PDF bookmark. no-LT

Values have the following meanings.

<idref>

Specifies the ID of the link destination.

<number-with-fragment>

Specifies the page number of the link destination. This string is simpe numeric characters or the following string that combines numeric characters and a fragment with #. Refer to Making Link for the fragment.

123#zoom=50

The page number also can be specified in the fragment.

#page=123&zoom=50

When the page number is not specified, it is usually regarded as the 1st page. However, when the top position is specified, it is regarded as the head of the page of a block where axf:outline-internal-destination is contained. For example, it is specified as follows.

#view=fit
#view=fith
#zoom=,,0

This property is not available with AH Formatter V5.0 Lite.

When specifying the ID in the external link, the type of the destination should be given to the ID of the link destination. Nameddest is only effective as the parameter in the URI. The type of the destination can be specified to the link destination.

• Link origin:

  <fo:basic-link external-destination="http://mydocs/doc.pdf#nameddest=Chapter6"
                 axf:action-type="gotor">
  

• Link destination:

  <fo:block id="Chapter6" axf:destination-type="xxxx">
  

When specifying the ID in the internal link, the type of the destination should be given to the ID of the link destination as well as the external link.

• Link origin:

  <fo:basic-link internal-destination="Chapter6">
  

• Link destination:

  <fo:block id="Chapter6" axf:destination-type="xxxx">
  

The page number can be accounted by the page parameter in the URI. If both page and nameddest are specified, nameddest takes priority. When specifying the page number, the destination information cannot be set to the link destination. Therefore the type of the destination is given by reading the parameter in the URI. The unreadable parameter is discarded.

<fo:basic-link external-destination="http://mydocs/doc.pdf#page=72&amp;view=fitH,100"
               axf:action-type="gotor">

When neither page nor nameddest are included in the parameter of the URI, it's accounted as page=1. The page number is accounted as physical in PDF.

Adds extension in order to specify the page number to the value of internal-destination.

<fo:basic-link internal-destination="72">

The type of the destination can be specified by adding the parameter of the external link URI.

<fo:basic-link internal-destination="72#view=fitH,100">

The page number is accounted as physical in PDF. If only the page number is specified, the type of the destination is accounted as view=fit.

Specify the axf:outline-external-destination property as follows in order to specify the external link to the bookmark.

<fo:block axf:outline-level="1"
          axf:outline-title="Chapter 6"
          axf:outline-external-destination="http://mydocs/doc.pdf#nameddest=Chapter6"
          axf:action-type="gotor"
          show-destination="new">

At that time, this bookmark becomes independent of the block such as fo:block, etc., which the bookmark belongs to.

Specify the axf:outline-internal-destination property as follows in order to specify the internal link to the bookmark.

<fo:block axf:outline-level="1"
          axf:outline-title="Chapter 6"
          axf:outline-internal-destination="Chapter6">

At that time, this bookmark becomes independent of the block such as fo:block, etc., which the bookmark belongs to.

• Specify either internal-destination or external-destination.
• There may be a case that an internal link is accounted as an external link when separating the volume. At that time, the action type of the link is accounted as axf:action-type="gotor".

Specifies the type of the annotation. no-LT

Any of the following types of the annotation can be specified.

• Empty string

  No annotations.

• "Text"

  Text annotation.

• "FreeText"

  Free text annotation.

• "Stamp"

  Rubber stamp annotation.

• "FileAttachment"

  File attachment annotation.

Charcter strings are case insensitive.

This property is not available with AH Formatter V5.0 Lite.

Specifies the title of the annotation. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies the content of the annotation. no-LT

Specifies the character strings to be displayed when any of the following types of the annotations (axf:annotation-type) is specified.

• "Text"
• "FreeText"
• "Stamp"
• "FileAttachment"

This property is not available with AH Formatter V5.0 Lite.

Specifies the color used for the background of the annotation. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies the flag of the annotation. no-LT

Specifies the following character sequences by enumlating using the white space. They are case insensitive.

• Invisible
• Hidden
• Print
• NoZoom
• NoRotate
• NoView
• ReadOnly
• Locked
• ToggleNoView

See also "PDF Reference" to learn more.

This property is not available with AH Formatter V5.0 Lite.

Specifies the initial state of the annotation. no-LT

Specifies whether it is displayed in the open state when the type of the annotation (axf:annotation-type) is as follows.

• "Text"

Values have the following meanings.

true

Displays the annotation in the open state.

false

Displays the annotation in the closed state.

This property is not available with AH Formatter V5.0 Lite.

Specifies the name of the icon used for displaying the annotation. no-LT

Although arbitrary name can be specified for the icon used for the display of annotations, whether it can be displayed or not depends on the viewer application of a document. The annotation type (axf:annotation-type) snows the standard name which can be specified.

• "Text"

  Standard names are as follows:

  • "Comment"
  • "Help"
  • "Insert"
  • "Key"
  • "NewParagraph"
  • "Note"
  • "Paragraph"

  Empty string is regarded as "None".

• "Stamp"

  Standard names are as follows:

  • "Approved"
  • "AsIs"
  • "Confidential"
  • "Departmental"
  • "Draft"
  • "Experimental"
  • "Expired"
  • "Final"
  • "ForComment"
  • "ForPublicRelease"
  • "NotApproved"
  • "NotForPublicRelease"
  • "Sold"
  • "TopSecret"

  Empty string is regarded as "Draft".

• "FileAttachment"

  Standard names are as follows:

  • "Graph"
  • "Paperclip"
  • "PushPin"
  • "Tag"

  Empty string is regarded as "PushPin".

This property is not available with AH Formatter V5.0 Lite.

Specifies the horizontal position of the annotation. no-LT

The position specified is the distance from the left edge of the region and is used for the position of pop-up or icons and the position of rubber stamp annotations.

This property is not available with AH Formatter V5.0 Lite.

Specifies the vertical position of the annotation. no-LT

The position specified is the distance from the top edge of the region and is used for the position of pop-up or icons and the position of rubber stamp annotations.

This property is not available with AH Formatter V5.0 Lite.

Specifies the width of the annotation. no-LT

This property is used for the width of pop-up and the width of rubber stamp annotations.

This property is not available with AH Formatter V5.0 Lite.

Specifies the height of the annotation. no-LT

This property is used for the height of pop-up and the height of rubber stamp annotations.

This property is not available with AH Formatter V5.0 Lite.

Specifies the font family of the free text annotation. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies the font size of the free text annotation. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies the font weight of the free text annotation. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies whether to make the font of the free text annotation italic. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies the color of the free text annotation. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies the alignment of the free text annotation. no-LT

This property is not available with AH Formatter V5.0 Lite.

Specifies the file with which file attachment annotation is related. no-LT

This property is not available with AH Formatter V5.0 Lite.

Common Usage:

Encloses the unit of the form action. no-LT

Areas:

Generates and returns a block-area.

Contents:

( %block; )*

Common Usage:

Generates a form field. no-LT

Areas:

Generates and returns a single normal inline-area.

Contents:

( axf:form-field-option )*

Common Usage:

Specifies the component elements of the list box, combo box. no-LT

Areas:

No areas generated.

Contents:

( #PCDATA )*

Specifies the field type. no-LT

Values have the following meanings.

text

Specifies the text field.

button

Specifies the push button field.

checkbox

Specifies the check box field

radio

Specifies the radio button field

listbox

Specifies the list box field

combobox

Specifies the combo box field

signature

Specifies the digital signature field

Specifies the field name. no-LT

Specifies the descriptive text of the filed. no-LT

Specified the value used when submitting a form field, etc. no-LT

Specifies whether the field is read-only or not. no-LT

Values have the following meanings.

true

The field is read-only.

false

The field is not read-only.

Specifies whether the filed is enter-required or not. no-LT

Values have the following meanings.

true

The filed is enter-required.

false

The filed is not enter-required.

Specifies the text entered into the text field from the beginning. no-LT

Specifies whether the text field is a single-line enterable field or a multi-line enterable field. no-LT

Values have the following meanings.

false

The text field is a single-line enterable field.

true

The text field is a multi-line enterable field.

Specifies whether the text field is scrollable or not. no-LT

Values have the following meanings.

false

The text field is not scrollable.

true

The text field is scrollable.

Specifies whether the text field requires the password or not. no-LT

Values have the following meanings.

false

The text field does not require the password.

true

The text field requires the password. Entered characters are shown as *, etc.

Specifies the maximum number of characters which can be entered into the text field. no-LT

When 0 or less is specified, the number of characters is not limited.

Specifies the positioning between the caption and icon displayed in the push button field. no-LT

Values have the following meanings.

caption

Only a caption is displayed on the button. An icon is not displayed.

icon

Only an icon is displayed on the button. A caption is not displayed.

caption-below-icon

A caption is displayed under the icon.

caption-above-icon

A caption is displayed on top of the icon.

icon-caption

A caption is displayed on the right side of the icon.

caption-icon

A caption is displayed on the left side of the icon.

caption-over-icon

A caption is displayed on the icon in piles.

Specifies the caption displayed in the push button field. no-LT

Specifies the icon displayed in the push button field. no-LT

Specifies the caption displayed in the push button field. no-LT

Specifies the icon displayed when pressing the push button. no-LT

Specifies the caption displayed when rolling over the push button. no-LT

Specifies the icon displayed when rolling over the push button. no-LT

Specifies the initial state of the check box and the radio button. no-LT

Values have the following meanings.

false

The initial state is unchecked.

true

The initial state is checked.

Specifies the style of the check box and the radio button. no-LT

Specifies the first selected item in the list box, combo box. no-LT

The specified value indicates what number of <axf:form-field-option> it is. The beginning number is 1. When less that 1 is specified or the specified number exceeds the number of elements contained, the value is regarded as 1.

Specifies whether multiple items can be chosen in the list box. no-LT

Values have the following meanings.

false

Multiple items cannot be chosen.

true

Multiple items can be chosen.

Specifies whether the value can be edited with the combo box. no-LT

Values have the following meanings.

false

The value cannot be edited.

true

The value can be edited.

Specifies whether to apply a signature in the signature field. no-LT

Values have the following meanings.

true

Applies a signature in the signature field in PDF.

false

Does not apply a signature in the signature field in PDF.

The signature field can be specified automatically when generating PDF. See also Digital Signature in the PDF page for more details.

Specifies the way to send the information when submitting a form field. no-LT

Values have the following meanings.

get

Sends out a form as GET request.

post

Sends out a form as POST request.

Specified whether to send out the coordinates of the mouse when submitting a form field. no-LT

Values have the following meanings.

false

Does not send out the coordinates.

true

Sends out the coordinates.

Text field can be specified by field-type="text". The contents are empty. Whether it is a single line or not depends on the setting of field-multiline.

<axf:form-field
     field-type="text"
     field-default-text="TEXT"
     field-multiline="false"
     field-scroll="false"
     field-password="true"
     field-maxlen="100"
/>

The contents of field-default-text are not displayed in GUI.

Push Button field can be specified by field-type="button". The contents are empty. The Push button is usually an object used to perform an action.

<axf:form-field
     field-type="button"
     field-button-layout="caption"
     field-button-face="TEXT"
     field-button-icon="URI"
     field-button-face-down="DOWN"
     field-button-icon-down="URI"
     field-button-face-rollover="OVER"
     field-button-icon-rollover="URI"
/>

The contents of field-button-face are not displayed in GUI.

Checkbox field can be specified by field-type="checkbox". The contents are empty.

<axf:form-field
     field-type="checkbox"
     field-checked="true"
     field-checked-style="checkmark"
/>

The status of field-checked="true" are not displayed in GUI.

Radio Button field can be specified by field-type="radio". The contents are empty.

<axf:form-field
     field-type="radio"
     field-checked="true"
     field-checked-style="checkmark"
     field-name="Card"
     field-value="MasterCard"
/>

Radio buttons are usually arranged in groups of two or more. The group is identified as a radio button with the same field-name. The user can selects only one of the radio buttons. Even if checked="true"are set multiply, only one button in a group is checked.

The status of field-checked="true" are not displayed in GUI.

Listbox field field can be specified by field-type="listbox". <axf:form-field-option> is required for the contents. It should not be empty. <axf:form-field-option> expresses the contents of the list and these are lined up in the appearance order in the list.

<axf:form-field
     field-type="listbox"
     field-top-index="1"
     field-multiple="true"
>
 <axf:form-field-option field-value="M">MasterCard</axf:form-field-option>
 <axf:form-field-option field-value="V">Visa</axf:form-field-option>
 <axf:form-field-option field-value="A">AMEX</axf:form-field-option>
</axf:form-field>

The contents of the list box are not displayed in GUI.

Combobox field field can be specified by field-type="combobox". <axf:form-field-option> is required for the contents. The contents should not be empty. <axf:form-field-option> is the same as that of the list box.

<axf:form-field
     field-type="combobox"
     field-top-index="1"
     field-edittable="true"
>
 <axf:form-field-option field-value="M">MasterCard</axf:form-field-option>
 <axf:form-field-option field-value="V">Visa</axf:form-field-option>
 <axf:form-field-option field-value="A">AMEX</axf:form-field-option>
</axf:form-field>

The contents of the combo box are not displayed in GUI.

Digital Signature field can be specified by field-type="signature". The contents are empty. The appearance cannot be specified beforehand.

<axf:form-field
     field-type="signature"
     field-apply-signature="true"
     width="40pt"
     height="50pt"
/>

When performing the formatting process, the signature area is only reserved and the signature field is not generated. The signature field is generated and an actual signature is applied when generating PDF using PDF Digital Signature Module, When the PDF Digital Signature Module is not installed, neither generation of the signature field nor the actual signature can be performed. See also Digital Signature in the PDF Output page.

Reset initializes the value of all the fields included in <axf:form> to their initial state. Specify axf:action-type="reset" to the button to reset.

<axf:form>
 <axf:form-field field-type="button" action-type="reset" .../>
 <axf:form-field field-type="text" default-text="XXX" .../>
 ...
</axf:form>

Submit sends out the information by using HTTP. The contents of each field are sent out as GET or the POST request of HTTP. That is, the information is submitted using the same HTTP method of HTML.

<axf:form
     external-destination="URI"
     field-submit-method="post"
     field-submit-coordinates="false"
>
 <axf:form-field field-type="button" action-type="submit" .../>
 <axf:form-field field-type="text" default-text="YYY" .../>
 ...
</axf:form>

Link can not be specified to <axf:form> but directly specified to the Button field. The method is the same as that of <fo:basic-link>. The internal link can be specified as follows. Nothing is specified to action-type.

<axf:form-field field-type="button" internal-destination="URI" .../>

The internal link can be specified as follows. You can specify any one of gotor, launch or uri to action-type.

<axf:form-field field-type="button" external-destination="URI"
                                    action-type="gotor" .../>

Specifies the distance from the physical end to the trim size of the output medium. no-LT

The trim size is specified by the page-width and page-height properties. crop-offset is for specifying how much the space is taken outside the trim size. In order to specify the same values vertically and horizontally, axf:crop-offset can be used. In order to specify an individual value, axf:crop-offset-top, axf:crop-offset-bottom, axf:crop-offset-left, and axf:crop-offset-right can be used. When axf:crop-offset and others are specified simultaneously, axf:crop-offset takes priority.

These properties are not available with AH Formatter V5.0 Lite.

Specifies the width of the bleed region for cutting off. no-LT

The region of the bleed is taken outside the trim size. In order to specify the same values vertically and horizontally, axf:bleed can be used. In order to specify an individual value, axf:bleed-top, axf:bleed-bottom, axf:bleed-left, and axf:bleed-right can be used. When axf:bleed and others are specified simultaneously, axf:bleed takes priority.

These properties are not available with AH Formatter V5.0 Lite.

Specifies the Printing marks, such as a crop mark. Specifies the action of external link. no-LT

Values have the following meanings.

crop

Outputs crop marks.

cross

Outputs cross marks, registration marks.

<uri-specification>

Original printer marks, color bars, etc. can be outputted by specifying images, such as SVG. Two or more URIs can be specified.

Crop marks becomes what unites the inner printer marks (crop marks) and the outside printer marks (bleed marks) when there is specification of axf:bleed.

This property is not available with AH Formatter V5.0 Lite.

Specifies the line color of printer marks. no-LT

When the value is auto, the color is regarded as the registration color.

This property is not available with AH Formatter V5.0 Lite.

Specifies the line length of printer marks. no-LT

When the value is auto, the length depends on the system setting. The default length of a printer mark is 10mm, it can be adjusted in the Option Setting File.

This property is not available with AH Formatter V5.0 Lite.

Specifies the line width of printer marks. no-LT

When the value is auto, the width depends on the system setting. The default width of a printer mark is 0.2pt, it can be adjusted in the Option Setting File.

This property is not available with AH Formatter V5.0 Lite.

Specifies the margin between the page and the printer marks when bleed is 0. no-LT

When the value is auto, the margin depends on the system setting. The default margin is 3mm, it can be adjusted in the Option Setting File.

This property is not available with AH Formatter V5.0 Lite.

Selects the printer tray. no-LT

Effective only with the Windows version. Whether it is effective also depends on a printer. What can be specified by the character string is the tray name which comes out in each printer setting dialog. This is the tray name acquired from a printer driver. The specified name which does not match to the tray name acquired from a printer driver is invalid. The specified integer needs to match to the tray number acquired from a printer driver.

This property is not available with AH Formatter V5.0 Lite.

Specifies to print in duplex mode. no-LT

Effective only with the Windows version. Whether it is effective also depends on a printer. Specify the value which is specified by the priner driver. Most printers support following integer values.

1. Simplex Printing.
2. Duplex Printing. Flip on Long Edge. (The before edge of the first side of a page and the second side of a page are in the same way.)
3. Duplex Printing. Flip on Short Edge. (The before edge of the first side of a page and the second side of a page are in the reverse way.)

This property is not available with AH Formatter V5.0 Lite.

The axf:repeat-page-sequence-master specifies the repetition of the page sequence. no-LT

When the value is true, if the page output reaches in the end of fo:page-sequence-master and the page which should still be outputted remains, page output repeats from the start of fo:page-sequence-master.

This property is not available with AH Formatter V5.0 Lite.

axf:suppress-if-first-on-page specifies whether to suppress the block at the beginning of a page. no-LT

Values have the following meanings.

false

Does nothing.

true

Suppresses a block when it comes at the begining of a page. Since it is actually not deleted but exists without display as a block of size zero, it's effective to refer to ID, etc.

This property is not available with AH Formatter V5.0 Lite.

The axf:column-count specifies the number of columns of fo:block-container.

The axf:column-count specifies the width of the separation between adjacent columns of fo:block-container.

The axf:line-break specifies the method of line breaking.

Values have the following meanings.

normal

Nonstarter Japanese characters (prolonged sound mark, small hiragana letters, small katakana letters, and iteration marks) defined in JIS X 4051:2004 are not treated as Nonstarter characters. Also, the properties of axf:append-non-starter-characters, axf:except-non-starter-characters, axf:append-non-end-of-line-characters, axf:except-non-end-of-line-characters are disregarded.

strict

Nonstarter character is treated for Japanese. Also, the characters specified to the properties of axf:append-non-starter-characters, axf:except-non-starter-characters, axf:append-non-end-of-line-characters, axf:except-non-end-of-line-characters are included.

The Nonstarter character in LineBreak-5.0.0.txt is as follows. [JIS] is classified into the Nonstarter character in JIS X 4051:2004.

17D6;KHMER SIGN CAMNUC PII KUUH                        　
203C;DOUBLE EXCLAMATION MARK                           ‼
203D;INTERROBANG                                       ‽
2047;DOUBLE QUESTION MARK                              　
2048;QUESTION EXCLAMATION MARK                         　
2049;EXCLAMATION QUESTION MARK                         　
3005;IDEOGRAPHIC ITERATION MARK                        々    [JIS]
301C;WAVE DASH                                         〜
303B;VERTICAL IDEOGRAPHIC ITERATION MARK               　    [JIS]
303C;MASU MARK                                         　
3041;HIRAGANA LETTER SMALL A                           ぁ    [JIS]
3043;HIRAGANA LETTER SMALL I                           ぃ    [JIS]
3045;HIRAGANA LETTER SMALL U                           ぅ    [JIS]
3047;HIRAGANA LETTER SMALL E                           ぇ    [JIS]
3049;HIRAGANA LETTER SMALL O                           ぉ    [JIS]
3063;HIRAGANA LETTER SMALL TU                          っ    [JIS]
3083;HIRAGANA LETTER SMALL YA                          ゃ    [JIS]
3085;HIRAGANA LETTER SMALL YU                          ゅ    [JIS]
3087;HIRAGANA LETTER SMALL YO                          ょ    [JIS]
308E;HIRAGANA LETTER SMALL WA                          ゎ    [JIS]
3095;HIRAGANA LETTER SMALL KA                          　    [JIS]
3096;HIRAGANA LETTER SMALL KE                          　    [JIS]
309B;KATAKANA-HIRAGANA VOICED SOUND MARK               ゛
309C;KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK          ゜
309D;HIRAGANA ITERATION MARK                           ゝ    [JIS]
309E;HIRAGANA VOICED ITERATION MARK                    ゞ    [JIS]
30A0;KATAKANA-HIRAGANA DOUBLE HYPHEN                   　
30A1;KATAKANA LETTER SMALL A                           ァ    [JIS]
30A3;KATAKANA LETTER SMALL I                           ィ    [JIS]
30A5;KATAKANA LETTER SMALL U                           ゥ    [JIS]
30A7;KATAKANA LETTER SMALL E                           ェ    [JIS]
30A9;KATAKANA LETTER SMALL O                           ォ    [JIS]
30C3;KATAKANA LETTER SMALL TU                          ッ    [JIS]
30E3;KATAKANA LETTER SMALL YA                          ャ    [JIS]
30E5;KATAKANA LETTER SMALL YU                          ュ    [JIS]
30E7;KATAKANA LETTER SMALL YO                          ョ    [JIS]
30EE;KATAKANA LETTER SMALL WA                          ヮ    [JIS]
30F5;KATAKANA LETTER SMALL KA                          ヵ    [JIS]
30F6;KATAKANA LETTER SMALL KE                          ヶ    [JIS]
30FB;KATAKANA MIDDLE DOT                               ・
30FC;KATAKANA-HIRAGANA PROLONGED SOUND MARK            ー    [JIS]
30FD;KATAKANA ITERATION MARK                           ヽ    [JIS]
30FE;KATAKANA VOICED ITERATION MARK                    ヾ    [JIS]
31F0;KATAKANA LETTER SMALL KU                          　    [JIS]
31F1;KATAKANA LETTER SMALL SI                          　    [JIS]
31F2;KATAKANA LETTER SMALL SU                          　    [JIS]
31F3;KATAKANA LETTER SMALL TO                          　    [JIS]
31F4;KATAKANA LETTER SMALL NU                          　    [JIS]
31F5;KATAKANA LETTER SMALL HA                          　    [JIS]
31F6;KATAKANA LETTER SMALL HI                          　    [JIS]
31F7;KATAKANA LETTER SMALL HU                          　    [JIS]
31F8;KATAKANA LETTER SMALL HE                          　    [JIS]
31F9;KATAKANA LETTER SMALL HO                          　    [JIS]
31FA;KATAKANA LETTER SMALL MU                          　    [JIS]
31FB;KATAKANA LETTER SMALL RA                          　    [JIS]
31FC;KATAKANA LETTER SMALL RI                          　    [JIS]
31FD;KATAKANA LETTER SMALL RU                          　    [JIS]
31FE;KATAKANA LETTER SMALL RE                          　    [JIS]
31FF;KATAKANA LETTER SMALL RO                          　    [JIS]
A015;YI SYLLABLE WU                                    　
FE54;SMALL SEMICOLON                                   　
FE55;SMALL COLON                                       　
FF1A;FULLWIDTH COLON                                   ：
FF1B;FULLWIDTH SEMICOLON                               ；
FF65;HALFWIDTH KATAKANA MIDDLE DOT                     ･
FF67;HALFWIDTH KATAKANA LETTER SMALL A                 ｧ    [JIS]
FF68;HALFWIDTH KATAKANA LETTER SMALL I                 ｨ    [JIS]
FF69;HALFWIDTH KATAKANA LETTER SMALL U                 ｩ    [JIS]
FF6A;HALFWIDTH KATAKANA LETTER SMALL E                 ｪ    [JIS]
FF6B;HALFWIDTH KATAKANA LETTER SMALL O                 ｫ    [JIS]
FF6C;HALFWIDTH KATAKANA LETTER SMALL YA                ｬ    [JIS]
FF6D;HALFWIDTH KATAKANA LETTER SMALL YU                ｭ    [JIS]
FF6E;HALFWIDTH KATAKANA LETTER SMALL YO                ｮ    [JIS]
FF6F;HALFWIDTH KATAKANA LETTER SMALL TU                ｯ    [JIS]
FF70;HALFWIDTH KATAKANA-HIRAGANA PROLONGED SOUND MARK  ｰ    [JIS]
FF9E;HALFWIDTH KATAKANA VOICED SOUND MARK              ﾞ
FF9F;HALFWIDTH KATAKANA SEMI-VOICED SOUND MARK         ﾟ

Specifies the append-non-starter-characters in CJK.

When axf:line-break="strict" is specified, the characters included in <string> can be appended to the non-starter-characters. If the specified characters are also specified in axf:except-non-starter-characters as well in the same tag, the effect could be wrong. White space, closing parenthesis and punctuations, that are originally non-starter, are disregarded even though they are specified. The initial value of non-starter-characters can be set by append-non-starter-characters in the Option Setting File.

Specifies the except-non-starter-characters in CJK.

When axf:line-break="strict" is specified, the characters included in <string> can be eliminated from the non-starter-characters. If the specified chararters are also specified to axf:append-non-starter-characters in the same tag as well, the effect is not guaranteed. White space, closing parenthesis and punctuations, that are originally non-starter, are disregarded even though they are specified. The initial value of non-starter-characters can be set by append-non-starter-characters in the Option Setting File.

Specifies the append-non-end-of-characters in CJK.

When axf:line-break="strict" is specified, the characters included in <string> can be appended to the non-end-of-line-characters. If the specified characters are also specified to axf:except-non-end-of-line-characters as well in the same tag, the effect could be wrong. White space, opening parenthesis and punctuations, that are originally non-end-of-line, are disregarded even though they are specified. The initial value of non-end-of-line-characters can be set by append-non-end-of-line-characters in the Option Setting File.

Specifies the except-non-end-of-characters in CJK.

When axf:line-break="strict" is specified, the characters included in <string> can be eliminated from the non-end-of-line-characters. If the specified chararters are also specified to axf:append-non-end-of-line-characters in the same tag as well, the effect is not guaranteed. White space, opening parenthesis and punctuations, that are originally non-end-of-line, are disregarded even though they are specified. The initial value of non-end-of-line-characters can be set by append-non-end-of-line-characters in the Option Setting File.

The axf:word-break specifies whether to enable line breaking even between word.

Values have the following meanings.

normal

Follows a normal line breaking rule.

break-all

The line breaking is enabled between all the characters in the word. This is effective for only the following scripts.

• Latn
• Cyrl
• Grek
• Zyyy

keep-all

Do not break between words. A word here indicates a character string which consists of the following category (General Category) of Unicode.

• Letter
• Mark
• Number

Whether to break lines on a boundary with characters other than these follows the rule of the standard line break. Moreover, hyphenate="true" is disregarded.

Specifies whether to break word forcibly when line break cannot be performed. V5.0

Values have the following meanings.

normal

The line is not broken forsibly. The text will overflow across the region.

break-word

The line is broken forsibly at an appropriate position.

The axf:hyphenation-minimum-character-count specifies the minimum nunber of the character to hyphenate.

The axf:hyphenation-minimum-character-count must be integer number of 1 or more.

axf:hyphenation-zone limits the range where a hyphenation is available.

Values have the following meanings.

none

Nothing is limited in hyphenation.

<length>

If the length from the end of a word to the end of line is less or equal to the specified value, the following word is not hyphenated.
It is invalid when zero or less value is specified.

Specifies whether to treat full width punctuations in Japanese.

Values have the following meanings.

none

Punctuation characters are not trimmed.

start

Punctuation characters (open parenthesis etc.) at start of line are trimmed.

end

When text-align="right" or text-align="justify" (or text-align-last="justify") is specified and full-width punctuation marks (closing parenthesis etc.) come to the end of the sentence, the character is treated as half width forcibly.

allow-end V5.0

When text-align="right" or text-align="justify" (or text-align-last="justify") is specified and full-width punctuation marks (closing parenthesis etc.) come to the end of the sentence, characters are treated as full width if text fits into one line, characters are treated as half width if text does not fit into one line.

end-except-fullstop V5.0

Behaves as the same as the end value except that the following two characters are not included.

3002;IDEOGRAPHIC FULL STOP       。
FF0E;FULLWIDTH FULL STOP         ．

adjacent V5.0

The space between a full width punctuation and a full width character in Japanese is trimmed.

• Between full width close parenthesis and full width open parenthesis.
• Between full width close parenthesis and full width close parenthesis.
• Between full width close parenthesis and full width middle dots.
• Between full width close parenthesis and non punctuation characters.
• Between full width open parenthesis and full width open parenthesis.
• Between full width middle dots and full width open parenthesis.
• Between non punctuation character and full width open parenthesis.

Full width punctuation characters are treated the same as full width close parenthesis. The adjacent value is equivalent to axf:kerning-mode="contextual" with XSL Formatter V4.

all

Trim all parentheses, middle points, and punctuations of full width and treat them as half width.

auto

Dependent on the system setting. This is the value specified by punctuation-trim and text-justify-mode in the option setting file.

Full width punctuation open parenthesis processed by axf:punctuation-trim are:

2018;LEFT SINGLE QUOTATION MARK                        ‘
201C;LEFT DOUBLE QUOTATION MARK                        “
3008;LEFT ANGLE BRACKET                                〈
300A;LEFT DOUBLE ANGLE BRACKET                         《
300C;LEFT CORNER BRACKET                               「
300E;LEFT WHITE CORNER BRACKET                         『
3010;LEFT BLACK LENTICULAR BRACKET                     【
3014;LEFT TORTOISE SHELL BRACKET                       〔
3016;LEFT WHITE LENTICULAR BRACKET                     〖
3018;LEFT WHITE TORTOISE SHELL BRACKET                 〘
301A;LEFT WHITE SQUARE BRACKET                         〚
301D;REVERSED DOUBLE PRIME QUOTATION MARK              〝
FF08;FULLWIDTH LEFT PARENTHESIS                        （
FF3B;FULLWIDTH LEFT SQUARE BRACKET                     ［
FF5B;FULLWIDTH LEFT CURLY BRACKET                      ｛
FF5F;FULLWIDTH LEFT WHITE PARENTHESIS                  　

Full width punctuation close parenthesis processed by axf:punctuation-trim are:

2019;RIGHT SINGLE QUOTATION MARK                       ’
201D;RIGHT DOUBLE QUOTATION MARK                       ”
3009;RIGHT ANGLE BRACKET                               〉
300B;RIGHT DOUBLE ANGLE BRACKET                        》
300D;RIGHT CORNER BRACKET                              」
300F;RIGHT WHITE CORNER BRACKET                        』
3011;RIGHT BLACK LENTICULAR BRACKET                    】
3015;RIGHT TORTOISE SHELL BRACKET                      〕
3017;RIGHT WHITE LENTICULAR BRACKET                    〗
3019;RIGHT WHITE TORTOISE SHELL BRACKET                〙
301B;RIGHT WHITE SQUARE BRACKET                        〛
301E;DOUBLE PRIME QUOTATION MARK                       〞
301F;LOW DOUBLE PRIME QUOTATION MARK                   〟
FF09;FULLWIDTH RIGHT PARENTHESIS                       ）
FF3D;FULLWIDTH RIGHT SQUARE BRACKET                    ］
FF5D;FULLWIDTH RIGHT CURLY BRACKET                     ｝
FF60;FULLWIDTH RIGHT WHITE PARENTHESIS                 　

Full width punctuations processed by axf:punctuation-trim are:

3001;IDEOGRAPHIC COMMA                                 、
3002;IDEOGRAPHIC FULL STOP                             。
FF0C;FULLWIDTH COMMA                                   ，
FF0E;FULLWIDTH FULL STOP                               ．

Full width middle dots processed by axf:punctuation-trim are:

30FB;KATAKANA MIDDLE DOT                               ・
FF1A;FULLWIDTH COLON                                   ：
FF1B;FULLWIDTH SEMICOLON                               ；

Specifies the way to trim. V5.0

Values have the following meanings.

none

Do not trim Japanese text.

punctuation

Trim text with parentheses, middle points, and punctuations of full width.

punctuation-except-fullstop

Behaves as the same as the punctuation value except that the following two characters are not included.

3002;IDEOGRAPHIC FULL STOP       。
FF0E;FULLWIDTH FULL STOP         ．

kana

Trim Hiragana and Katakana a bit.

ideograph

Trim spaces between Chinese characters or kana.

inter-word

Trim spaces between Western words.

auto

Dependent on the system setting. This is the value specified by punctuation-trim and text-justify-mode in the option setting file.

Trim the spaces between characters as specified so that text fits into a line.When axf:punctuation-trim="all" is specified, there may be no more space to trim.

The axf:kerning-mode specifies whether to process the kerning.

Values have the following meanings.

none

The kerning is not processed.

pair

The pair kerning for Western characters is processed.

auto

Dependent on the system setting.

You can specify whether pair kernings for European languages is performed or not by pair-kerning in the Option Setting File. This can also be set in the Option Setting dialog in GUI.

axf:kerning-mode does not work when letter-spacing is specified.

The axf:punctuation-spacing specifies the spacing between a full width punctuation and a full width character in Japanese.

The initial value of this space can be set by punctuation-spacing in the Option Setting File.

Values have the following meanings.

auto

Dependent on the system setting. This is the value specified by punctuation-spacing in the option setting file.

This interval is used by axf:punctuation-trim="adjacent", etc.

Specifies whether to hang punctuations at the start of the line or end of the line.

Values have the following meanings.

none

Do not hang punctuations at the start of the line or end of the line.

start V5.0

Hangs punctuations at the start of the line. If the target character for hanging comes to the start of the line, the character is hanged forcibly.

first V5.0

Behaves as the same as the start value only with the start line of a paragraph.

force-end V5.0

Hangs punctuations at the end of the line. When text-align="right" or text-align="justify" (or text-align-last="justify") is specified and a target character for hanging comes to the end of the sentence, the character is hanged forcibly. When anything else is specified to text-align, the character is hanged naturally. the end value before V5 is taken as the allow-end value.

allow-end V5.0

Hangs punctuations at the end of the line. When text-align="right" or text-align="justify" (or text-align-last="justify") is specified and a target character for hanging comes to the end of the sentence, the character is not hanged if text fits into one line, the character is hanged if text does not fit into one line. When anything else is specified to text-align, the character is hanged naturally.

last V5.0

Behaves the same as the force-end value only with the end of the line of a paragraph.

The target punctuation marks is as follows.

• force-end、allow-end
  Japanese or Simplified Chinese

  3001;IDEOGRAPHIC COMMA           、
  3002;IDEOGRAPHIC FULL STOP       。
  FF0C;FULLWIDTH COMMA             ，
  FF0E;FULLWIDTH FULL STOP         ．
  

  Traditional Chinese

  FE50;SMALL COMMA                 ﹐
  FE51;SMALL IDEOGRAPHIC           ﹑
  FE52;SMALL FULL STOP             ﹒
  FF64;HALFWIDTH IDEOGRAPHIC COMMA ､
  

  Other languages
  • Same as the last value
• last
  quotation marks, closing parentheses, period, comma and hyphen
• start、first
  quotation marks, closing parentheses and bullet

The axf:avoid-widow-words specifies spacing behavior between words or characters so that the last line of the paragraph does not have only one word left (one character for CJK).

Values have the following meanings.

true

Adjusts the spacing so that the last line of the paragraph does not have only one word left. (one character for CJK) when the spacing behavior is available by trimming the interval between Japanese characters or Western words.

false

Spacing behavior is not processed.

If the width of columns (length of the line) is short, it is not so effective because there is not enough space to run on. In addition, in case there is no room for a word to be placed at the end of the line, axf:avoid-widow-words has no effect.

The axf:text-autospace specifies whether to add space surrounding ideographic glyphs or not.

Values have the following meanings.

none

Space is not added.

ideograph-numeric

Space is added between ideograph character and non-ideographic number character. Non-ideographic number character mentioned here indicates the character of Nd, Nl, and No classified by Unicode.

ideograph-alpha

Space is added between ideograph character and non-ideographic alphabet character. Non-ideographic alphabet character mentioned here indicates the character of Lu, Ll, Lt, Lm and Lo classified by Unicode.

ideograph-parenthesis

Space is added between ideograph character and non-ideographic parenthesis character. However space is not added between ideograph character and non-ideographic closing parenthesis or between non-ideographic opening parenthesis and ideograph character.

ideograph-punctuation

Space is added between ideograph character and non-ideographic punctuation character. Non-ideographic punctuation character mentioned here indicates the character of Ps, Pe, Po, Pi, and Pf classified by Unicode excluding parenthesis character and quotation mark. Space is added between period and ideograph character. However space is not added between ideograph character and period. The same rule is applied to comma.

auto

Dependent on the system setting. It's regarded as "none" or "ideograph-numeric ideograph-alpha" according to the setting.

The initial value of whether space is added or not can be set by text-autospace in the Option Setting File. It can also be set in the Format Option Setting Dialog in the GUI.

The axf:text-autospace-width specifies the width for axf:text-autospace.

This space is used in axf:text-autospace. In addition, the initial value of the space can be set by text-autospace-width in the Option Setting File.

axf:text-align-string specifies the text alignment when text-align="<string>". V5.0

Values have the following meanings.

start

center

end

inside

outside

left

right

Same as text-align or text-align-last.

Although the specification of <string> to fo:table-cell alignes the character position of decimal point, etc., there is no definition for the alignment of the whole character string. At a default, AH Formatter V5.0 displayed it right aligned according to the illustration of 17.5.4 Horizontal alignment in a column. AH Formatter V5.0 extends the alignment and makes it possible to align left or align center

axf:text-align-first specifies the text alignment of the first line.

Values have the following meanings.

relative

Does nothing. axf:text-align-first is invalid.

start

center

end

justify

inside

outside

left

right

Same as text-align or text-align-last.

Specifies the alignment of the child of the first line area and the alignment of the line coming right after the line with U+000A at the end. Priority is given above text-align-last.

Refer to axf:leader-expansion.

axf:leader-expansion specifies whether to expand a leader forcibly. no-LT

Values have the following meanings.

auto

Operates as usual by specifying text-align.

force

Considers a line with leaders as text-align="justify". Consequently, leaders will expand.

Suppose you create a table of contents using leaders. Then you might want to format as follows with the length of a label, or the length of the number of pages.

1. Short Label .......................... 10,20,30
   

2. Short Label ... 10,20,30,40,50,60,70,80,90,100,
                               110,120,130,140,150
   

3. Very Looooooooooooooooooooooooooooong Label ...
   ...................................... 10,20,30
   

4. Very Looooooooooooooooooooooooooooong Label ...
   ... 10,20,30,40,50,60,70,80,90,100,110,120,130,
                                           140,150
   

5. Very Very Very Looooooooooooooooooooooooooooong
   Long Long Label ...................... 10,20,30
   

6. Very Very Very Looooooooooooooooooooooooooooong
   Long Long Label ... 10,20,30,40,50,60,70,80,90,
                           100,110,120,130,140,150
   

When the following XSL Standard is specified,

<fo:block text-align="justify" text-align-last="justify">
 Label
 <fo:leader leader-pattern="dots"/>
 Pages
</fo:block>

only the simple 1. and 5. can get the expected results. And 3. can be performed by the following specification.

<fo:block text-align="justify" text-align-last="justify">
 Label
 <fo:leader leader-length.minimum="0pt" leader-pattern="dots"/><fo:leader leader-pattern="dots"/>
 Pages
</fo:block>

Next, by using axf:text-align-first as follows,

<fo:block text-align="justify" text-align-last="right" axf:text-align-first="justify">
 Label
 <fo:leader leader-length.minimum="0pt" leader-pattern="dots"/><fo:leader leader-pattern="dots"/>
 Pages
</fo:block>

all cases excluding 3. and 5. gets the result as expected. Furthermore, by using axf:leader-expansion as follows,

<fo:block text-align="justify" text-align-last="right" axf:text-align-first="justify"
          axf:leader-expansion="force">
 Label
 <fo:leader leader-length.minimum="0pt" leader-pattern="dots"/><fo:leader leader-pattern="dots"/>
 Pages
</fo:block>

all cases gets the result as expected.

This property is not available with AH Formatter V5.0 Lite.

Specifies the percentage of Kashida in Arabic justification.

Values have the following meanings.

<percentage>

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. The value should be from 0% to 100%.

auto

Dependent on the system setting.

The initial value of the the percentage can be set by text-kashida-space in the Option Setting File.

The axf;justify-nbsp specifies whether to justify NON-BREAKING SPACE or not. Generally, NON-BREAKING SPACE (U+00A0) is intended for justification. The axf:justify-nbsp property can be used when you do not want to include U+00A0 in justification. In V2.5, U+00A0 is not intended for justification. This property can also be specified for compatibility with V2.5.

Values have the following meanings.

true

NON-BREAKING SPACE is included for justification.

false

NON-BREAKING SPACE is not included for justification.

axf:text-line-color specifies the color of underline, strikethrough, and overline.

axf:text-line-style specifies the style of underline, strikethrough, and overline.

none cannot be specified to <border-style>.

axf:text-line-width specifies the width of underline, strikethrough, and overline.

axf:text-underline-position specifies the position of underline.

axf:text-underline-position="alphabetic" places the baseline in the upper end of the height of an underline. axf:text-underline-position="0pt places the baseline at the center of the height of an underline.

The axf:vertical-underline-side specifies on which side of the text to put underline in vertical writing-mode.

Values have the following meanings.

left

The underline is placed on the left side.

right

The underline is placed on the right side.

depend-on-language

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(jpn) or Korean(kor).

auto

Dependent on the system setting.

The initial value of the underline position can be set by vertical-underline-side in the Option Setting File. It can also be set in the Format Option Setting Dialog in the GUI.

When axf:vertical-underline-side="auto" is specified and the initial value of the system is also auto, 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(jpn) or Korean(kor). If there is no language properties specified, it depends on the Default CJK language setting.

Values have the following meanings.

auto

SOFT HYPHEN is deleted except when needed for line breaking. (normal)

preserve

SOFT HYPHEN is not deleted and the target glyph is output.

Replaces the character strings. V5.0

Values have the following meanings.

none

Do nothing.

[<string> <string>]+

The first pair of character strings is replaced by the latter character strings. You have to specify a character string by a pair. It is not replaced when character strings are odd pieces or the first character string is empty. White space characaters will be replaced after being processed by white-space-treatment, etc.

When it is simultaneously specified with text-transform or axf:number-transform, axf:text-replace will be evaluated at the end.

Converts the number sequence in the character string. V5.0 no-LT

Values have the following meanings.

none

Do nothing.

kansuji

Converts the contained number sequence into Japanese numerals. The details of the Japanese numeral format can be specified as below. axf:kansuji-style,axf:kansuji-letter,axf:kansuji-grouping-letter.

kansuji-if-vertical

Only with the vertical writing, such as writing-mode="tb-rl", text-transform="kansuji" is applied. Nothing is changed when it's not the vertical writing.

<list-style-type>

Among the list-style-type defined by CSS, the number related types which can be specified are <algorithmic>, <numeric>, <alphabetic>, <symbolic>, <non-repeating>. Convertible digit numbers may differ depending on list-style-type. Too long number sequence cannot be converted.

<string>

When a character string is specified, the behavior is same as when the character string is specified by format.

A number sequence (number) here indicates character strings of the following forms.

number ::= digits
digits ::= [0-9]+

When it is simultaneously specified with text-transform or axf:text-replace, axf:number-transform is evaluated previously.

Specifies the style used for Japanese numerals. V5.0 no-LT

Values have the following meanings.

simple

Converts a number sequence into Japanese numerals by one to one correspondence.

12340   ⇒ 一二三四〇
6700000 ⇒ 六七〇〇〇〇〇

grouping

In adds to the conversion of one to one correspondence, grouping for 万億兆京垓秭穣溝澗正載極 is inserted.

• When all the parts below a certain grouping are zero, they are deiregarded.

12340   ⇒ 一万二三四〇
6700000 ⇒ 六七〇万

readable

Inserts grouping of 万億兆… and uses 十百千 additionally so that the character strings becomes readable.

• Preceding zero is disregarded.
• In the huge numerical value which needs the next grouping of 極, the digits more than 極 are converted by one to one correspondence.

12340   ⇒ 一万二千三百四十
6700000 ⇒ 六百七十万
1000000 ⇒ 百万
000015  ⇒ 十五
0       ⇒ 〇

Specifies the character used for Japanese numerals. V5.0 no-LT

Values have the following meanings.

kanji

Use Japanese numerals for numbers. Equivalent to specify axf:kansuji-letter="〇一二三四五六七八九".

〇 : U+3007

一 : U+4E00

二 : U+4E8C

三 : U+4E09

四 : U+56DB

五 : U+4E94

六 : U+516D

七 : U+4E03

八 : U+516B

九 : U+4E5D

latin

Use double-byte western numerals for numbers. Equivalent to specify axf:kansuji-letter="０１２３４５６７８９".

０ : U+FF10

１ : U+FF11

２ : U+FF12

３ : U+FF13

４ : U+FF14

５ : U+FF15

６ : U+FF16

７ : U+FF17

８ : U+FF18

９ : U+FF19

<string>

Specifies arbitrary characters as numbers you use. For example, if you want to use traditional Japanese numerals, specify axf:kansuji-letter="零壱弐参肆伍陸柒捌玖". If you want to specify traditional Japanese numerals only to "一二三", specify axf:kansuji-letter="〇壱弐参四五六七八九". If you specify only the head part like axf:kansuji-letter="〇壱弐参", it is compensated as axf:kansuji-letter="〇壱弐参四五六七八九".

零 : U+96F6

壱 : U+58F1

弐 : U+5F10

参 : U+53C2

肆 : U+8086

伍 : U+4F0D

陸 : U+9678

柒 : U+67D2

捌 : U+634C

玖 : U+7396

Specifies the grouping character used for Japanese numerals. V5.0 no-LT

The null character sequence is regarded as "十百千万億兆京垓秭穣溝澗正載極". Please change and specify only a corresponding character if you want to change "万" to "萬", for example. When you specify only the head part like "拾佰阡萬", it is compensated as "拾佰阡萬億兆京垓秭穣溝澗正載極".

十 : U+5341

百 : U+767E

千 : U+5343

万 : U+4E07

億 : U+5104

兆 : U+5146

京 : U+4EAC

垓 : U+5793

秭 : U+79ED

穣 : U+7A63

溝 : U+6E9D

澗 : U+6F97

正 : U+6B63

載 : U+8F09

極 : U+6975

拾 : U+62FE

佰 : U+4F70

阡 : U+9621

萬 : U+842C

Specifies whether to perform the ligature processing.

Values have the following meanings.

none

The ligature processing is not performed.

latin

Processes the ligature in European languages. It is processed when the scripts are the followngs.

• Latn
• Grek
• Cyrl

kana

Processes the ligature of Kana + semivoiced sound symbol in JIS X 0213:2004 as follows.

• U+304B + U+309A
• U+304D + U+309A
• U+304F + U+309A
• U+3051 + U+309A
• U+3053 + U+309A
• U+30AB + U+309A
• U+30AD + U+309A
• U+30AF + U+309A
• U+30B1 + U+309A
• U+30B3 + U+309A
• U+30BB + U+309A
• U+30C4 + U+309A
• U+30C8 + U+309A
• U+31F7 + U+309A

Although the ligature of European languages and the ligature of symbols are included in JIS X 0213:2004, these are processed by ligature-mode="latin".

all

latin and kana are considered to be specified.

auto

Dependent on the system setting.

The ligature processed here is the ligature defined in the font itself. The ligature, U+FB01 etc. defined in Unicode are not processed. That is, a sequence of U+0066 U+0069 are not substituted with U+FB0. If the ligature corresponding to U+0066 U+0069 is defined inside the font, its glyph will be outputted.

You can specify whether ligatures for European languages are performed or not by latin-ligature in the Option Setting File. These can also be set in the Option Setting dialog in GUI.

Specifies the glyph of Japanese Kanji. Applied only to the Japanese Kanji that has the substitution function for the specific Open type.

Values have the following meanings.

none

Nothing is done.

jp78

jp78 is applied. Nothing is done when the font does not have jp78.

jp83

Jp83 is applied. Nothing is done when the font does not have jp83.

jp90

Jp90 is applied. Nothing is done when the font does not have jp90.

jp04

Jp04 is applied. Nothing is done when the font does not have jp04.

The glyph of Japanese Kanji is changed more than a little by JIS in which it is being defined. Some of the Open Type font have glyphs that correspond to JIS respectively. The glyphs of such fonts can be specified by the japanese-glyph property.

Specifies the alternative glyph of a character. It is applied only to the specific OpenType. V5.0

Values have the following meanings.

<number>

Specifies the order of the alternative glyph. 0 is a standard glyph. When the specified order is beyond the number of the glyph which is contained in the font, it is regarded as 0.

<string>

Specifies the tag of OpenType GSUB feature. If omitted, it is regarded as aalt. <number> is required or not required depending on the tag. When <number> is omitted even if it's necessary, it is regarded as 1. The following tags can be specified.

• aalt
• nalt

Some of the OpenType font have some alternative glyphs against a certain glyph. In such a font, a glyph can be chosen with the alt-glyph property. AH Formatter V5.0 doesn't offer the way to investigate what type and how many glyphs are contained. It is applied only to the script associated with Chinese character, Hiragana, Katakana, Latin, Greek, Cyrillic and Number.

The axf:suppress-duplicate-page-number specifies to delete the duplicated page numbers.

When formatting a index, generally several fo:page-number-citation line up for one index item. In such case, when fo:page-number-citation refers to the same page number of the index, page numbers are output repeatedly using the standard property.

For example:

When axf:suppress-duplicate-page-number is not specified.

<fo:block text-align-last="justify">
 <fo:block>bcd
  <fo:leader lender-pattern="dots"/>
  <fo:basic-link internal-destination="ID1">
   <fo:page-number-citation ref-id="ID1"/>
  </fo:basic-link>
 <fo:/block>
 <fo:block>index
  <fo:leader lender-pattern="dots"/>
  <fo:basic-link internal-destination="ID2">
   <fo:page-number-citation ref-id="ID2"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID3">
   <fo:page-number-citation ref-id="ID3"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID4">
   <fo:page-number-citation ref-id="ID4"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID5">
   <fo:page-number-citation ref-id="ID5"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID6">
   <fo:page-number-citation ref-id="ID6"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID7">
   <fo:page-number-citation ref-id="ID7"/>,
  </fo:basic-link>
 </fo:block>
</fo:block>

Format example of the above text is as follows.

When axf:suppress-duplicate-page-number is specified.

<fo:block text-align-last="justify" axf:suppress-duplicate-page-number="true">
 <fo:block>bcd
  <fo:leader lender-pattern="dots"/>
  <fo:basic-link internal-destination="ID1">
   <fo:page-number-citation ref-id="ID1"/>
  </fo:basic-link>
 <fo:/block>
 <fo:block>index
  <fo:leader lender-pattern="dots"/>
  <fo:basic-link internal-destination="ID2">
   <fo:page-number-citation ref-id="ID2"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID3">
   <fo:page-number-citation ref-id="ID3"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID4">
   <fo:page-number-citation ref-id="ID4"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID5">
   <fo:page-number-citation ref-id="ID5"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID6">
   <fo:page-number-citation ref-id="ID6"/>,
  </fo:basic-link>
  <fo:basic-link internal-destination="ID7">
   <fo:page-number-citation ref-id="ID7"/>,
  </fo:basic-link>
 </fo:block>
</fo:block>

Format example of the above text is as follows.

The axf:page-number-prefix sets the prefix of page number.

Specifies the prefix for page numbers. Specified string will be outputted before the page number by fo:page-number and fo:page-number-citation. Also this string will be used as the page label in the PDF.

<fo:page-sequence axf:page-number-prefix="A-" format="i" initial-page-number="10">
  <fo:static-content ...>
   ...<fo:page-number/>...
  </fo:static-content>
  ...
</fo:page-sequence>

Arabic and Hebrew cannot be specified for the value of axf:page-number-prefix.

The axf:physical-page-number gets physical page number.

The value of initial-page-number property is disregarded and the physical page number that is not affected by the page-sequence is obtained. In order to obtain the total number of pages, ID is given to the last page per the following example:

See also fo:page-number-citation-last in XSL1.1.

Specifies the origin of the page number.

ID for the origin of the page number can be specified in fo:page-number or fo:page-number-citation. The output page number is as follows:

[ref-id page] - [origin-id page] + 1

If the specified Page is after the ref-id page, the value becomes 0. In fo:page-number, ref-id is considered to be the position of fo:page-number itself.

Specifies the assumed page number.

When <fo:page-number-citation> appears, the reference area is sometimes undecided. In evaluation of <fo:page-number-citation>, the temporary area is secured first, and when a page number is decided, it is adjusted to the right contents. Since the size of an area may change at this time, the formatted result is sometimes not desirable. For example, when an area becomes narrow, it seems that there is an unnecessary line break, and condition that a character will overflow if an area becomes large appears. axf:assumed-page-number gives the assumed page number at that time.

AH Formatter V5.0 expects the area of at least three-digit page number and formats temporarily. What is necessary will be just to specify axf:assumed-page-number="99" etc., when the page number is clearly less than that.

Specifies the assumed page number prefix.

When <fo:page-number-citation> appears, the reference area is sometimes undecided. It is unknown at this time whether the reference area is inside of the same <fo:page-sequence>. When the reference area is in the different <fo:page-sequence>, the values of axf:page-number-prefix may differ. Then the temporary area is secured first, and when a reference place appears, it is adjusted to the right contents. If axf:page-number-prefix is specified to the current <fo:page-sequence>, it will be assumed as a temporary area. Otherwise, a suitable short character string will be assumed. Since the size of an area may change at this time, the formatted result is sometimes not desirable. For example, when an area becomes narrow, it seems that there is an unnecessary line break, and condition that a character will overflow if an area becomes large appears. axf:assumed-page-number gives the assumed page number prefix at that time.

Even when axf:page-number-prefix is empty, it's not known whether it is empty at the time of the temporary formatting. Then a certain amount of the area will be secured. In order to deter this, please specify axf:assumed-page-number-prefix="''" to an suitable element. Since an area is not secured at this time, the setting of axf:page-number-prefix is ignored.

The axf:number-type specifies whether to output the page number or to output the column number.

Values have the following meanings.

page

Outputs the page number.

column

Outputs the column number.

page-and-column

Outputs both of the page number and the column number.

It can be specified to fo:page-number, etc. and the column number can be outputted instead of the page number. While format property is applied to the format of the page number, axf:column-number-format property is applied to the format of the column number. The column number is not outputted if multiple column is not specified by specifying of column-count="1" or span="all".

The axf:column-number-format specifies the format of column number.

It applies to the format of column number specified by axf:number-type property. It can be specified with the same way as format property.

The axf:revision-bar-color specifies the color of the revision bar.

The axf:revision-bar-offset specifies the offset of the revision bar.

The axf:revision-bar-position specifies the position of the revision bar.

Values have the following meanings.

start

Places revision bar at start-edge.

end

Places revision bar at end-edge.

inside

Places revision bar at start-edge on odd pages, at end-edge on even pages.

outside

Places revision bar at end-edge on odd pages, at start-edge on even pages.

alternate

Places revision bar at end-edge in the last column of multi-column layout, except for the last column, places it at start-edge.

both

Places revision bar at start-edge and end-edge.

The axf:revision-bar-style specifies the style of the revision bar.

The axf:revision-bar-width specifies the width of the revision bar.

Specifies the alignment of the footnotes.

Values have the following meanings.

auto

Footnotes are placed automatically. Footnotes are the usual arrangement. When the text is one column, sidenotes are arranged with an anchor position, and in the case of two or more columns, sidenotes are arranged near by the before side.

before

Sidenotes are arranged near by the before side. In the case of usual footnotes which are not sidenotes, footnotes are arranged immediately after the text in a page.

after

Sidenotes are arranged near by the after side. In the case of usual footnotes which are not sidenotes, footnotes are arranged at the last of a page.

Specifies the method of arrangement of footnotes or sidenotes. When it is sidenotes (footnote arrangement into region-start or region-end is specified by axf:footnote-position), it's possible to specify whether it is arranged automatically, or it is arranged near by the before side, or it is arranged near by the after side.

The axf:footnote-stacking specifies the method to layout the footnote.

Values have the following meanings.

block

Arranges the footnotes in the block progression direction.

inline

Arranges the footnotes in the inline progression direction.