Apr 24, 2003 | |
Rev | May 14, 2004 |
Rev | Dec 14, 2004 |
The namespace of XSL Extensions by Antenna House has the URI http://www.antennahouse.com/names/XSL/Extensions.
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:axf="http://www.antennahouse.com/names/XSL/Extensions">
These extensions are based on XSL 1.0. XSL 1.1 may become different specification from Antenna House Extensions.
CAUTION: [-] sign means not implemented yet. Other extensions are already implemented on XSL Formatter V3.2.
Specifies the document information. The information is not included in the generated areas. For example, this information is embedded into PDF.
None.
The axf:document-info extension property can be placed in any position right under the fo:root and before fo:page-sequence. Its properties are "name" and "value", which are required. The value of 'name' must be one of the following: "title", "subject", "author" or "keywords".
<!ELEMENT axf:document-info EMPTY> <!ATTLIST axf:document-info name CDATA #REQUIRED value CDATA #REQUIRED >
EMPTY
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:axf="http://www.antennahouse.com/names/XSL/Extensions"> <axf:document-info name="title" value="The document title"/> <axf:document-info name="subject" value="The document subject"/> <axf:document-info name="author" value="The author"/> <axf:document-info name="keywords" value="Comma separated keywords list"/> ...
axf:document-info as a child of fo:page-sequence is effective only for PDF output in multi separate volume. axf:document-info as a child of fo:page-sequence overwrites axf:document-info as a child of fo:root and is utilized for an information of the document when outputting in separate volume. Therefore the same document information is embedded in all the separate volumes unless axf:document-info is specified to fo:page-sequence.
Controls the order of the BookMark output. This element does not generate areas.
None.
The axf:outline-group-position element is a child of fo:root.
If it becomes before fo:page-sequence appears,
it is possible to put it on an arbitrary position under a child of fo:root.
The group name is specified by "outline-group". An empty string indicates the bookmark which is not grouped. "outline-title" specifies the strings of the actual display. If the content is specified to "outline-title", it is adapted. If neither of them are specified, the group name is displayed. "outline-expand" specifies whether to display the lower hierarchy of bookmark in default. True specifies to display the lower hierarchy in the expanded state. False specifies to display in the collapsed state.
The bookmark is generated in the appearing order of the elements. When an unspecified group name appears, it is outputted after these elements.
<!ELEMENT axf:outline-group-position #PCDATA> <!ATTLIST axf:outline-group-position outline-expand (true|false) "true" outline-title CDATA "" outline-group CDATA #REQUIRED >
#PCDATA
Makes it possible to output PDF in separate volume per fo:page-sequence when outptting the formatted result.
None.
The axf:output-volume-info is placed as a child of fo:root. If it comes before fo:page-sequence appears, it is possible to put it in an arbitrary position under a child of fo:root.
<!ELEMENT axf:output-volume-info EMPTY> <!ATTLIST axf:output-volume-info initial-volume-number NUMBER "1" format CDATA "1" bookmark-include (first|all|separate) separate >
EMPTY
<axf:output-volume-info initial-volume-number="2" format="-1" bookmark-include="separate" /> <fo:page-sequence> PAGE-SEQUENCE-1 ... </fo:page-sequence> <fo:page-sequence> PAGE-SEQUENCE-2 ... </fo:page-sequence> <fo:page-sequence axf:output-volume-break="true"> PAGE-SEQUENCE-3 ... </fo:page-sequence>
Effective only when outputting to files. It’s not available for printing or stream output. At that time the file name should be given. The file names of separate volumes are given automatically based on the output file names. This process is done by inputting the strings formatted by the format property right before the file extension of the output file name. In the above example, when document.pdf is given to the file name, PAGE-SEQUENCE-1 and PAGE-SEQUENCE-2 are outputted to document-2.pdf, PAGE-SEQUENCE-3 is outputted to document-3.pdf.
The numeric value applied to the format property can be given by the axf:initial-volume-number property as the initial value. The format property is the same as "7.24.1. format" in the XSL-FO specification.
The volume is separated by the axf:output-volume-break property specified to fo:page-sequence. If the axf:output-volume-filename property is specified, only the separated volumes can be outputted with the specified file name.
The book mark of PDF in multi separate volume can be set by the axf:bookmark-include from the following options.
The Ruby is based on CSS3 Ruby Module.
CAUTION: Not documented yet.
This is additional information, and it has the meaning in an electronic environment. It is not output to printed matter usually.
The axf:outline-color specifies the color which appears as a title of bookmarks.
Value: | <color> |
Initial: | the value of the 'color' property |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
The axf:outline-expand specifies whether to display the lower hierarchy of bookmark items or not.
Value: | true | false |
Initial: | true |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
True specifies to display the lower hierarchy in the expanded state. False specifies to display in the collapsed state.
The axf:outline-font-style specifies the font style which appears as a title of bookmarks.
Value: | normal | italic |
Initial: | normal |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Specifies normal style.
Specifies italic.
The axf:outline-font-weight specifies the font weight which appears as a title of bookmarks.
Value: | normal | bold |
Initial: | normal |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Specifies normal weight.
Specifies bold weight.
The axf:outline-group groups bookmark items, and outputs them collectively.
Value: | <string> |
Initial: | empty string |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
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.
Value: | <number> |
Initial: | 0 |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
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.
Value: | <string> |
Initial: | empty string |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
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.
This aims at the application to PDF. PDF links can be created easily by using fo:basic-link .
PDF links are classified either as an internal link to a specified position in the PDF document, or as a external link to an external document. The internal-destination property of fo:basic-link indicates a link to a position in the same document. The external-destination property indicates a link to an external document. Below are the examples of both.
The external link specified by the relative address is transformed into either 'Open the file' or 'World Wide Web link'. The external link specified by the absolute address is always transformed into 'World Wide Web link'.
Furthermore, it's possible to specify professional links as follows. For further understanding see also PDF Reference Manual by Adobe Systems Incorporated. The professional links are not available with XSL Formatter V3.2 Lite.
The setting of external-destination for the external link in PDF conforms to the following specification of PDF parameters. Not all the parameters are effective. The invalid parameters are ignored.
This specification provides the following examples.
Only the following parameters are effective. The case sensitivity is ignored.
For example, it's invalid to specify fitH, fitR and fitBH for the external link. These are effective only with the internal link. If the required values for the PDF parameters are omitted in fitH, etc., the values are accounted as 0.
Specifies the action of external link.
Value: | gotor | launch | uri | auto |
Initial: | auto |
Applies to: | fo:basic-link, block level formatting object |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Opens the link destination by the "GoToR" action as PDF. The URI of the destination is regarded as PDF.
Opens the link destination by the "Launch" action as the file.
Opens the link destination by the "URI" action as URI (World Wide Web).
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.
Specifies the type of destination for the external link. These are the types of destination for PDF as the external link.
Value: | <string> |
Initial: | empty string |
Applies to: | block level formatting object |
Inherited: | no |
Percentages: | N/A |
The destination type has the following options. If nothing specified, it's accounted as axf:destination-type="xyz-top". The case sensitivity is ignored.
Destination Type of PDF | How to specify axf:destination-type | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[page /XYZ left top zoom] | The value of left/top is calculated automatically. However it's possible to specify null or non-null explicitly. The user can specify the arbitrary value for zoom.
|
||||||||||
[page /Fit] |
|
||||||||||
[page /FitH top] | The value of top is calculated automatically. Effective only to specify in the internal link.
|
||||||||||
[page /FitV left] | The value of left is calculated automatically.
|
||||||||||
[page /FitR left bottom right top] | The value of left/bottom/right/top is calculated automatically. Effective only to specify in the internal link.
|
||||||||||
[page /FitB] |
|
||||||||||
[page /FitBH top] | The value of top is calculated automatically. Effective only to specify in the internal link.
|
||||||||||
[page /FitBV left] | The value of left is calculated automatically.
|
Sets the external link in the PDF bookmark.
Value: | <uri-specification> |
Initial: | empty string |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Specifies the URI of the link destination.
Sets the internal link in the PDF bookmark.
Value: | empty string | <idref> | <number-with-fragment> |
Initial: | empty string |
Applies to: | block-level formatting objects |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Specifies the ID of the link destination.
Specifies the page number of the link destination. This string is simpe numeric characters or the following string that combines numeric characters and fragment with #.
This aims at the application to PDF.
Specifies how to include bookmarks in multi separate volume.
Value: | first | all | separate |
Initial: | separate |
Applies to: | axf:output-volume-info |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Adds a bookmark to the first separate volume.
Adds bookmarks to all the separate volumes.
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.
Specifies the initial volume number in multi separate volume.
Value: | <number> |
Initial: | 1 |
Applies to: | axf:output-volume-info |
Inherited: | no |
Percentages: | N/A |
This value is applied for the format property and utilized for the file name to output.
Separates the file in multi volume.
Value: | true | false |
Initial: | false |
Applies to: | fo:page-sequence |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Separates the volume newly from this fo:page-sequence.
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.
Specifies the document file name in multi separate volume.
Value: | <string> |
Initial: | empty string |
Applies to: | fo:page-sequence |
Inherited: | no |
Percentages: | N/A |
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.
The axf:footnote-align specifies the method to layout the footnote.
Value: | auto | before | after | inline |
Initial: | auto |
Applies to: | fo:region-body, fo:footnote |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Footnotes are placed automatically. Footnotes are the usual arrangement. When the text is one column, side notes are arranged with an anchor position, and in the case of two or more columns, side notes are arranged near by the before side.
Side notes are arranged near by the before side. In the case of usual foot notes which are not side notes, foot notes are arranged immediately after the text in a page.
Side notes are arranged near by the after side. In the case of usual foot notes which are not side notes, foot notes are arranged at the last of a page.
Side notes are arranged in order in the inline direction. Two or more items can be arranged in one line. When specified as side notes, it is the same as auto.
Specifies the method of arrangement of footnotes or side notes. When it is side notes (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. If inline is specified to the footnote, the footnote is put in order in the inline direction.
The axf:footnote-position specifies the location to layout the footnote.
Value: | page | odd-page | start | end | inside | outside | column | inside-column | outside-column | page-sequence | document |
Initial: | page |
Applies to: | fo:region-body, fo:footnote |
Inherited: | no |
Percentages: | N/A |
Values have the following meanings.
Footnotes are placed at the bottom of each page in region-body. This is the standard layout of XSL 1.0 specification.
Footnotes are placed at the bottom of each odd-page in region-body.
Footnotes are placed at each page in region-start.
Footnotes are placed at each page in region-end.
Footnotes are placed at each even-page in region-end and each odd-page in region-start.
Footnotes are placed at each even-page in region-start and each odd-page in region-end.
Footnotes are placed at the bottom of each column.
Footnotes are placed at the bottom of the last column of even-page or the first column of odd-page.
Footnotes are placed at the bottom of the first column of even-page or the last column of odd-page.
Footnotes are placed at the end of page-sequence.
Footnotes are placed at the end of the document.
It is possible to arrange footnotes inside the region-start or the region-end (these notes are called side notes). Besides specifying them to fo:region-body, it is also effective to specify to individual fo:footnote. It is possible to make several types of notes intermingled by this extension.
Specifies whether to omit the same footnote.
Value: | true | false | inherit |
Initial: | false |
Applies to: | fo:footnote |
Inherited: | yes |
Percentages: | N/A |
Suppresses the duplicated footnotes in the same footnote area, when the same footnote is allocated in two or more places.
The revision bar is shown upper than the border or the column rule.
The axf:revision-bar-color specifies the color of the revision bar.
Value: | <color> | inherit |
Initial: | the value of the 'color' property |
Applies to: | all block-level and inline-level formatting objects which are descendants of fo:flow |
Inherited: | yes |
Percentages: | N/A |
The axf:revision-bar-offset specifies the offset of the revision bar.
Value: | <space> | inherit |
Initial: | 0 |
Applies to: | all block-level and inline-level formatting objects which are descendants of fo:flow |
Inherited: | yes |
Percentages: | N/A |
The axf:revision-bar-position specifies the position of the revision bar.
Value: | start | end | inside | outside | alternate | both | inherit |
Initial: | start |
Applies to: | all block-level and inline-level formatting objects which are descendants of fo:flow |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
Places revision bar at start-edge.
Places revision bar at end-edge.
Places revision bar at start-edge on odd pages, at end-edge on even pages.
Places revision bar at end-edge on odd pages, at start-edge on even pages.
Places revision bar at end-edge in the last column of multi-column layout, except for the last column, places it at start-edge.
Places revision bar at start-edge and end-edge.
The axf:revision-bar-style specifies the style of the revision bar.
Value: | <border-style> | inherit |
Initial: | none |
Applies to: | all block-level and inline-level formatting objects which are descendants of fo:flow |
Inherited: | yes |
Percentages: | N/A |
The axf:revision-bar-width specifies the width of the revision bar.
Value: | <border-width> | inherit |
Initial: | medium |
Applies to: | all block-level and inline-level formatting objects which are descendants of fo:flow |
Inherited: | yes |
Percentages: | N/A |
This property is based on CSS3 Multi-column layout. The column rule is shown upper than the border, lower than the revision bar.
The axf:column-rule-align specifies the alignment of the column rule.
Value: | top | middle | bottom | inherit |
Initial: | middle |
Applies to: | fo:region-body |
Inherited: | yes |
Percentages: | N/A |
These are not present in CSS3 Multi-column layout.
The axf:column-rule-color specifies the color of the column rule.
Value: | <color> | inherit |
Initial: | the value of the 'color' property |
Applies to: | fo:region-body |
Inherited: | no |
Percentages: | N/A |
See CSS3 Multi-column layout.
The axf:column-rule-length specifies the length of the column rule.
Value: | <length> | inherit |
Initial: | 100% |
Applies to: | fo:region-body |
Inherited: | no |
Percentages: | refer to the size of the column |
These are not in CSS3 Multi-column layout.
The axf:column-rule-style specifies the style of the column rule.
Value: | <border-style> | inherit |
Initial: | none |
Applies to: | fo:region-body |
Inherited: | no |
Percentages: | N/A |
See CSS3 Multi-column layout.
The axf:column-rule-width specifies the width of the column rule.
Value: | <border-width> | inherit |
Initial: | medium |
Applies to: | fo:region-body |
Inherited: | no |
Percentages: | N/A |
See CSS3 Multi-column layout.
These properties draw the diagonal border in the area such as the table cell where the border can be specified. The diagonal border by axf:diagonal-border-* is drawn from the edge of before-start to the edge of after-end. The diagonal border by axf:reverse-diagonal-border-* is drawn from the edge of before-end to the edge of after-start. When the writing-mode="lr-tb" is specified, the diagonal border is drawn as follows. When the writing-mode="rl-tb" or "tb-rl" is specified, it is drawn in a reverse way.
The axf:diagonal-border-color specifies the color of the diagonal border.
Value: | <color> | inherit |
Initial: | the value of the 'color' property |
Applies to: | all FOs which can have borders |
Inherited: | yes |
Percentages: | N/A |
The axf:diagonal-border-style specifies the style of the diagonal border.
Value: | <border-style> | inherit |
Initial: | none |
Applies to: | all FOs which can have borders |
Inherited: | no |
Percentages: | N/A |
The axf:diagonal-border-width specifies the width of the diagonal border.
Value: | <border-width> | inherit |
Initial: | medium |
Applies to: | all FOs which can have borders |
Inherited: | yes |
Percentages: | N/A |
The axf:reverse-diagonal-border-color specifies the color of the reverse diagonal border.
Value: | <color> | inherit |
Initial: | the value of the 'color' property |
Applies to: | all FOs which can have borders |
Inherited: | yes |
Percentages: | N/A |
The axf:reverse-diagonal-border-style specifies the style of the reverse diagonal border.
Value: | <border-style> | inherit |
Initial: | none |
Applies to: | all FOs which can have borders |
Inherited: | no |
Percentages: | N/A |
The axf:reverse-diagonal-border-width specifies the width of the reverse diagonal border.
Value: | <border-width> | inherit |
Initial: | medium |
Applies to: | all FOs which can have borders |
Inherited: | yes |
Percentages: | N/A |
The radii of quater ellipse are specified. This property is based on CSS3 Border : 3.3 The 'border-radius' properties.
Value: | <length> <length>? |
Initial: | 0 |
Applies to: | all FOs which can have borders |
Inherited: | no |
Percentages: | N/A |
The first value is the horizontal radius (or vertical if the 'writing-mode' is vertical). If the second length is omitted it is equal to the first. If either length is less or equal zero, the corner is square, not rounded.
See CSS3 Border.
The box shadow is specified. This property is based on CSS3 Border : 3.6 The 'box-shadow' property.
Value: | none | [ <length> <length> <length>? || <color> ] [ , <length> <length> <length>? || <color> ]+ |
Initial: | none |
Applies to: | all FOs which can have borders |
Inherited: | no |
Percentages: | N/A |
See CSS3 Border.
The axf:background-color sets the background color of fo:simple-page-master.
Value: | <color> | transparent |
Initial: | transparent |
Applies to: | fo:simple-page-master |
Inherited: | no |
Percentages: | N/A |
The axf:background-image sets the background image of fo:simple-page-master.
Value: | <uri-specification> | none |
Initial: | none |
Applies to: | fo:simple-page-master |
Inherited: | no |
Percentages: | N/A |
Specifies the assumed page number.
Value: | <number> |
Initial: | N/A |
Applies to: | all formatting objects |
Inherited: | yes |
Percentages: | N/A |
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.
Specifies the assumed page number prefix.
Value: | <string> |
Initial: | N/A |
Applies to: | all formatting objects |
Inherited: | yes |
Percentages: | N/A |
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.
Specifies the origin of the page number.
Value: | <idref> |
Initial: | none |
Applies to: | fo:page-number-citation |
Inherited: | no |
Percentages: | N/A |
ID for the origin of the page number can be specified in 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.
The axf:page-number-prefix sets the prefix of page number.
Value: | <string> |
Initial: | empty string |
Applies to: | fo:page-sequence |
Inherited: | no |
Percentages: | N/A |
Specifies the prefix of page number. Specified string will be outputted befor the page number by fo:page-number and fo:page-number-citation.
Also this string will be used as page label in PDF.
The following shows the mapping of the format properties and the style of the page number in PDF.
When the format property is other than the above, the style of the number in PDF will be decimal Latin number.
<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>
The axf:physical-page-number gets physical page number.
Value: | true | false | inherit |
Initial: | false |
Applies to: | fo:page-number, fo:page-number-citation |
Inherited: | no |
Percentages: | N/A |
The value of initial-page-number property is disregarded and the physical page number that is not affected by page-sequence is obtained. In order to obtain the total number of pages, ID is given to the last page, and it is performed as follows.
<fo:page-number-citation ref-id="lastpage" axf:physical-page-number="true"/>
The axf:suppress-duplicate-page-number specifies to delete the duplicated page numbers.
Value: | true | false |
Initial: | false |
Applies to: | all formatting objects |
Inherited: | yes |
Percentages: | N/A |
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.
Specifies the append-non-starter-characters in CJK.
Value: | <string> |
Initial: | empty string |
Applies to: | fo:page-sequence |
Inherited: | no |
Percentages: | N/A |
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.
Specifies the append-non-end-of-characters in CJK.
Value: | <string> |
Initial: | empty string |
Applies to: | fo:page-sequence |
Inherited: | no |
Percentages: | N/A |
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.
Specifies the except-non-starter-characters in CJK.
Value: | <string> |
Initial: | empty string |
Applies to: | fo:page-sequence |
Inherited: | no |
Percentages: | N/A |
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:except-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.
Specifies the except-non-end-of-characters in CJK.
Value: | <string> |
Initial: | empty string |
Applies to: | fo:page-sequence |
Inherited: | no |
Percentages: | N/A |
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:except-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.
Specifies the position of font emphasizing. This property is based on CSS3 Font emphasis.
Value: | before | after |
Initial: | before |
Applies to: | fo:character, fo:inline |
Inherited: | yes |
Percentages: | N/A |
Specifies the style of font emphasis. This property is based on CSS3 Font emphasis.
Value: | none | accent | dot | circle | disc |
Initial: | none |
Applies to: | fo:character, fo:inline |
Inherited: | yes |
Percentages: | N/A |
The axf:hanging-punctuation specifies whether to hang Japanese punctuation characters or not. This property is based on CSS3 Text Module: 11.2. Hanging punctuation.
Value: | none | end | inherit |
Initial: | none |
Applies to: | fo:block |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
Punctuation characters are not subject to hang.
Punctuation characters at end of line can hang.
Punctuation characters to be hanged are four Japanese punctuations (U+3001, U+3002, U+FF0C, U+FF0E).
The axf:kerning-mode specifies whether to process the kerning for punctuation. This property is based on CSS3 Text Module: 8.5. Text kerning.
Value: | none | [ pair || contextual ] | auto | inherit |
Initial: | auto |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
Adjacent full width punctuation characters are not trimmed.
The pair kerning is processed.
The space between a full width punctuation and a full width character in Japanese is trimmed.
Full width punctuation characters are treated the same as full width close parenthesis. By specifying axf:kerning-mode="contextual" the space between full width close parenthesis and non punctuation characters is not condensed. The space can be condensed by setting the value of axf:punctuation-spacing less than the default.
Dependent on the system setting.
Full width punctuation open parenthesis processed by axf:kerning-mode="contextual" are:
2018;QU # LEFT SINGLE QUOTATION MARK ‘ 201C;QU # LEFT DOUBLE QUOTATION MARK “ 3008;OP # LEFT ANGLE BRACKET 〈 300A;OP # LEFT DOUBLE ANGLE BRACKET 《 300C;OP # LEFT CORNER BRACKET 「 300E;OP # LEFT WHITE CORNER BRACKET 『 3010;OP # LEFT BLACK LENTICULAR BRACKET 【 3014;OP # LEFT TORTOISE SHELL BRACKET 〔 3016;OP # LEFT WHITE LENTICULAR BRACKET 〖 3018;OP # LEFT WHITE TORTOISE SHELL BRACKET 〘 301A;OP # LEFT WHITE SQUARE BRACKET 〚 301D;OP # REVERSED DOUBLE PRIME QUOTATION MARK 〝 FF08;OP # FULLWIDTH LEFT PARENTHESIS ( FF3B;OP # FULLWIDTH LEFT SQUARE BRACKET [ FF5B;OP # FULLWIDTH LEFT CURLY BRACKET { FF5F;OP # FULLWIDTH LEFT WHITE PARENTHESIS ⦅
Full width punctuation close parenthesis processed by axf:kerning-mode="contextual" are:
2019;QU # RIGHT SINGLE QUOTATION MARK ’ 201D;QU # RIGHT DOUBLE QUOTATION MARK ” 3009;CL # RIGHT ANGLE BRACKET 〉 300B;CL # RIGHT DOUBLE ANGLE BRACKET 》 300D;CL # RIGHT CORNER BRACKET 」 300F;CL # RIGHT WHITE CORNER BRACKET 』 3011;CL # RIGHT BLACK LENTICULAR BRACKET 】 3015;CL # RIGHT TORTOISE SHELL BRACKET 〕 3017;CL # RIGHT WHITE LENTICULAR BRACKET 〗 3019;CL # RIGHT WHITE TORTOISE SHELL BRACKET 〙 301B;CL # RIGHT WHITE SQUARE BRACKET 〛 FF09;CL # FULLWIDTH RIGHT PARENTHESIS ) FF3D;CL # FULLWIDTH RIGHT SQUARE BRACKET ] FF5D;CL # FULLWIDTH RIGHT CURLY BRACKET } FF60;CL # FULLWIDTH RIGHT WHITE PARENTHESIS ⦆
Full width punctuations processed by axf:kerning-mode="contextual" are:
3001;CL # IDEOGRAPHIC COMMA 、 3002;CL # IDEOGRAPHIC FULL STOP 。 FF0C;CL # FULLWIDTH COMMA , FF0E;CL # FULLWIDTH FULL STOP .
Full width middle dots processed by axf:kerning-mode="contextual" are:
30FB;NS # KATAKANA MIDDLE DOT ・ FF1A;NS # FULLWIDTH COLON : FF1B;NS # FULLWIDTH SEMICOLON ;
The font size of the pair kerning is specified. This property is based on CSS3 Text Module: 8.5. Text kerning.
Value: | auto | <length> | inherit |
Initial: | auto |
Applies to: | all block-level and inline-level formatting objects which are descendants of fo:flow |
Inherited: | yes |
Percentages: | refer to the font size |
When auto is specified, it is pair kerning (axf:kerning-mode="pair") regardless of the size. When "length" is specified, the pair kerning is done if it is larger than the size.
The axf:line-break specifies the method of line breaking. This property is based on CSS3 Text Module: 6.2. Line breaking.
Value: | normal | strict | inherit |
Initial: | normal |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
Nonstarter characters in JIS X 4051 and other small Kana letters in Japanese (U+3095, U+3096, U+31F0 to U+31FF) 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.
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-4.0.0.txt is as follows. [JIS] is classified into the Nonstarter character in JIS X 4051.
0E5A;NS # THAI CHARACTER ANGKHANKHU ๚ 0E5B;NS # THAI CHARACTER KHOMUT ๛ 17D4;NS # KHMER SIGN KHAN ។ 17D6;NS # KHMER SIGN CAMNUC PII KUUH ៖ 17D7;NS # KHMER SIGN LEK TOO ៗ 17D8;NS # KHMER SIGN BEYYAL ៘ 17D9;NS # KHMER SIGN PHNAEK MUAN ៙ 17DA;NS # KHMER SIGN KOOMUUT ៚ 203C;NS # DOUBLE EXCLAMATION MARK ‼ 3005;NS # IDEOGRAPHIC ITERATION MARK 々 [JIS] 301C;NS # WAVE DASH 〜 303B;NS # VERTICAL IDEOGRAPHIC ITERATION MARK 〻 303C;NS # MASU MARK 〼 3041;NS # HIRAGANA LETTER SMALL A ぁ [JIS] 3043;NS # HIRAGANA LETTER SMALL I ぃ [JIS] 3045;NS # HIRAGANA LETTER SMALL U ぅ [JIS] 3047;NS # HIRAGANA LETTER SMALL E ぇ [JIS] 3049;NS # HIRAGANA LETTER SMALL O ぉ [JIS] 3063;NS # HIRAGANA LETTER SMALL TU っ [JIS] 3083;NS # HIRAGANA LETTER SMALL YA ゃ [JIS] 3085;NS # HIRAGANA LETTER SMALL YU ゅ [JIS] 3087;NS # HIRAGANA LETTER SMALL YO ょ [JIS] 308E;NS # HIRAGANA LETTER SMALL WA ゎ [JIS] 3095;NS # HIRAGANA LETTER SMALL KA ゕ 3096;NS # HIRAGANA LETTER SMALL KE ゖ 309B;NS # KATAKANA-HIRAGANA VOICED SOUND MARK ゛ 309C;NS # KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK ゜ 309D;NS # HIRAGANA ITERATION MARK ゝ [JIS] 309E;NS # HIRAGANA VOICED ITERATION MARK ゞ [JIS] 30A0;NS # KATAKANA-HIRAGANA DOUBLE HYPHEN ゠ 30A1;NS # KATAKANA LETTER SMALL A ァ [JIS] 30A3;NS # KATAKANA LETTER SMALL I ィ [JIS] 30A5;NS # KATAKANA LETTER SMALL U ゥ [JIS] 30A7;NS # KATAKANA LETTER SMALL E ェ [JIS] 30A9;NS # KATAKANA LETTER SMALL O ォ [JIS] 30C3;NS # KATAKANA LETTER SMALL TU ッ [JIS] 30E3;NS # KATAKANA LETTER SMALL YA ャ [JIS] 30E5;NS # KATAKANA LETTER SMALL YU ュ [JIS] 30E7;NS # KATAKANA LETTER SMALL YO ョ [JIS] 30EE;NS # KATAKANA LETTER SMALL WA ヮ [JIS] 30F5;NS # KATAKANA LETTER SMALL KA ヵ [JIS] 30F6;NS # KATAKANA LETTER SMALL KE ヶ [JIS] 30FB;NS # KATAKANA MIDDLE DOT ・ 30FC;NS # KATAKANA-HIRAGANA PROLONGED SOUND MARK ー [JIS] 30FD;NS # KATAKANA ITERATION MARK ヽ [JIS] 30FE;NS # KATAKANA VOICED ITERATION MARK ヾ [JIS] 31F0;NS # KATAKANA LETTER SMALL KU ㇰ 31F1;NS # KATAKANA LETTER SMALL SI ㇱ 31F2;NS # KATAKANA LETTER SMALL SU ㇲ 31F3;NS # KATAKANA LETTER SMALL TO ㇳ 31F4;NS # KATAKANA LETTER SMALL NU ㇴ 31F5;NS # KATAKANA LETTER SMALL HA ㇵ 31F6;NS # KATAKANA LETTER SMALL HI ㇶ 31F7;NS # KATAKANA LETTER SMALL HU ㇷ 31F8;NS # KATAKANA LETTER SMALL HE ㇸ 31F9;NS # KATAKANA LETTER SMALL HO ㇹ 31FA;NS # KATAKANA LETTER SMALL MU ㇺ 31FB;NS # KATAKANA LETTER SMALL RA ㇻ 31FC;NS # KATAKANA LETTER SMALL RI ㇼ 31FD;NS # KATAKANA LETTER SMALL RU ㇽ 31FE;NS # KATAKANA LETTER SMALL RE ㇾ 31FF;NS # KATAKANA LETTER SMALL RO ㇿ FE54;NS # SMALL SEMICOLON ﹔ FE55;NS # SMALL COLON ﹕ FF1A;NS # FULLWIDTH COLON : FF1B;NS # FULLWIDTH SEMICOLON ; FF65;NS # HALFWIDTH KATAKANA MIDDLE DOT ・ FF67;NS # HALFWIDTH KATAKANA LETTER SMALL A ァ [JIS] FF68;NS # HALFWIDTH KATAKANA LETTER SMALL I ィ [JIS] FF69;NS # HALFWIDTH KATAKANA LETTER SMALL U ゥ [JIS] FF6A;NS # HALFWIDTH KATAKANA LETTER SMALL E ェ [JIS] FF6B;NS # HALFWIDTH KATAKANA LETTER SMALL O ォ [JIS] FF6C;NS # HALFWIDTH KATAKANA LETTER SMALL YA ャ [JIS] FF6D;NS # HALFWIDTH KATAKANA LETTER SMALL YU ュ [JIS] FF6E;NS # HALFWIDTH KATAKANA LETTER SMALL YO ョ [JIS] FF6F;NS # HALFWIDTH KATAKANA LETTER SMALL TU ッ [JIS] FF70;NS # HALFWIDTH KATAKANA-HIRAGANA PROLONGED SOUND MARK ー [JIS] FF9E;NS # HALFWIDTH KATAKANA VOICED SOUND MARK ゙ FF9F;NS # HALFWIDTH KATAKANA SEMI-VOICED SOUND MARK ゚
The axf:line-break-at-punctuation-in-word specifies the controls of the line breaking after the symbols in the alphanumeric characters.
Value: | loose | normal | restrict | strict | auto | inherit |
Initial: | auto |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
This is dependent on UAX#14: Line Breaking Properties.
Restricts line breaks between the alphabetic characters and the symbolic characters classified as IS. The other symbolic characters conform to UAX#14. Originally, the line breaking between the symbols and the numeric characters is prohibited by UAX#14.
When the alphanumeric string before and after the IS symbolic characters is relatively long and is not hyphenated, the line breaks after the IS symbolic characters. When the string is short, the line does not break actively because of the possibility of the abbreviation.
Restricts line breaks between the symbols and the alphanumeric characters. When the alphanumeric string before and after the symbols is relatively long and is not hyphenated, the line breaks after the symbols. When the string is short, the line does not break actively because of the possibility of the abbreviation.
Prohibits line breaks between symbolic characters and alphanumeric characters.
Dependent on the system setting.
Symbolic characters described here means the characters that belong to the following character class in UAX#14. Line breaking between the symbolic characters and the PR Prefix (Numeric) is prohibited according to UAX#14.
IS | Infix Separator (Numeric) |
---|
002C;IS # COMMA , 002E;IS # FULL STOP . 003A;IS # COLON : 003B;IS # SEMICOLON ; 0589;IS # ARMENIAN FULL STOP ։ 060D;IS # ARABIC DATE SEPARATOR 2044;IS # FRACTION SLASH ⁄
PO | Postfix (Numeric) |
---|
0025;PO # PERCENT SIGN % 00A2;PO # CENT SIGN ¢ 00B0;PO # DEGREE SIGN ° 2030;PO # PER MILLE SIGN ‰ 2031;PO # PER TEN THOUSAND SIGN ‱ 2032;PO # PRIME ′ 2033;PO # DOUBLE PRIME ″ 2034;PO # TRIPLE PRIME ‴ 2035;PO # REVERSED PRIME ‵ 2036;PO # REVERSED DOUBLE PRIME ‶ 2037;PO # REVERSED TRIPLE PRIME ‷ 20A7;PO # PESETA SIGN ₧ 2103;PO # DEGREE CELSIUS ℃ 2109;PO # DEGREE FAHRENHEIT ℉ 2126;PO # OHM SIGN Ω FDFC;PO # RIAL SIGN ﷼ FE6A;PO # SMALL PERCENT SIGN ﹪ FF05;PO # FULLWIDTH PERCENT SIGN % FFE0;PO # FULLWIDTH CENT SIGN ¢
An alphanumeric character described here means the characters that belong to the following character class in UAX#14.
AL | Ordinary Alphabetic and Symbol |
---|---|
NU | Numeric |
The axf:overflow-condense specifies how to condense the overflowed text within the region.
Value: | [ letter-spacing || word-spacing || font-stretch || font-size || line-height ] | auto | inherit |
Initial: | auto |
Applies to: | all block-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
Condenses the text by adjusting the letter spacing.
Condenses the text by adjusting the word spacing.
Condenses the text by adjusting the font width.
Condenses the text by adjusting the font size.
Condenses the text by adjusting the line height.
Dependent on the system setting.
Condensing the text within the region can be specified with the properties of overflow="condense". The adjustment for condensing the text includes both the inline progression direction and the block progression direction. The system will process the specified method by combining the methods considered as suitable.
An alternative character string for the specified overflow text.
Value: | <string> |
Initial: | depends on system |
Applies to: | all block-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
When overflow="replace" is specified, the overflow text is replaced by repeating the specified string.
The axf:punctuation-spacing specifies the spacing between a full width punctuation and a full width character in Japanese.
Value: | <length> | inherit |
Initial: | 0.5em |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | refer to the font size |
This space is used in axf:kerning-mode="contextual".
The axf:punctuation-trim specifies whether to treat full width punctuations as half width. This property is based on CSS3 Text Module: 8.3. Punctuation trimming.
Value: | none | start | end | both | auto | inherit |
Initial: | auto |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
Punctuation characters are not trimmed.
Punctuation characters (open parenthesis etc.) at start of line are trimmed.
Punctuation characters (close parenthesis etc.) at end of line are trimmed.
Punctuation characters at start and end of line are trimmed.
Dependent on the system setting.
The axf:text-autospace specifies whether to add space surrounding ideographic glyphs or not. This property is based on CSS3 Text Module: 8.4. Adding space.
Value: | none | [ ideograph-numeric || ideograph-alpha ] | auto | inherit |
Initial: | auto |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
Space is not added.
Space is added between ideograph character and non-ideographic number character.
Space is added between ideograph character and non-ideographic alphabet character.
Dependent on the system setting.
The axf:text-autospace-width specifies the width for axf:text-autospace.
Value: | <length> | inherit |
Initial: | 0.25em |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | refer to the font size |
This space is used in axf:text-autospace.
The axf:text-kashida-space specifies the ratio of the kashida expansion size to the white space expansion size. This property is based on CSS3 Text Module: 4.6. Kashida effect.
Value: | <percentage> | auto |
Initial: | auto |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | yes |
Values have the following meanings.
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%.
Dependent on the system setting.
The axf:vertical-underline-side specifies on which side of the text to put underline in vertical writing-mode.
Value: | left | right | auto | inherit |
Initial: | auto |
Applies to: | all block-level and inline-level formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
The underline is placed on the left side.
The underline is placed on the right side.
Dependent on the system setting.
axf:vertical-underline-side="auto" で、システムの既定値も自動のときは、languageプロパティでの言語が日本語(ja)または韓国語(ko)のときは右側に、その他の言語では左側に配置されます。
CAUTION: Not documented yet.
The position of the marker of the list is specified. This property is based on CSS3 Lists Module: 7. Marker Position.
Value: | inside | outside | inherit |
Initial: | outside |
Applies to: | all formatting objects |
Inherited: | yes |
Percentages: | N/A |
Values have the following meanings.
The position of the marker is an inside in the block.
The position of the marker is an outside in the block.
The axf:base-uri specifies the location which becomes the base of relative URI.
Value: | <uri-specification> |
Initial: | empty string |
Applies to: | all formatting objects |
Inherited: | yes |
Percentages: | N/A |
The axf:base-uri is applied to all relative URI in a document. When making links using fo:basic-link and specify relative URI, the location that is specified using axf:base-uri is interpreted to be base URI. If this property is omitted or this has empty string, the base location is interpreted as current XML file.
The axf:soft-hyphen-treatment specifies to output SOFT HYPEN.
Value: | auto | preserve | inherit |
Initial: | auto |
Applies to: | all formatting objects |
Inherited: | yes |
Percentages: | N/A |
Generally SOFT HYPHEN (U+00AD) is displayed only when the line breaks and not displayed when the line does not break. However in this processing, it is often the case that the glyph assigned to U+00AD may not printed when the fonts such as pictographic characters are used. Possible to eliminate this problem by using the axf:soft-hyphen-treatment property.
Values have the following meanings.
SOFT HYPHEN is deleted except when needed for line breaking. (normal)
SOFT HYPHEN is not deleted and the target glyph is output.
The axf;justify-nbsp specifies whether to justify NON-BREAKING SPACE or not.
Value: | true | false | inherit |
Initial: | true |
Applies to: | all formatting objects |
Inherited: | yes |
Percentages: | N/A |
Generally, NON-BREAKING SPACE (U+00A0) is intended for Justification. The axf:justify-nbsp property can be used when you want to check off U+00A0 form Justify.
Values have the following meanings.
NON-BREAKING SPACE is included for justification.
NON-BREAKING SPACE is not included for justification.
Following bold values are extended.
Value: | start | end | left | right | inside | outside | both | none | inherit |
Values have the following meanings.
Interpreted as "start" on odd pages, as "end" on even pages.
Interpreted as "end" on odd pages, as "start" on even pages.
Following bold values are extended.
Value: | before | start | end | left | right | inside | outside | after | in-column | mid-column | none | inherit |
Values have the following meanings.
Places float area at start-edge on odd pages, at end-edge on even pages.
Places float area at end-edge on odd pages, at start-edge on even pages.
Places float area at after side of the area.
The place of float area is put on a full column. This value is based on CSS3 Multi-column layout: 10. Floating in and between columns.
The place of float area is put between columns. This value is based on CSS3 Multi-column layout: 10. Floating in and between columns.
Following bold values are extended.
Value: | normal | wider | narrower | ultra-condensed | extra-condensed | condensed | semi-condensed | semi-expanded | expanded | extra-expanded | ultra-expanded | <percentage> | <number> | inherit |
Values have the following meanings.
Specifies the percentage against the font width.
Equivalent to <percentage> / 100.
Following bold values are extended.
Value: | empty string | <idref> | <number-with-fragment> |
Values have the following meanings.
Effective for the internal link in PDF. indicates the page number of the link destination. This string is simpe numeric characters or the following string that combines numeric characters and fragment with #.
Following bold values are extended.
Value: | visible | hidden | scroll | replace | condense | error-if-overflow | auto | inherit |
Values have the following meanings.
The string specified by axf:overflow-replace is repeated in a full area. When the specified string is empty, the string of the area is replaced with an empty string. The original string is discarded.
Condenses the overflowed text within the region. How to condense the text can be specified by axf:overflow-condense.