Search manual:

- Main page
- Introduction
- Hello, world!
- Basics
  - How to write the layout
  - Structure of the data file and the layout rules
  - Outputting objects
  - Grid
  - Areas on the page (PositioningArea)
  - File organization
  - Hyphenation / language settings
  - Using fonts
  - Text formats
  - Text formatting
  - Colors
- Programming
- Image inclusion
- Tables
- Advanced topics
  - Bookmarks
  - Creation of XML structures
  - Print output / crop marks
  - Using CSS with the speedata Publisher
  - Groups (virtual objects)
  - Virtual pages
  - Rotation of contents
  - Sorting data
  - Wrap around images
  - Page types
  - Starting the Publisher via the Hotfolder
  - Lua-Filter / pre-processing
  - Schema validation
  - Quality assurance and PDF comparison
  - Troubleshooting / Debugging
  - Server mode (REST API)
  - Control of the layout when calling the Publisher
  - Create and use images with MetaPost
- Cookbook
  - Thumb index
  - Embed multipage PDF files
  - Layout optimization using groups
  - Imitate bulleted lists
  - Automatically generated directories
  - Create table of contents in one go
  - Page numbers: Page x of y
- Installation instructions
- File name in the Publisher
- speedata Publisher defaults
- Running the speedata publisher on the command line
- How to configure the speedata publisher
- Lenghts and units
- XPath- and Layoutfunctions
- Internal variables
- Associate XML editor with schema
  - Visual Studio Code
  - OxygenXML
  - Atom
- Changelog
- Glossary
- Compatibility with other software
- Command reference
  - A
  - Action
  - AddSearchpath
  - AtPageCreation
  - AtPageShipout
  - AttachFile
  - Attribute
  - B
  - Barcode
  - Bold
  - BoldItalic
  - Bookmark
  - Box
  - Br
  - Case
  - Circle
  - ClearPage
  - Color
  - Column
  - Columns
  - Compatibility
  - Contents
  - Copy-of
  - DefineColor
  - DefineColorprofile
  - DefineFontalias
  - DefineFontfamily
  - DefineGraphic
  - DefineMatter
  - DefineTextformat
  - Element
  - Fallback
  - Fontface
  - ForAll
  - Frame
  - Grid
  - Group
  - Groupcontents
  - HSpace
  - Hyphenation
  - I
  - Image
  - Include
  - Initial
  - InsertPages
  - Italic
  - Layout
  - Li
  - LoadDataset
  - LoadFontfile
  - Loop
  - Makeindex
  - Margin
  - Mark
  - Message
  - NewPage
  - NextFrame
  - NextRow
  - NoBreak
  - Ol
  - Options
  - Otherwise
  - Output
  - Overlay
  - Pageformat
  - Pagetype
  - Paragraph
  - PDFOptions
  - PlaceObject
  - Position
  - PositioningArea
  - PositioningFrame
  - ProcessNode
  - Record
  - Regular
  - Rule
  - SaveDataset
  - SavePages
  - SetGrid
  - SetVariable
  - SortSequence
  - Stylesheet
  - Span
  - Sub
  - Sup
  - Switch
  - Table
  - TableNewPage
  - Tablefoot
  - Tablehead
  - Tablerule
  - Td
  - Text
  - Textblock
  - Tr
  - Trace
  - Transformation
  - U
  - Ul
  - Until
  - URL
  - Value
  - VSpace
  - While

Version 4.6.0
Search manual

- Main page
- Introduction
- Hello, world!
- Basics
  - How to write the layout
  - Structure of the data file and the layout rules
  - Outputting objects
  - Grid
  - Areas on the page (PositioningArea)
  - File organization
  - Hyphenation / language settings
  - Using fonts
  - Text formats
  - Text formatting
  - Colors
- Programming
- Image inclusion
- Tables
- Advanced topics
  - Bookmarks
  - Creation of XML structures
  - Print output / crop marks
  - Using CSS with the speedata Publisher
  - Groups (virtual objects)
  - Virtual pages
  - Rotation of contents
  - Sorting data
  - Wrap around images
  - Page types
  - Starting the Publisher via the Hotfolder
  - Lua-Filter / pre-processing
  - Schema validation
  - Quality assurance and PDF comparison
  - Troubleshooting / Debugging
  - Server mode (REST API)
  - Control of the layout when calling the Publisher
  - Create and use images with MetaPost
- Cookbook
  - Thumb index
  - Embed multipage PDF files
  - Layout optimization using groups
  - Imitate bulleted lists
  - Automatically generated directories
  - Create table of contents in one go
  - Page numbers: Page x of y
- Installation instructions
- File name in the Publisher
- speedata Publisher defaults
- Running the speedata publisher on the command line
- How to configure the speedata publisher
- Lenghts and units
- XPath- and Layoutfunctions
- Internal variables
- Associate XML editor with schema
  - Visual Studio Code
  - OxygenXML
  - Atom
- Changelog
- Glossary
- Compatibility with other software
- Command reference
  - A
  - Action
  - AddSearchpath
  - AtPageCreation
  - AtPageShipout
  - AttachFile
  - Attribute
  - B
  - Barcode
  - Bold
  - BoldItalic
  - Bookmark
  - Box
  - Br
  - Case
  - Circle
  - ClearPage
  - Color
  - Column
  - Columns
  - Compatibility
  - Contents
  - Copy-of
  - DefineColor
  - DefineColorprofile
  - DefineFontalias
  - DefineFontfamily
  - DefineGraphic
  - DefineMatter
  - DefineTextformat
  - Element
  - Fallback
  - Fontface
  - ForAll
  - Frame
  - Grid
  - Group
  - Groupcontents
  - HSpace
  - Hyphenation
  - I
  - Image
  - Include
  - Initial
  - InsertPages
  - Italic
  - Layout
  - Li
  - LoadDataset
  - LoadFontfile
  - Loop
  - Makeindex
  - Margin
  - Mark
  - Message
  - NewPage
  - NextFrame
  - NextRow
  - NoBreak
  - Ol
  - Options
  - Otherwise
  - Output
  - Overlay
  - Pageformat
  - Pagetype
  - Paragraph
  - PDFOptions
  - PlaceObject
  - Position
  - PositioningArea
  - PositioningFrame
  - ProcessNode
  - Record
  - Regular
  - Rule
  - SaveDataset
  - SavePages
  - SetGrid
  - SetVariable
  - SortSequence
  - Stylesheet
  - Span
  - Sub
  - Sup
  - Switch
  - Table
  - TableNewPage
  - Tablefoot
  - Tablehead
  - Tablerule
  - Td
  - Text
  - Textblock
  - Tr
  - Trace
  - Transformation
  - U
  - Ul
  - Until
  - URL
  - Value
  - VSpace
  - While

- Dieses Handbuch auf Deutsch

# Options

Set publisher specific options.

## Child elements

(none)

## Parent elements

`AtPageCreation`, `AtPageShipout`, `Case`, `Contents`, `ForAll`, `Include`, `Layout`, `Loop`, `Record`, `SavePages`, `While`

## Attributes

`bleed` (length, optional)

  The amount of bleed. Defaults to 0mm.

`bleedmarks` (optional, since version 2.3.24)

  Trim marks will be placed in the PDF. The distance of the marks from the imaginary center is determined by the attribute `trim`, but is at least 5mm. The length of the cut marks is 1cm. The default of this attribute is `no`, that means no trim marks will be displayed. The trim marks show the additional trim distance.

  `yes`

    Show trim marks.

  `no`

    Don’t show trim marks (default).

`crop` (yes, no or length, optional, since version 2.3.21)

  Crop the pages so that the pdf size of the page is at its minimum. Allowed values are yes, no and a length.

`cutmarks` (optional)

  Cut marks / crop marks will be placed in the PDF. The distance of the marks from the imaginary center is determined by the attribute `trim`, but is at least 5mm. The length of the cut marks is 1cm. The default of this attribute is `no`, that means no cut marks will be displayed.

  `yes`

    Show crop marks.

  `no`

    Don’t show crop marks (default).

`defaultarea` (text, optional, since version 2.7.4)

  Name of the area that is used as a default for placing text (commands Output and PlaceObject). Default is `_page`.

`ignoreeol` (optional)

  Ignore newlines in data-xml

  `yes`

    Ignore newlines in data-xml

  `no`

    Respect newlines in data-xml

`imagenotfound` (optional, since version 2.3.43)

  When an image is not found: should the publisher raise an error?

  `warning`

    Show a warning

  `error`

    Raise an error (default)

`interaction` (yes or no, optional, since version 3.9.2)

  If no, switch off all interaction (hyperlinks).

`mainlanguage` (optional)

  The default language for text (hyphenation and rendering). You can also set the default language on the command line and locally set it at Paragraph and Textblock.

`randomseed` (number, optional, since version 3.9.24)

  Set the seed for the random number generator (a positive integer).

`reportmissingglyphs` (optional, since version 3.1.17)

  Issue an error if glyphs are missing from a font.

  `yes`

    Show error message (default)

  `no`

    Do not show an error message

  `warning`

    Show a warning

`resetmarks` (optional)

  Yes: ignore the marks file from previous run.

  `yes`

    Ignore marks from the previous run.

  `no`

    Use marks from the previous run (default).

`startpage` (number, optional)

  Set the number of the first page.

## Remarks

Bleed used to be 'trim' in version 2.7.6 and before.

## Example

    <Options
        cutmarks="yes"
        bleed="3mm"/>

## Info

The list of languages and the short code known to the system are:

`Ancient Greek` (`grc`), `Armenian` (`hy`), `Bahasa Indonesia` (`id`), `Basque` (`eu`), `Bulgarian` (`bg`), `Catalan` (`ca`), `Chinese` (`zh`), `Croatian` (`hr`), `Czech` (`cs`), `Danish` (`da`), `Dutch` (`nl`), `English` (`en_GB`), `English (Great Britain)` (`en_GB`), `English (USA)` (`en_US`), `Esperanto` (`eo`), `Estonian` (`et`), `Finnish` (`fi`), `French` (`fr`), `Galician` (`gl`), `German` (`de`), `Greek` (`el`), `Gujarati` (`gu`), `Hindi` (`hi`), `Hungarian` (`hu`), `Icelandic` (`is`), `Irish` (`ga`), `Italian` (`it`), `Kannada` (`kn`), `Kurmanji` (`ku`), `Latvian` (`lv`), `Lithuanian` (`lt`), `Malayalam` (`ml`), `Norwegian Bokmål` (`nb`), `Norwegian Nynorsk` (`nn`), `Other` (`--`), `Polish` (`pl`), `Portuguese` (`pt`), `Romanian` (`ro`), `Russian` (`ru`), `Serbian` (`sr`), `Serbian (cyrillic)` (`sc`), `Slovak` (`sk`), `Slovenian` (`sl`), `Spanish` (`es`), `Swedish` (`sv`), `Turkish` (`tr`), `Ukrainian` (`uk`), `Welsh` (`cy`)

## See also

Running the speedata publisher on the command line, How to configure the speedata publisher.

- Ol
- Otherwise