<axf:output-volume-info>

(Auszug aus "XSL-FO ― Die Referenz" von Manuel Montero Pineda & Steffen Herkert, 2016, dpunkt.verlag)

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

Category Document Information for PDF Output

AH Formatter V6.3 makes it possible to output PDF in Multi Separate Volume. These features are not available in CSS. These features are not available with AH Formatter V6.3 Lite.

<axf:output-volume-info>

Common Usage: Makes it possible to output PDF in separate volume per fo:page-sequence when outputting the formatted result.
Areas:None.
Constraints:

<!ELEMENT axf:output-volume-info EMPTY> <!ATTLIST axf:output-volume-info initial-volume-number NUMBER "1"> <!ATTLIST axf:output-volume-info format CDATA "1"> <!ATTLIST axf:output-volume-info bookmark-include (first|all|separate) "separate">

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.
Contents:EMPTY
Examples:

<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 by GUI, command line parameter or etc. 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.26.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.

  • Adds a bookmark to the first separate volume only.
  • Adds bookmarks to all the separate volumes.
  • Adds each bookmark to each separate volume.

The following conditions are required for the actual separate volume.

  • The <axf:output-volume-info> element should be included in FO.
  • The following items are set in each interface.
    GUIMulti Volume should be checked in the PDF Output Dialog.
    Command-lineThe -multivol parameter should be specified.
    .NETtrue should be specified to the MultiVolume property.
    COMtrue should be specified to the MultiVolume property.
    JavaThe separate volume should be specified by XfoObj::setMultiVolume().
    C/C++The separate volume should be specified by XfoObj::setMultiVolume().

axf:bookmark-include

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

Value:first | all | separate
Initial:separate
Applies to:axf:output-volume-info
Inherited:no
Percentages:N/A

Values have the following meanings.

firstAdds a bookmark to the first separate volume.
allAdds bookmarks to all the separate volumes.
separateAdds 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 V6.3 Lite.

axf:document-info-include

Specifies how to include document information in multi separate volume. [no-LT]

Value:first | all
Initial:first
Applies to:axf:output-volume-info
Inherited:no
Percentages:N/A

Values have the following meanings.

firstAdds document information to the first separate volume.
allAdds document information to all the separate volumes.

Please refer to <axf:document-info>. This property is not available with AH Formatter V6.3 Lite.

axf:initial-volume-number

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

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 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 V6.3 Lite.

axf:output-volume-break

Separates the file in multi volume. [no-LT]

Value:true | false
Initial:false
Applies to:fo:page-sequence
Inherited:no
Percentages:N/A

Values have the following meanings.

trueSeparates the volume newly from this fo:page-sequence.
falseDo 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 V6.3 Lite.

axf:output-volume-filename

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

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.

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 V6.3 Lite.

XSL-FO sample:

<fo:root font-family="Arial Unicode MS" font-size="12pt" xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:cpfo="http://www.compart.net/xmlns/cpfo" xmlns:svg="http://www.w3.org/2000/svg" xmlns:axf="http://www.antennahouse.com/names/XSL/Extensions">

volume 1 page 1

volume 1 page 2

volume 2 page 1

volume 2 page 2

Download der Beispiele

Output:

page 2

page 3

page 4

Tipp der data2type-Redaktion:
Zum Thema XSL-FO bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an: