Styles

The presentation of various block and inline elements can be adjusted by setting style keys. Each category takes XSL-FO key definitions and keys specific to that style.

While the style keys may look like CSS, the keys are XSL-FO properties and the underlying PDF2 plug-in does not use CSS compatibility properties.

Instead of padding-top, use padding-before.
Instead of margin-left, use start-indent. Note that these two keys do not have matching semantics, see XSL 1.1.

There is no default theme that defines base key values. Instead, a theme extends the PDF2 default styling. If you want to define common settings, create a theme file for shared settings, and use the extends key in other themes to build on the common foundation.

style:
  body:
    font-family: serif
    font-size: 12pt
    space-after: 6pt
    space-before: 6pt
    start-indent: 25pt
  topic:
    font-family: sans-serif
    font-size: 26pt
  link:
    color: blue
    text-decoration: underline

Block keys

`body`

Default body text, for example <p> elements.

The styling properties that can be used are listed in XSL fo:block.

`shortdesc`

Shortdesc and abstract styles.

The styling properties that can be used are listed in XSL fo:block.

`h1`

First level topic titles.

The styling properties that can be used are listed in XSL fo:block.

title-numbering = boolean

`h2`

Second level topic titles.

The styling properties that can be used are listed in XSL fo:block.

title-numbering = boolean

`h3`

Third level topic titles.

The styling properties that can be used are listed in XSL fo:block.

title-numbering = boolean

`h4`

Fourth level topic titles.

The styling properties that can be used are listed in XSL fo:block.

title-numbering = boolean

`cover`

Cover page.

The styling properties that can be used are listed in XSL fo:block.

`cover-title`

Cover page title.

The styling properties that can be used are listed in XSL fo:block.

content = content-template

`section`

Section element.

The styling properties that can be used are listed in XSL fo:block.

`section-title`

Section element title.

The styling properties that can be used are listed in XSL fo:block.

`dl`

Definition list element.

The styling properties that can be used are listed in XSL fo:block.

dl-type = 'table' | 'list' | 'html' — Style definition list as bulleted list or indented list.

`example`

Example element.

The styling properties that can be used are listed in XSL fo:block.

`example-title`

Example element title.

The styling properties that can be used are listed in XSL fo:block.

`fig`

Figure element.

The styling properties that can be used are listed in XSL fo:block.

caption-number = 'chapter' | 'document' — Number figures with chapter prefix or use whole document numbering.
caption-position = 'before' | 'after' — Place figure caption before or after figure.

`fig-caption`

Figure caption.

The styling properties that can be used are listed in XSL fo:block.

content: Contents of figure caption. Supported fields are:
- number: caption number
- title: caption contents

`note`

Note element with @type note or without @type.

The styling properties that can be used are listed in XSL fo:block.

`note-label`

Label for note elements.

The styling properties that can be used are listed in XSL fo:inline.

content — Content template.

`note-<type>`

Note element with @type. Type values are:

note
tip
fastpath
restriction
important
remember
attention
caution
notice
danger
warning
trouble
other

The styling properties that can be used are listed in XSL fo:block.

`note-<type>-label`

Label for note elements with @type.

The styling properties that can be used are listed in XSL fo:inline.

content — Content template.

`ol`

Ordered list.

The styling properties that can be used are listed in XSL fo:block.

`ul`

Unordered list.

The styling properties that can be used are listed in XSL fo:block.

`pre`

Preformatted element.

The styling properties that can be used are listed in XSL fo:block.

`codeblock`

Code block element.

The styling properties that can be used are listed in XSL fo:block.

line-numbering = boolean — Line numbering.
show-whitespace = boolean — Show whitespace characters.

`table`

Table element.

The styling properties that can be used are listed in XSL fo:block.

caption-number = 'chapter' | 'document' — Number figures with chapter prefix or use whole document numbering.
caption-position = 'before' | 'after' — Place figure caption before or after figure.
table-continued = boolean — Output "table continued" when table breaks across pages.

`table-caption`

Table caption.

The styling properties that can be used are listed in XSL fo:block.

content = content-template — Contents of table caption. Supported fields are:
- number: caption number
- title: caption contents

`table-header`

Table header row

The styling properties that can be used are listed in XSL fo:block.

`toc-1`

First level TOC entry.

The styling properties that can be used are listed in XSL fo:block.

`toc-2`

Second level TOC entry.

The styling properties that can be used are listed in XSL fo:block.

`toc-3`

Third level TOC entry.

The styling properties that can be used are listed in XSL fo:block.

`toc-4`

Fourth level TOC entry.

The styling properties that can be used are listed in XSL fo:block.

Inline keys

`link`

Link elements.

The styling properties that can be used are listed in XSL fo:inline.

link-url = 'true' | 'false' — Output URL for external links after explicitly defined link text. Defaults to false.
link-page-number = 'true' | 'false' — Generate page number reference after link text. Defaults to true.
content = content-template — Link text template. Supported fields are:
- link-text: link text
- pagenum: page number reference

`link-external`

External link elements.

content = content-template — Link text template. Supported fields are:
- link-text: link text
- url: link URL

`tm`

Trademark element.

The styling properties that can be used are listed in XSL fo:inline.

symbol-scope = 'always' | 'chapter' | 'never' — Output trademark symbol always, once per chapter, or never.

`keyword`

Keyword element.

The styling properties that can be used are listed in XSL fo:inline.

`term`

Term element.

The styling properties that can be used are listed in XSL fo:inline.

`codeph`

Code phrase element.

The styling properties that can be used are listed in XSL fo:inline.

`filepath`

File path element.

The styling properties that can be used are listed in XSL fo:inline.

`cmdname`

Comment name element.

The styling properties that can be used are listed in XSL fo:inline.

`varname`

Variable name element.

The styling properties that can be used are listed in XSL fo:inline.

`userinput`

User input element.

The styling properties that can be used are listed in XSL fo:inline.

`systemoutput`

System output element.

The styling properties that can be used are listed in XSL fo:inline.