XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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. no-LT

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'. This property is not available with XSL Formatter V4.3 Lite.

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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 Lite.

Specifies the title of the annotation. no-LT

This property is not available with XSL Formatter V4.3 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 XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 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 XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 Lite.

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

This property is not available with XSL Formatter V4.3 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.