Next / Previous / Contents / Shipman's homepage

6.3. Manifest constants

docbookindex
# - - - - -   M a n i f e s t   c o n s t a n t s

Names of constants are capitalized.

6.3.1. OUT_FILE_NAME

Name of the output file.

docbookindex
OUT_FILE_NAME = "toc.fo"

6.3.2. ODD_MASTER

Name of the simple-master for odd-numbered pages.

docbookindex
ODD_MASTER = "odd-master"

6.3.3. EVEN_MASTER

Name of the simple-master for even-numbered pages.

docbookindex
EVEN_MASTER = "even-master"

6.3.4. REPEAT_MASTER

Name of the page-sequence-master used for the main flow.

docbookindex
REPEAT_MASTER = "repeat-master"

6.3.5. ODD_BEFORE

Name of the header region on odd-numbered pages.

docbookindex
ODD_BEFORE = "odd-before"

6.3.6. EVEN_BEFORE

Name of the header region on even-numbered pages.

docbookindex
EVEN_BEFORE = "even-before"

6.3.7. WIDE_MARGIN

Width of the margin on the binding side of the page. To save paper, this is just wide enough to clear a standard 3-hole punch with about a pica to spare.

docbookindex
WIDE_MARGIN = "4pc"

6.3.8. NARROW_MARGIN

Width of the margins not on the binding side. Tight, to save paper.

docbookindex
NARROW_MARGIN = "3pc"

6.3.9. HEADING_EXTENT

Height of the page heading and a little more space.

docbookindex
HEADING_EXTENT = "18pt"

6.3.10. GUTTER_WIDE

Separation between the columns.

docbookindex
GUTTER_WIDE = "18pt"

6.3.11. REGION_BODY_PROPS

This dictionary specifies assorted properties on the XSL-FO region-body: two columns with a small separation.

docbookindex
REGION_BODY_PROPS = h.dash(columnCount='2', columnGap=GUTTER_WIDE)

6.3.12. PRE_TITLE

Gap between the end of the ID and the beginning of the section title in a report block.

docbookindex
PRE_TITLE = h.FoDim("1.5", "pc")

6.3.13. INDENT_PER_LEVEL

How much each section level is indented in the report. We use an instance of the FoDim class from the fohelpers.py module, because such instances support arithmetic operations that make it easy to insert computed dimensions into the output.

docbookindex
INDENT_PER_LEVEL = h.FoDim("1", "pc")

6.3.14. CONTINUED_INDENT

For those cases where the title is so long that it wraps, this dimension specifies how much further the continuation lines are indented relative to the start of the first line.

docbookindex
CONTINUED_INDENT = h.FoDim("8", "pc")

6.3.15. MAIN_FONT_FAMILY

Font families can be a comma-separated list; the output toolchain will use the first one it finds.

docbookindex
MAIN_FONT_FAMILY = "Palatino, Palladio, serif"

6.3.16. APP_FONT_FAMILY

Font family for rendering a DocBook application tag, which is to be rendered as oblique sans in the TCC standard.

docbookindex
APP_FONT_FAMILY = "Deja Vu Sans, Helvetica, sans-serif"

6.3.17. MONO_FONT_FAMILY

docbookindex
MONO_FONT_FAMILY = "Lucida Typewriter, monospace"

6.3.18. HEAD_SIZE

Size of the heading font.

docbookindex
HEAD_SIZE = "12pt"

6.3.19. BODY_SIZE

General font size.

docbookindex
BODY_SIZE = "9pt"

6.3.20. HEAD_FONT

Dictionary of font attributes for the header.

docbookindex
HEAD_FONT = h.font(fontFamily=MAIN_FONT_FAMILY, fontSize=HEAD_SIZE)

6.3.21. BODY_FONT

docbookindex
BODY_FONT = h.font(fontFamily=MAIN_FONT_FAMILY, fontSize=BODY_SIZE)

6.3.22. APP_FONT

Font for rendering DocBook application elements. No fontSize is specified, because this tag may be rendered in the header as well as the body.

docbookindex
APP_FONT = h.font(fontFamily=APP_FONT_FAMILY, fontStyle='oblique')

6.3.23. REPLACE_FONT

This font is used in FO inlines to render the DocBook replaceable element, which marks up its content as oblique (slanted) type.

docbookindex
REPLACE_FONT = h.font(fontStyle="oblique")

6.3.24. ID_FONT

For rendering the section id: a bold monospaced font.

docbookindex
ID_FONT = h.font(fontFamily=MONO_FONT_FAMILY, fontSize=BODY_SIZE,
                   fontWeight="bold")

6.3.25. MONO_FONT

For rendering DocBook code, userinput, and filename elements in title text: a regular-weight, monospaced font.

docbookindex
MONO_FONT = h.font(fontFamily=MONO_FONT_FAMILY)