path: root/sandbox/xsl_fo/docs/rst/attribute_sets.rst

####################
XSL-FO Documentation
####################

^^^^^^^^^^^^^^
Attribute Sets
^^^^^^^^^^^^^^

.. contents:: Table of Contents

Root Attribute Sets
===================

Attribute sets root elements. Use these attribute sets to format
the defaults in a document, such as font, font-size, or
line-height.

page-sequence
------------------

:fo: fo:page-sequence

:defaults:

     format: 1

     initial-page-number: 1

Formats the properties for the complete run of pages, in this
case, the body. You could use this attribute set to set the font for the
entire document, for example.

paper-size
-----------

:fo: None


:defaults:

     page-width: 8.5in

     page-height: 11in

Sets up the the paper size.

page-margins
-----------------------------

:fo: None

:defaults:

	margin-left: 1.0in
	margin-right: 1.0in
	margin-top: 1.0in
	margin-bottom: 1.0in

Sets up the the margins.

region-body
-----------------------------

:fo: region-body

:defaults:

        margin-top: .75in
        margin-bottom: .75in

(DON'T THIS IS CORRECT--VARIABLES NO HANDLE THIS?)

Sets the defaults for the margins for the body region (as opposed to the
page). These defaults are only used if headers or footers are found.

region-before
-----------------------------

:fo: region-before

:defaults:

    extent: .75in

Sets the extent for the region-before. This attribute set will only be used if
a header is found.

region-after
-----------------------------

:fo: region-after

:defaults:

    extent: .75in

Sets the extent for the region-after. This attribute set will only be used if
a footer is found.



body-flow
---------

:fo: fo:flow


:defaults:

Formats the properties of the body in the body sequence of pages,
which means everything except headers and footers.

footnote-separator-flow
-----------------------

:fo: fo:flow

:defaults:

Formats the flow of the footnote.

footnote-separator-block
------------------------

:fo: fo:block

:defaults:

Formats the block (with the leader) that separates the footnotes
from the rest of the page.

Header and Footer Attribute Sets
================================

paragraph-header-block
----------------------

:fo: fo:block

:defaults:

     font-size: 12pt

     text-align: center

Formats the properties for the paragraphs in the header. Use to
set the space between the footer and the body text, using
``'space-before = x'`` and setting
``'space-before.conditionality'`` to ``'retain'``.

paragraph-footer-block
----------------------

:fo: fo:block

:defaults:

     font-size: 12pt

     text-align: center

Formats the properties for the footer. Use to set the space
between the footer and the body text, using ``'space-before =
x'`` and setting ``'space-before.conditionality'`` to
``'retain'``.

Bibliograhic Fields Attribute Sets
==================================

Attribute sets for the bibliograhic fields. These attributes
control the formatting of bibliographic fields.

bibliographic-fields-list-block
-------------------------------

:fo: list-block

:defaults:

     start-indent: 0mm

     provisional-distance-between-starts: 30mm

     space-before: 12pt

     space-after: 12pt

Formats the bibliographic fields as a list. Since this element
contains all the other list elements, it can be used to set
values such as the font, background color, line-height, etc, for
the entire list, as well as the space after and before.


bibliographic-fields-list-item
------------------------------

:fo: fo:list-item


:defaults:

     space-before: 12pt

For each item (author, authors, organization, contact, address,
version, date, copyright, custom field) in the bibliograhic
fields. Use the 'space-after' attribute to control the spacing
between each item.

bibliographic-fields-first-list-item
------------------------------------

:fo: fo:list-item

:inherits: bibliographic-fields-list-item

:defaults:

     space-before: 0pt

Same as above, but sets the space before to 0pt.

bibliographic-fields-list-item-label
------------------------------------

:fo: fo:list-item-label


:defaults:

     end-indent: label-end()

The default attribute end-indent = "label-end()" ensures that the
label aligns properly.

bibliographic-fields-item-body
------------------------------

:fo: fo:list-item-body

:defaults:

     start-indent: body-start()

The default of start-indent = "body-start()" ensures the correct
alignment of the labels.

bibliographic-fields-item-label-block
-------------------------------------

:fo: fo:block

:defaults:

     font-weight: bold

Formats the block that wraps the the name of the field (such as
Author, Version, etc).

bibliographic-fields-block
--------------------------

:fo: fo:block


:defaults:

Formats the blocks (docutilis paragraphs) of the value of the
field. Use the 'space-after' attribute to control the spacing
between a multi-paragraph description.

bibliographic-first-fields-block
--------------------------------

:fo: fo:block


:inherits: bibliographic-fields-block

:defaults:

Same as above, but for the first such paragraph.

address-value-block
-------------------

:fo: fo:block


:inherits: bibliographic-fields-block

:defaults:

     white-space: pre

Formats the blocks (docutilis paragraphs) of the address field,
which has to preserve the white space, according to the docutils
specs. Since this inherits from the bibliographic-fields-bloc, it
doesn't make sense to change attributes here directly.

Footnote
========

Attribute sets for footnotes, endnotes, and the endnotes title.

footnote
--------

:fo: fo:footnote

:defaults:

     font-weight: normal

     font-style: normal

Formats the footnote. By default, it sets properties to neutral,
so that it does not inherit any unwanted properties, such as from
a definition term.

default-footnote-label-inline
-----------------------------

:fo: fo:inline

:defaults:

     baseline-shift: super

     font-size: 8pt

Sets of the defaults for the label (1, \*, etc), of each label.


footnote-list-block
-------------------

:fo: fo:list-block

:defaults:

     provisional-label-separation: 0pt

     provisional-distance-between-starts: 18pt

Formats the list that contains the footnote. The
'provisional-distance-between-starts' controls how far away the
footnote label is from the text.

footnote-item-label
-------------------

:fo: fo:list-item-label

:defaults:

     end-indent: label-end()

Formats the item-label when the footnote or endnote is formatted
as a list.

footnote-label-block
--------------------

:fo: fo:block

:defaults:

Formats the block in item-label when the footnote or endnote is
formatted as a list. By default, the label has no superscript (as
opposed to when formatting a "traditional" footnote.

footnote-item-body
------------------

:fo: fo:list-item-body

:defaults:

     start-indent: body-start()

Formats the item-body when the footnote or endnote is formatted
as a list.

footnote-body
-------------

:fo: fo:footnote-body

:defaults:

Formats the body of the footnote. Space-after and space-before
seem to have no affect, at least with fop.

footnote-paragraph-block
------------------------

:fo: fo:block

:defaults:

     space-before: 5pt

Formats the paragraphs in the body of a footnote or endnote. Use
the 'space-before' to set the space between each paragraphs, for
footnotes or endnotes with multiple paragraphs. 


Endnote
========

For attributes when the endnotes.xsl stylesheet is imported.

endnote-block
-------------

:fo: fo:block

:defaults:

     space-before: 5pt

The block that wraps each individual endnote ('footnote' in
docutils). Use to control the spacing between each endnote.

endnote-first-block
-------------------

:fo: fo:block

:inherits: endnote-block

:defaults:

     space-before: 0pt

The block that wraps each the first endnote ('footnote' in
docutils). It does not make sense to change attributes on this
set directly.

endnotes-title-block
--------------------

:fo: fo:block

:defaults:

     space-after: 18pt

     font-weight: bold

     font-size: 18pt

     text-align: center

Formats the title for the endnotes, when one is present. The rst will have a
rubric with the classes as "endnotes. The XML will look like <rubric
@classes="endotes">

Dedication Sets
================


dedication-title-block
----------------------

:fo: fo:block

:defaults:

     text-align: center

     font-weight: bold

     space-after: 12pt

Formats the title for the dedication.


dedication-paragraph-block
--------------------------

:fo: fo:block

:defaults:

     font-style: italic

     space-after: 12pt

Formats the paragraphs of the dedication.

dedication-first-paragraph-block
--------------------------------

:fo: fo:block

:inherits: dedication-paragraph-block

:defaults:

     space-before: 0pt

Formats the first paragraph of the dedication.

Abstract Sets
================


abstract-title-block
--------------------

:fo: fo:block

:defaults:

     text-align: center

     font-weight: bold

Formats the abstract title.

abstract-paragraph-block
------------------------

:fo: fo:block

:defaults:

     space-before: 12pt

Formats the paragraphs of the abstract.

abstract-first-paragraph-block
------------------------------

:fo: fo:block

:inherits: abstract-paragraph-block

:defaults:

     space-before: 0pt

Formats the first paragraph of the abstract.


TOC 
====

Attribute sets for the TOC.

toc-title-block
---------------

:fo: fo:block

:defaults:

     text-align: center

     font-weight: bold

     font-size: 14pt

Formats the block for the title for the TOC.

toc-entry-defaults-block
------------------------

:fo: None

:defaults:

     space-after: 3pt

     text-align-last: justify

Sets up the defaults for the TOC entries.

toc-level1-block
----------------

:fo: fo:block


:inherits: toc-entry-defaults-block

:defaults:

Formats the block for the level 1 table of contents entry. If a
number exists, it is formatted according to the parameter
'number-section1'.

toc-level2-block
----------------

:fo: fo:block

:inherits: toc-entry-defaults-block

:defaults:

     start-indent: 10mm

Formats the block for the level 2 table of contents entry. If a
number exists, it is formatted according to the parameter
'number-section2'.

toc-level3-block
----------------

:fo: fo:block

:inherits: toc-entry-defaults-block

:defaults:

     start-indent: 20mm

Formats the block for the level 3 table of contents entry. If a
number exists, it is formatted according to the parameter
'number-section3'.

toc-level4-block
----------------

:fo: fo:block

:inherits: toc-entry-defaults-block

:defaults:

     start-indent: 30mm

Formats the block for the level 4 table of contents entry. If a
number exists, it is formatted according to the parameter
'number-section4'.

toc-level5-block
----------------

:fo:


:inherits: toc-entry-defaults-block

:defaults:

     start-indent: 40mm

Formats the block for the level 5 table of contents entry. If a
number exists, it is formatted according to the parameter
'number-section5'.


Section Attribute Sets
======================

Attribute sets for the section titles.

default-section-title-block
---------------------------

:fo: None

:defaults:

     space-before: 12pt

     space-after: 12pt

     keep-with-next: always

Sets up the defaults for the section titles. The title should
always have some text beneath it to avoid widows and orphans;
hence the keep-with-always property.

title-level-block
-----------------

:fo: fo:block

:inherits: default-section-title-block

The following attribute sets are identical in nature:

- title-level1-block

- title-level2-block

- title-level3-block

- title-level4-block

- title-level5-block

- title-level6-block

- title-level7-block

- title-level8-block

- title-level9-block

These attribute-sets format the titles of all sections.

title-number-inline
-------------------

:fo: fo:inline

:defaults:

     space-end: 12pt

Formats the title number generated by docutils.

Body Elements
=============

Attribute sets for body elements, including the document title
and subtitle; the default paragraph; the transition element; and
the literal block.

paragraph-block
---------------

:fo: fo:block

:defaults:

     space-after: 12pt

Formats the default paragraph.

first-paragraph-block
---------------------

:fo: fo:block

:inherits: paragraph-block

:defaults:

Formats the first default paragraph.

literal-block
-------------

:fo: fo:block

:defaults:

     font-family: monospace

     font-size: 8

     white-space: pre

     space-after: 12pt

     space-before: 12pt

Formats the literal text.

transition-block
----------------

:fo: fo:block


:defaults:

     space-before: 12pt

     space-after: 12pt

     text-align: center

Formats the transition block. The actutal text for this block is
set by the 'transition-text' parameter.

document-title-block
--------------------

:fo: fo:block

:defaults:

     space-after: 12pt

     font-size: 24pt

     text-align: center

     font-weight: bold

Formats the title for the document.

document-title-page-block
-------------------------

:fo: fo:block

:defaults:

The block that wraps both the title and subtitle. This block only
gets written if the title and subtitle occur in the front
section, or TOC section.

document-subtitle-block
-----------------------

:fo: fo:block

:defaults:

     space-before: 12pt

     space-after: 12pt

     font-size: 18pt

     text-align: center

     font-weight: bold

Formats the subtitle of the document.


block-quote-paragraph-block
---------------------------

:fo: fo:block

:defaults:

     space-before: 12pt

     start-indent: 20mm

     end-indent: 20mm

     space-after: 12pt

The attribute set that formats the paragraphs in the block quote.
A different set of attributes controls the first paragraph (see
below). Use this attribute set to set the space between
paragraphs with the 'space-before' attribute.

block-quote-first-paragraph-block
---------------------------------

:fo: fo:block

:inherits: block-quote-paragraph-block

The attribute set that formats the first paragraph in the block quote. It
inherits all the attributes from 'block-quote-first-paragraph-block'. 

block-quote-attribution-block
-----------------------------

:fo: fo:block

:inherits: block-quote-paragraph-block

:defaults:

     text-align: right

This attribute set the attribution in a block quote.

bullet list
===========

Attribute sets for the bullet list.

bullet-list-block
-----------------

:fo: list-block

:defaults:

     start-indent: 5mm

     provisional-distance-between-starts: 5mm

     space-before: 12pt

     space-after: 12pt

For the bullet list. Since this element contains all the other
list elements, it can be used to set values such as the font,
background color, line-height, etc, for the entire list, as well
as the space after and before.


bullet-list-item
----------------

:fo: fo:list-item

:defaults:

     space-before: 12pt

For the item in the bullet list. The attributes can control the
spacing between each item. A different set of attributes controls
the spacing of the first item (see below).

bullet-first-list-item
----------------------

:fo: fo:list-item

:inherits: bullet-list-item

:defaults:

     space-before: 0pt

For the first item in the bullet list. This attribute set
inherits all the properties form 'bullet-list-item', and then
re-defines the space-before to 0pt. In order to get space between
the first item and the text before it, use the space-after
attribute in the bullet-list attribute set.

bullet-level2-list-item
-----------------------

:fo: fo:list-item

:defaults:

     space-before: 12pt

Same as above, except for a nested bullet list.

bullet-level2-first-list-item
-----------------------------

:fo: fo:list-item

:inherits: bullet-level2-list-item

:defaults:

     space-before: 0pt

For the first item in a nested bullet list. This attribute set
inherits all the properties form 'bullet-list-item', and then
re-defines the space-before to 0pt. In order to get space between
the first item and the text before it, use the space-after
attribute in the bullet-list attribute set.

bullet-list-item-label
----------------------

:fo: fo:list-item-label

:defaults:

     end-indent: label-end()

The default attribute end-indent = "label-end()" ensures that the
label aligns properly.

bullet-list-item-label-block
----------------------------

:fo: fo:block

:defaults:

These attributes format the block that wraps the bullet. (FO
requires such a block, even for a small label like this.)

bullet-list-item-body
---------------------

:fo: fo:list-item-body

:defaults:

     start-indent: body-start()

The default of start-indent = "body-start()" ensures the correct
alignment of the labels.

bullet-list-item-body-block
---------------------------

:fo: fo:block

:defaults:

     space-after: 12pt

Formats the blocks (docutilis paragraphs) of the body of each
item.

bullet-level2-list-block
------------------------

:fo: list-block

:defaults:

     start-indent: 15mm

     provisional-distance-between-starts: 5mm

     space-before: 12pt

Same as for the bullet-list-block attribute. The default sets the
start-indent property to a greater value to indent this nested
list.

enumerated list
===============

Attribute sets for the enumerated list.

enumerated-list-block
---------------------

:fo: list-block

:defaults:

     start-indent: 5mm

     provisional-distance-between-starts: 10mm

     space-before: 12pt

     space-after: 12pt

For the enumerated list. Since this element contains all the
other list elements, it can be used to set values such as the
font, background color, line-height, etc, for the entire list, as
well as the space after and before.



enumerated-level2-list-block
----------------------------

:fo: list-block

:defaults:

     start-indent: 15mm

     provisional-distance-between-starts: 10mm

     space-before: 12pt

     space-before: 12pt

Same as for the enumerated-list-block attribute. The default sets
the start-indent property to a greater value to indent this
nested list.

enumerated-list-item
--------------------

:fo: fo:list-item

:defaults:

     space-before: 12pt

For the item in the enumerated list. The attributes can control
the spacing between each item. A different set of attributes
controls the spacing of the first item (see below).

enumerated-first-list-item
--------------------------

:fo: fo:list-item

:inherits: enumerated-list-item

:defaults:

     space-before: 0pt

For the first item in the enumerated list. This attribute set
inherits all the properties form 'enumerated-list-item', and then
re-defines the space-before to 0pt. In order to get space
between the first item and the text before it, use the
space-after attribute in the enumerated-list attribute set.

enumerated-level2-list-item
---------------------------

:fo: fo:list-item

:defaults:

     space-before: 12pt

Same as above, but formats item of nested list.

enumerated-level2-first-list-item
---------------------------------

:fo: fo:list-item

:inherits: enumerated-level2-list-item

:defaults:

     space-before: 0pt

For the first item in the nested enumerated list.

enumerated-list-item-label
--------------------------

:fo: fo:list-item-label

:defaults:

     end-indent: label-end()

The default attribute end-indent = "label-end()" ensures that the
label aligns properly.

enumerated-list-item-body
-------------------------

:fo: fo:list-item-body

:defaults:

     start-indent: body-start()

The default of start-indent = "body-start()" ensures the correct
alignment of the labels.

enumerated-list-item-body-block
-------------------------------

:fo: fo:block

:defaults:

     space-after: 12pt

Formats the blocks (docutilis paragraphs) of the body of each
item.

Line Block
==========

Attribute sets for the line block.

outer-line-block
----------------

:fo: fo:block

:defaults:

     space-before: 12pt

     space-after: 12pt

The outer block containing the blocks of lines. Use the outer
block to set space before or after the verse.

level1-line-block
-----------------

:fo: fo:block

:defaults:

     start-indent: 10mm

Attribute sets for the first level of lines.

level2-line-block
-----------------

:fo: fo:block

:defaults:

     start-indent: 20mm

Attribute sets for the second level of lines.

level3-line-block
-----------------

:fo: fo:block

:defaults:

     start-indent: 30mm

Attribute sets for the third level of lines.

level4-line-block
-----------------

:fo: fo:block

:defaults:

     start-indent: 40mm

Attribute sets for the fourth level of lines.

level5-line-block
-----------------

:fo: fo:block


:defaults:

     start-indent: 50mm

Attribute sets for the fifth level of lines.

stanza-title-block
------------------

:fo: fo:block

:defaults:

     text-align: center

     space-before: 12

     font-weight: bold

Formats the title of a stanza.

definition list
===============

Attribute sets for the definition list.

definition-list-block
---------------------

:fo: block

:defaults:

     space-after: 12pt

     space-before: 12pt

For the definition list. Since this element contains all the
other blocks in the list, it can be used to set values such as
the font, background color, line-height, etc, for the entire
list, as well as the space after and before.

definition-list-item-block
--------------------------

:fo: fo:block

:defaults:

     space-before: 12pt

For the items in the definition list. The attributes can control
the spacing between each item. A different set of attributes
controls the spacing of the first item (see below).

definition-list-item-first-block
--------------------------------

:fo: fo:block

:inherits: definition-list-item-block

:defaults:

     space-before: 0pt

For the first item in the definition list. This attribute set
inherits all the properties form 'definition-list-item', and then
re-defines the space-before to 0pt. In order to get space
between the first item and the text before it, use the
space-after attribute in the option-list attribute set.

It does not makes sense to change this set direclty.

definition-term-block
---------------------

:fo: fo:block

:defaults:

     font-weight: bold

Formats the bock of the the term. Can be used to control spacing
between term and definition, but don't use with space before, or
you won't be able to control spacing before list

definition-block
----------------

:fo: fo:block

:defaults:

Formats the bock of the of the defintion, that wraps the
paragraph blocks.

classifier-inline
-----------------

:fo: fo:inline

:defaults:

     font-style: italic

For the inine properties of the classifier item.

definition-paragraph-block
--------------------------

:fo: fo:block


:defaults:

     space-before: 12pt

     start-indent: 30pt

Formats the blocks (paragraphs in the defintion. Can be lsed to
control the space between paragraphs by setting the space-bfore
attribute. Don't use the space-after attribute, or you won't be
able to contorl the spacing between items

definition-first-paragraph-block
--------------------------------

:fo: fo:block


:inherits: definition-first-paragraph-block

:defaults:

     space-before: 0pt

For the first paragraph in the definition list. This attribute
set inherits all the properties frorm
'definition-first-paragraph-block', and then re-defines the
space-before to 0pt.

It does not makes sense to change this set direclty.


field list
==========

Attribute sets for the field list.

field-list-block
----------------

:fo: list-block

:defaults:

     start-indent: 0mm

     provisional-distance-between-starts: 30mm

     space-before: 12pt

     space-after: 12pt

Formats the field list. Since this element contains all the other
list elements, it can be used to set values such as the font,
background color, line-height, etc, for the entire list, as well
as the space after and before.

field-list-item
---------------

:fo: fo:list-item

:defaults:

     space-before: 12pt

For the items, or 'fields' in the field list. The attributes can
control the spacing between each item. A different set of
attributes controls the spacing of the first item (see below).

field-first-list-item
---------------------

:fo: fo:list-item

:inherits: field-list-item

:defaults:

     space-before: 0pt

For the first item in the field list. This attribute set inherits
all the properties form 'field-list-item', and then re-defines
the space-before to 0pt. In order to get space between the first
item and the text before it, use the space-after attribute in the
field-list-block attribute set.

It does not make sense to change this attriubte set directly.

field-list-item-label
---------------------

:fo: fo:list-item-label

:defaults:

     end-indent: label-end()

The default attribute end-indent = "label-end()" ensures that the
label aligns properly.

field-list-item-body
--------------------

:fo: fo:list-item-body

:defaults:

     start-indent: body-start()

The default of start-indent = "body-start()" ensures the correct
alignment of the labels.

field-body-block
----------------

:fo: fo:block

:defaults:

     space-after: 12pt

Formats the blocks (docutilis paragraphs) of the field.

field-list-item-label-block
---------------------------

:fo: fo:block

:defaults:

     font-weight: bold

Formats the block that wraps the field name.

option list as list
===================

Since an option list can be rendered as either a traditonal list,
or a definition list, there are two sets of attribute sets.
These attribute sets are used for the options list when it is
rendered as a list.

option-list-block
-----------------

:fo: list-block

:defaults:

     start-indent: 0mm

     provisional-distance-between-starts: 50mm

     space-before: 12pt

     space-after: 12pt

For the option list. Since this element contains all the other
list elements, it can be used to set values such as the font,
background color, line-height, etc, for the entire list, as well
as the space after and before.


option-list-item
----------------

:fo: fo:list-item

:defaults:

     space-before: 12pt

For the items in the option list. The attributes can control the
spacing between each item. A different set of attributes controls
the spacing of the first item (see below).

option-first-list-item
----------------------

:fo: fo:list-item

:inherits: option-list-item

:defaults:

     space-before: 0pt

For the first item in the option list. This attribute set
inherits all the properties form 'option-list-item', and then
re-defines the space-before to 0pt. In order to get space between
the first item and the text before it, use the space-after
attribute in the option-list attribute set.

It does not make sense to change this attriubte set directly.

option-list-item-label
----------------------

:fo: fo:list-item-label

:defaults:

     end-indent: label-end()

The default attribute end-indent = "label-end()" ensures that the
label aligns properly.

option-list-item-label-block
----------------------------

:fo: fo:block


:defaults:

These attributes format the block that wraps the option_string
and option_argument.

option-list-item-body
---------------------

:fo: fo:list-item-body

:defaults:

     start-indent: body-start()

The default of start-indent = "body-start()" ensures the correct
alignment of the labels.

option-list-item-body-block
---------------------------

:fo: fo:block

:defaults:

Formats the blocks (docutilis paragraphs) that describe the
options. If there was more than one paragraph, you could use
attributes such as space after.

option-inline
-------------

:fo: fo:inline


:defaults:

     font-family: monospace

Used to format any inline properties of the option_string.

option-argument-inline
----------------------

:fo: fo:inline


:defaults:

     font-family: monospace

     font-style: italic

Used to format any inline properties of the option_string.

option list as definition list
==============================

These attribute sets are used for the options list when it is
rendered as a definition list. (See the docutils reference guide
for an example of a definition list, or see the defintion list in
the test files.)

option-list-definition-block
----------------------------

:fo: fo:block

:defaults:

     space-before: 12pt

     space-after: 12pt

Formats the block that wraps the other blocks. Use to control
space after and before, or to set any block items on the entire
list.

This block wraps around another block, which in turn wraps around
a third block.

option-list-item-block
----------------------

:fo: fo:block

:defaults:

     space-before: 8pt

Formats the block that wraps the options and descriptions, which
are also blocks.

option-list-first-item-block
----------------------------

:fo: fo:block

:defaults:

     space-before: 0pt

Same as for option-list-item-block, but sets the space-before to
0pt

Does not make sense to change the attributes here directly.

option-group-block
------------------

:fo: fo:block

:defaults:

     keep-with-next: always

Formats the block that contains the inline elements of the
options and arguments. For a defintion list, this block serves as
the term, and sits on top, and to the left of the description.

option-list-description-block
-----------------------------

:fo: fo:block

:defaults:

     start-indent: 16pt

     space-before: 8pt

Formats the blocks wrappring the paragraphs describing the
options or arguments. This groups of blocks sits below the blocks
formatting the options and arguments, and in a defintion list
are usually indented right.

option-list-paragraph-block
---------------------------

:fo: fo:block

:defaults:

     space-before: 0pt

Formats the paragraphs in the description for an options list
formatted as a definition list.

option-list-first-paragraph-block
---------------------------------

:fo: fo:block

:inherits: option-list-paragraph-block

:defaults:

     space-before: 0pt

Formats the first paragraph in the description for an options
list formatted as a definition list.




Inline
======

Attribute sets for all the inline elements. The parameter
'footnote-style' controls the style of the footnote. 

emphasis-inline
---------------

:fo: fo:inline

:defaults:

     font-style: italic

Formats the emphasis element.

strong-inline
-------------

:fo: fo:inline

:defaults:

     font-weight: bold

Formats the strong element.

basic-link-inline
-----------------

:fo: fo:inline

:defaults:

     text-decoration: underline

     color: blue

Formats the basic_link element.

literal-inline
--------------

:fo: fo:inline

:defaults:

     font-family: monospace

     font-size: 8

     white-space: pre

Formats the literal element.

title-reference-inline
----------------------

:fo: fo:inline

:defaults:

     font-style: italic

Formats the title_reference element.


Admonitions
===========

Attribute sets for Admonitions. By default, the admontioins have
a border around them. Each admonition gets its title from the
parameter of that name. For example, the danger admonitions title
gets its title from the 'danger-title' parameter, the caution
from the `caution-title` paramter, and so fourth.

Although each admonition and each admonition title has its own
attribute-set, by default they all inherit these values from two
default attribute sets. (See below.) Each of these areas can thus
be customized. In contrast, all the paragrahs in each admonition
are identical.

default-admonition-outer-block
------------------------------

:fo: block

:defaults:

     border-style: solid

     border-width: 1px

     padding: 6pt

     keep-together.within-page: always

Sets up the defaults for the outer blocks of all the admonitions.
The attributes of this block control the borders and prohibit
the admonition from breaking across a page.

default-admonition-title-block
------------------------------

:fo: block

:defaults:

     space-after: 10pt

     font-size: larger

     color: red

Sets up the defaults for the title blocks of all the admonitions.
The attributes of this block control the color (red) and font
size. For certain blocs, the color is set to black (see below).

admonitions outer block
-----------------------

:fo: fo:block

         admonitons[@classes='custorm']

:inherits: default-admonition-outer-block

The following attribute sets are identical in nature:

* attention-block

* caution-block

* danger-block

* error-block

* hint-block

* important-block

* note-block

* tip-block

* warning-block

* admonition-custom-block

These attribute-sets format the outer block of all the
admonitions. By default it puts an border around the text. Use
this attribute set to set the space before or after, the
background color, etc.

admonitions title block
-----------------------

:fo: fo:block

:inherits: default-admonition-title-block

The following attribute sets are identical in nature:

* attention-title-block

* caution-title-block

* danger-title-block

* error-title-block

* hint-title-block

* important-title-block

* note-title-block

* tip-title-block

* warning-title-block

* admonition-custom-title-block

These attribute-sets format the title block of all the
admonitions. It sets the color to red.

The attribute-sets ``error-title-block``, ``hint-title-block``,
``important-title-block``, ``note-title-block``,
``tip-title-block``, and ``admonition-custom-title-block`` resets
the color back to black.

admonition-paragraph-block
--------------------------

:fo: fo:block

:defaults:

     space-before: 12pt

Formats the paragraphs in the admonitions. A different
attribute-set formats the first paragraph (see below).

admonition-first-paragraph-block
--------------------------------

:fo: fo:block

:defaults:

Formats the first paragraphs in the admonitions. It inherits its
attributes from the ``admonition-paragraph-block`` and resets the
``space-before`` property to ``0pt``. It does not make sense to
modify the attributes in this set directly.

Body Elements Directives
========================

Attribute sets for Body Elements Directives.

topic-block
-----------

:fo: fo:block

:defaults:

     space-after: 12pt

     space-before: 12pt

Formats the outermost block of the topic element, which contains
blocks.

topic-title-block
-----------------

:fo: fo:block

:defaults:

     font-weight: bold

     space-after: 12pt

Formats the title of the topic.

topic-paragraph-block
---------------------

:fo: fo:block

:defaults:

     space-before: 12pt

     space-after: 0pt

Formats the paragraphs of the topic. A different set of
attributes formats the first paragraph.

topic-first-paragraph-block
---------------------------

:fo: fo:block

:inherits: topic-paragraph-block

:defaults:

Formats the first paragraphs of the topic.

sidebar-block
-------------

:fo: fo:block

:defaults:

     space-after: 12pt

     space-before: 12pt

     background-color: #FFFFF0

     padding: 6pt

     start-indent: 10mm

     end-indent: 40mm

Formats the outermost block of the sidebar element, which
contains blocks. Note that fop does not handle floats, so this
element is formatted just like a topic block.

sidebar-title-block
-------------------

:fo: fo:block

:defaults:

     font-weight: bold

     space-after: 12pt

Formats the title of the topic.

sidebar-subtitle-block
----------------------

:fo: fo:block

:defaults:

     font-weight: bold

     space-after: 12pt

Formats the subtitle of the topic.

sidebar-paragraph-block
-----------------------

:fo: fo:block

:defaults:

     space-before: 12pt

Formats the paragraphs of the sidebar. A different set of
attributes formats the first paragraph.

sidebar-first-paragraph-block
-----------------------------

:fo: fo:block

:inherits: sidebar-paragraph-block

:defaults:

     space-after: 0pt

Formats the first paragraphs of the sidebar.

rubric-block
------------

:fo: fo:block

:defaults:

     text-align: center

     font-size: larger

     color: red

Formats the rubric.

epigraph-outer-block
--------------------

:fo: fo:block

:defaults:

     start-indent: 20mm

     end-indent: 20mm

     space-after: 12pt

     space-before: 12pt

     text-align: right

     font-style: italic

Formats the outermost block of the epigraph element, which
contains blocks.

epigraph-paragraph-block
------------------------

:fo: fo:block

:defaults:

     start-indent: inherit

     end-indent: inherit

     space-before: 12pt

Formats the paragraphs of the epigraph. A different set of
attributes formats the first paragraph.

epigraph-first-paragraph-block
------------------------------

:fo: fo:block

:inherits: epigraph-paragraph-block

:defaults:

     space-before: 0pt

Formats the first paragraphs of the epigraph.

epigraph-attribution-block
--------------------------

:fo: fo:block

:defaults:

     text-align: right

Formats the attribution of the epigraph. The parameter
``text-before-epigraph-attribution`` determines the text to put
before the attribtion. The default is '—' (an em-dash). To put no
text before, set this parameter to an empty string.

highlights-outer-block
----------------------

:fo: fo:block

:defaults:

     start-indent: 20mm

     end-indent: 20mm

     space-after: 12pt

     space-before: 12pt

Formats the outermost block of the epigraph element, which
contains blocks.

highlights-paragraph-block
--------------------------

:fo: fo:block

:defaults:

     start-indent: inherit

     end-indent: inherit

     space-before: 12pt

Formats the paragraphs of the highlights. A different set of
attributes formats the first paragraph.

highlights-first-paragraph-block
--------------------------------

:fo: fo:block

:inherits: highlights-paragraph-block

:defaults:

     space-before: 0pt

Formats the first paragraphs of the highlights.

pull-quote-outer-block
----------------------

:fo: fo:block

:defaults:

     start-indent: 20mm

     end-indent: 20mm

     space-after: 12pt

     space-before: 12pt

Formats the outermost block of the pull-quote element, which
contains blocks.

pull-quote-paragraph-block
--------------------------

:fo: fo:block

:defaults:

     start-indent: inherit

     end-indent: inherit

     space-before: 12pt

Formats the paragraphs of the pull-quote. A different set of
attributes formats the first paragraph.

pull-quote-first-paragraph-block
--------------------------------

:fo: fo:block

:inherits: pull-quote-paragraph-block

:defaults:

     space-before: 0pt

Formats the first paragraphs of the pull-quote.

pull-quote-attribution-block
----------------------------

:fo: fo:block

:defaults:

     text-align: right

Formats the attribution of the pull-quote. The parameter
``text-before-pull-quote-attribution`` determines the text to put
before the attribtion. The default is '—' (an em-dash). To put
no text before, set this parameter to an empty string.

container-outer-block
---------------------

:fo: fo:block

:defaults:

     space-after: 12pt

     space-before: 12pt

Formats the outermost block of the container element, which
contains blocks.

container-paragraph-block
-------------------------

:fo: fo:block

:defaults:

     space-before: 12pt

Formats the paragraphs of the container. A different set of
attributes formats the first paragraph.

container-first-paragraph-block
-------------------------------

:fo: fo:block

:inherits: container-paragraph-block

:defaults:

     space-before: 0pt

Formats the first paragraphs of the container.

Image and Figure
================

Attribute sets for Images and Figures. The image property of
``alt`` and ``target`` are ignored by the stylesheets, since they
have no use in PDF. In addtion, if the ``align`` is set to
``top`` or ``bottom``, both properties that have no meaning for
PDF, the stylesheets will report an error, and if ``strict`` is
set to ``true``, quit.

Likwise, the figure ``figwidth`` property will be ignored, since
there is not way to implement this property directy in FO.

In order to control the scaling, alignment, and width of images
and figures, it is better to use the attribute sets than to try
to set these properties in RST. The regions of 'image', 'figure',
'caption', and 'legend' are all wrapped in blocks. Use the
attribute sets for these blocks to control the properties.

figure-block
------------

:fo: fo:block

:defaults:

Formats the block that wraps the figure. Use this attribute set
to set properties on the image, caption, and legend, as well as
to set the space before and after the figure.

image-block
-----------

:fo: fo:block

:defaults:

Formats the block that wraps the image, both for an image by
itself, and for an image included in a figure. Use this attribute
set to control the space before and after the image, as well as
to align the image itself.

figure-caption-block
--------------------

:fo: fo:block

:defaults:

     space-before: 12pt

     space-after: 12pt

     font-weight: bold

     font-size: smaller

     text-align: center

Formats the block that wraps the caption.

figure-legend-block
-------------------

:fo: fo:block

:defaults:

     space-before: 12pt

     space-after: 12pt

Formats the block that wraps the legend. The paragrahs in the
legend have their own blocks.

legend-paragraph-block
----------------------

:fo: fo:block

:defaults:

     space-before: 12pt

Formats the block that wraps the paragraphs in the legend.

legend-first-paragraph-block
----------------------------

:fo: fo:block

:inherits: legend-paragraph-block

:defaults:

     space-before: 0pt

Formats the first block that wraps the paragraphs in the legend.


Table
=====

Attribute sets for the Table.

table-block-container
---------------------

:fo: fo:block-container

:defaults:

     space-before: 12pt

     space-after: 12pt

Formats the block container that wraps bothe the table and a the
table title (captin) if one exists. Use to control space before
and after the table.

table
-----

:fo: fo:table

:defaults:

     table-layout: fixed

     inline-progression-dimension: 100%

Formats the table.

table-header
------------

:fo: fo:table-header

:defaults:

     font-weight: bold

Formats the header of the table.

default-cell
------------

:fo: fo:cell

:defaults:

     border: solid black 1px

     padding: 1em

     border-collapse: collapse

Sets the defaults for all cells.

table-header-cell
-----------------

:fo: fo:cell

:inherits: default-cell

:defaults:

     border-bottom: solid black 2px

Formats the cells in the table header.

table-header-block
------------------

:fo: fo:block

:defaults:

Attributes for the paragraphs in the header cell.

table-body
----------

:fo: fo:table-body

:defaults:

Attributes for the table body.

table-row
---------

:fo: fo:table-row

:defaults:

     keep-together.within-page: always

Attributes for the table row.

table-cell
----------

:fo: fo:table-cell

:inherits: default-cell

:defaults:

Attributes for the table cell.

cell-block
----------

:fo: fo:block

:defaults:

Attributes for the paragraphs in the cell.

caption-block
-------------

:fo: fo:block

:defaults:

     text-align: center

     space-before: 6pt

     space-after: 6pt

Attributes for the table title, or caption. The parameter
'table-title-placement', controls whether this block is placed
before or after the table. If it is placed on top of the table,
it has a 'keep-with-next="always"' value that cannot be changed.
If this block is placed on the bottom it has a
'keep-with-previous="always"' value that cannot be changed.