# SDoP: A Simple DocBook Processor

SDoP
29 August 2018
Philip
Hazel
PH

    Cambridge, England

0.81
29 August 2018
PH
2018
Philip Hazel

## Introduction

SDoP is a Simple DocBook Processor. It reads DocBook XML input and writes PostScript output. The output can easily be converted into PDF form by the `ps2pdf` command that comes as part of the GhostScript package. This document describes SDoP version 0.81.

The first version of SDoP was written to support just those features of DocBook that were needed to format the Exim manual. Further features have been added, and this version has some support for almost all the elements that are part of Simplified DocBook, as defined in the following URL:

    http://docs.huihoo.com/docbook/simplified-docbook-definitive-guide/sdocbook.html

The main omissions are support for bibliographies, multiple authors, subtables within tables, and some element attributes. Chapter of this document contains a complete list of what SDoP does support.

I wrote SDoP because at that time the available non-commercial processors for converting DocBook into PostScript or PDF were not only slow and cumbersome, but also did not produce satisfactory output (see chapter ). I included ‘simple’ in the program’s name for the following reasons:

- SDoP does not check that the input conforms to a DocBook DTD, though it does check that element starting and ending tags are correctly nested. Few people write XML by hand, and what is generated by program is likely to be correct. There are programs such as `xmllint` that can be used to validate XML if you want to check your source before giving it to SDoP.

- SDoP does not support the full set of DocBook facilities (see chapter ). Although more features may be added, it is unlikely ever to support everything.

- SDoP is a single program, written in C, that does not rely on external information, except for a few associated data files. This makes it very fast. When it was first written it could process the Exim manual (466 pages) in under 2.5 seconds on the author’s workstation; in contrast, using `xmlto` to generate ‘formatting objects’ and then `fop` to make PostScript took around 2 minutes.

- SDoP makes no use of complicated stylesheets such as XSL, though the way it formats the output can be adjusted to some extent by means of embedded processing instructions (see chapter ).

### Installing SDoP

You should be able to build and install SDoP using the traditional commands:

    ./configure
    make
    make install

The installation consists of one binary, one man page, and a directory containing SDoP’s data files (see chapter ). This is usually installed as `/usr/local/share/sdop`. SDoP is automatically compiled with support for handling JPEG and/or PNG images if the `libjpeg` and/or `libpng` libraries, respectively, are installed. You can disable this support by adding `--disable-jpeg` and/or `--disable-png` to the `./configure` command.

### The SDoP command line

The SDoP command line is of the following form:

    sdop [options] [source file]

If no source file is given, the source is read from the standard input. Output is by default written to the standard output if the source is the standard input; otherwise it is written to a file whose name is the same as the source, but with the extension changed to `.ps`. However, the destination can be specified explicitly by the `-o` option.

The `SDOP_SHARE` environment variable can be set to a colon-separated list of directories that are searched, in order, when SDoP needs to read one of its data files (see chapter ). If the required file is not found in one of these directories, the default directory (often `/usr/local/share/sdop/`) is searched. The `-S` option can be used to override `SDOP_SHARE`.

`-d`

  This option causes a small amount of debugging output to be written to the standard error stream. More detailed output can be obtained by adding +name after `-d`; a list of debugging names can be found from the `--help` option.

`-help` or `--help`

  This causes SDoP to list the available options and then exit.

`-o` <output-file>

  This option overrides the default output destination. If the output is specified as a single hyphen character, the standard output is used.

`-p` <page-list>

  This option restricts the output to just those pages that are listed. The pages are counted from the start of the body of the document, that is, after any front matter (title pages, table of contents, preface). In other words, they are a book’s ‘normal’ page numbers.

  A comma is used to separate items in a page list, and each item can be a single page number or a hyphen-separated range. The page numbers must be in numerical order. If either of the words ‘odd’ or ‘even’ appears anywhere in the list, the entire output is restricted to either odd or even pages, respectively. If both appear, there is no restriction. For example:

      sdop -p odd,23,35-50,99 myfile.xml

  If ‘odd’ or ‘even’ is given with no page numbers, and there is no `-pf` option, all odd or even pages (respectively), including front matter pages, are output.

  By default, SDoP includes bookmark information and link information for cross-references and index page numbers in the output, for use when the PostScript is converted to PDF. However, this feature is disabled when `-p` or `-pf` is used, because the output is then incomplete.

`-pf` <page-list>

  This option is like `-p`, except that the pages are counted from the very start of the output, that is, this option is used to select pages from the book’s front matter. Unlike `-p`, ‘odd’ and ‘even’ may not appear in the page list for `-pf`. However, you can use `-p` (with or without a page list) in the same command as `-pf`, for example:

      sdop -p odd -pf 5-11 myfile.xml

  This outputs just the odd pages from those selected from the front matter.

`-q`

  This suppresses the default warnings that SDoP outputs for unsupported DocBook elements and element attributes, all of which are ignored. It overrides any setting that may be in an SDoP processing instruction within the source document.

`-qc`

  This suppresses the default warnings that SDoP output for any unsupported characters that it encounters. It overrides any setting that may be in an SDoP processing instruction within the source document. Unsupported characters are those that are not available in the PostScript fonts.

`-S` <directory list>

  This option supplies a colon-separated list of directories that are to be searched, in order, when SDoP needs to read one of its data files (see chapter ). If the required file is not found in one of these directories, the default directory (often `/usr/local/share/sdop/`) is searched.
  This option overrides a value taken from the `SDOP_SHARE` environment variable.

`-v` or `--version`

  This causes SDoP to output its version number and to list any optional facilities (such as JPEG support) that are available, and then exit.

`-w`

  This requests warning messages for unsupported DocBook elements and element attributes (the inverse of `-q`). It overrides any setting that may be in an SDoP processing instruction within the source document.

`-wc`

  This requests warnings for unsupported characters (the inverse of `-qc`). It overrides any setting that may be in an SDoP processing instruction within the source document. Unsupported characters are those that are not present in the PostScript fonts.

### SDoP input

SDoP expects its input to be XML, encoded in Unicode, using UTF-8 for characters whose code points have a value that is greater than 127. SDoP interprets XML elements (for example, `<chapter>`) as specified by DocBook, though it makes no attempt to validate the input against a DocBook DTD. There are programs such as `xmllint` that can be used for validation if you want check your source before giving it to SDoP.

You can feed SDoP fragmentary input containing, for example, just a sequence of `<para>` elements, and it will try to make sense of it. However, if the nesting of elements contradicts the DocBook DTD, the results may not be what you expect.

The elements that are recognized are listed below in chapter . Recognition of an element does not mean that SDoP actually does any processing for it. For example, `<trademark>` is recognized, but has no effect on the output. Unrecognized elements are completely ignored, though by default SDoP outputs a list of them to the standard error stream at the end of processing. This can be suppressed by means of the
`-q` command line option, or the warn_unsupported parameter (☞ ).

SDoP recognizes a number of standard entities such as `&amp;` (which represents a literal ampersand character). These are listed in chapter below. In addition, there are some special entities that are useful for referencing text strings for title pages, the table of contents, headers, and footers (☞ , , ).

### SDoP output

SDoP outputs an entire book or article as a single PostScript file. This can be viewed by applications such as GhostScript, or printed by PostScript-compatible printers. The file can also be turned into a PDF using (for example) the `ps2pdf` command that comes as part of the GhostScript package.
The PDF format supports bookmarks that are normally displayed in a sidebar, and also clickable links within the document. Fortunately, there is a scheme for including appropriate information in a PostScript file such that, when it is turned into a PDF, bookmarks and clickable links are generated.
Except when the output is restricted to specific pages by the `-p` or `-pf` options, SDoP generates such information automatically, as follows:

- If a table of contents is being generated, bookmarks are created for chapters and sections. It is possible, by making use of the toc_printed_sections parameter (☞ ), to include more entries in the PDF bookmarks than are in the printed table of contents.

- If there are any `<xref>` items in the input, clickable links are generated for their text.

- If an index is generated, the page numbers it contains are made into clickable links.

The last two facilities can be suppressed by setting the xref_links parameter to `no`. The colour of these links is by default the same colour as the surrounding text, but it can be explicitly specified by xref_rgb.

The complete output for a fully-featured book consists of the following sets of pages:

1. A title page and its reverse; this is output if there is a `<book>` element that has an associated `<title>` element, or if a title is supplied in a `<bookinfo>` element (☞ ).

2. A table of contents; this is omitted if it would be empty. The toc_sections, toc_printed_sections, and index_headings_pdf_toc parameters (☞ , ) control what is included.

3. One or more ‘prefaces’ (for example, a preface and a foreword), if present in the input.

4. The main body of the book; this is always output.

5. One or more appendices, if present in the input.

6. One or more indexes; these are output at the points where the appropriate `<index>` elements appear in the document. However, an index is not generated if there are no appropriate `<indexterm>` elements.

7. One or more colophons, if present in the input.

Although this feature is rarely needed, it is in fact possible to mix multiple indexes, chapters, and appendices in an arbitrary order.

An article is similar to a single chapter of a book. The output for an article does not have a title page or table of contents. The article’s title material appears at the top of the first body page. An article cannot contain prefaces, indexes, or colophons. An appendix is treated as a new section, whereas in a book it is treated as a new chapter.

### SDoP Errors

Error and warning messages are written to the standard error stream. If there are more than 40 warnings, subsequent ones are suppressed, with a message to say this is happening. If there are more than 40 errors, processing is abandoned. For some disastrous errors, processing is abandoned immediately.

Certain errors are not serious enough to stop processing of the input file, but would cause problems if any output were attempted. A message is output to say that nothing has been generated. In other error cases (for example, line length overflow), as well as after warnings, output is generated, but a message is written to say that it might be flawed.

The return code from SDoP is the system value EXIT_SUCCESS (usually zero) if there have been no problems more serious than a warning; otherwise it is EXIT_FAILURE (usually 1).

## Processing Instructions

XML allows for processing instructions to be embedded in sources. A processing instruction is of the form shown in this example:

    <?sdop table_warn_overflow="never" toc_sections="yes,no"?>

After the initial `<?` the name of the application for which this instruction is intended appears. All other applications that process the input should completely ignore the item. SDoP pays attention only to those that start with `<?sdop`.

A processing instruction can contain any number of parameter settings and may extend over more than one line. Each parameter specifies a value as a quoted string, the interpretation of which depends on the particular parameter. SDoP’s processing parameters are of three kinds:

- Preprocessing parameters modify the input before the main processing takes place.

- Global parameters apply throughout the document. An example might be an instruction about the format of the table of contents. SDoP scans the input for these parameters early on. If the same parameter is set more than once, it is the last value that is used.

- Local parameters are processed inline with the text. They apply only to what follows. For example, the use of hyphenation can be turned on and off for different parts of the document.

There is one restriction on SDoP’s processing instructions: they must not appear between a `<book>` and a `<bookinfo>` element or between an `<article>` and an `<articleinfo>` element.

### Including other files

A preprocessing instruction is available for including an external file at a given point in the input. The format is:

    <?sdop include="filename"?>

This could be used to bring in an SDoP ‘style’ definition (a collection of processing instructions) that is held externally. The `include` instruction is processed immediately after the main input has been read.

### Skipping parts of the input

There is a facility for skipping parts of the input. At present this feature is of little use outside the title templates (☞ , ). There are two forms of conditional:

    <?sdop ifdef="name"?>
    ...lines of input...
    <?sdop endif=""?>

    <?sdop ifndef="name"?>
    ...lines of input...
    <?sdop endif=""?>

In the first form, the intermediate lines are processed if an entity with the given name exists and contains a non-empty string. The second form applies the opposite condition. For example, a title page template might contain this:

    <?sdop ifdef="book_subtitle"?>
    <row>
    <entry>
    <emphasis role="booktitle2">&book_subtitle;</emphasis>
    </entry>
    </row>
    <?sdop endif=""?>

This example inserts a row containing the book’s subtitle in the table that is used for the title page, but only if a subtitle has been specified.

The conditional parameters are obeyed after extracting information from the `<bookinfo>` or `<article>` element, if present, and after processing any global instructions. They may be nested arbitrarily deep.

### Changing font styles

A number of parameters whose names end with _style make it easy to change the styles of fonts that are used for certain DocBook elements, without affecting other font features such as size or font family. For example, to specify the style that is to be used for the text of `<command>` elements:

    <?sdop command_style="bold"?>

The recognized values that can be specified for these parameters are: `bold`, `bolditalic`, `italic`, `mono`, `monobold`, `monobolditalic`, `monoitalic`, and `roman`.

### Changing font families

The font families that are used by default are Times, Helvetica, and Courier. These can be changed by the processing parameters serif_family, sanserif_family, and monospace_family. For example:

    <?sdop serif_family="Palatino"
           sanserif_family="AvantGarde"?>

However, the family specified must be one that SDoP knows about, so that it can generate appropriate suffixes for bold, italic, and roman fonts. The currently known families are: AvantGarde, Bookman, Courier, Helvetica, NewCenturySchlbk, Palatino, Times, and Utopia.
In addition, the font metric (AFM) files for the specific fonts must be available in SDoP’s shared data files (☞ ).

There is a facility for accessing characters from individual special fonts that are not available in the standard families, for example a font of musical characters. This uses an extension of the `<emphasis>` element (☞ ).

### Specifying fonts sizes and styles

There are a number of processing parameters with names starting font_ that allow you to specify a font size and style for a specific type of text. For example:

    <?sdop font_chapter="20,2,serif,bolditalic"?>

The first figure is the point size of the font, and the second is the additional vertical spacing (leading) that is associated with the font. For single fonts such as the one used for chapter titles, up to four comma-separated values can be given, as in the example above. Omitting a value leaves the related parameter unchanged. For example,

    <?sdop font_section="13"?>

sets the size of section titles, without changing the leading, family or style. The third value must be `serif`, `sanserif`, or `monospaced`, and the fourth must be the name of a font style (☞ ).

### Specifying font sets

Some font_ parameters control sets of fonts. For example, font_main defines the set of eight fonts (four normal, four monospaced) used for the main text. In these cases only three values are used – and the third is in fact ignored for the monospaced fonts. For example:

    <?sdop font_main="12,1,sanserif"?>

This specifies that the main text is to use 12-point, sanserif fonts, with 1 point of leading. There are also some parameters that affect only the monospaced set of fonts, thus allowing them to be a different size (for example). In these settings, the style should not be used, as it could lead to weird effects.

### Overall scaling

A parameter called scale_typesize_base can be used to change all the font sizes and leading by the same factor. The value is the font size for normal text. For example:

    <?sdop scale_typesize_base="12"?>

The default size is 11 points, so the above example would multiple all fonts sizes and leadings by 12/11. The scaling is applied after any individual size changes specified by font_ parameters. If you change the overall type sizes, you might also need to change some of the indentation parameters.

### Dimensions

Whenever a processing instruction sets a dimension (for example, the vertical space for a page footer), the value must be given as a fixed-point number, optionally followed by one of the abbreviations `pt` (points), `pc` (picas), `in` (inches), `mm` (millimetres), or `cm` (centimetres). If no units are given, points are assumed. For example:

    <?sdop foot_length="0.9in"?>

### Changing indentation

There are a number of processing parameters whose names end with _indent that allow you to change the indentation for certain kinds of text. Up to three dimensions can be given for most of them. For example:

    <?sdop blockquote_indent="1in,2cm,4pt"

The first dimension is the indent for the first lines of paragraphs; the second applies to the remaining lines, and the third is an endent, that is, an leftwards indent at the end of each line. The values may be negative, causing text to stick out over the normal ends of lines. One parameter, table_indent, has just a single dimension to set the indentation for subsequent tables.

### Lists of parameters

The following sections list all the parameters that may be present in processing instructions. Those that are marked as local can be used to apply different values in different parts of the document, whereas the global parameters set a single value for the whole document.

#### Block quotations

blockquote_indent (global)

  This specifies the indentation parameters for block quotes (☞ ). The default value is `"24,24,24"`.

blockquote_ruled (global)

  This specifies whether a block quote should be preceded and followed by horizontal rules. The value must be `yes` or `no` (the default).

blockquote_title_justify (global)

  This specifies the justification for block quote titles. The value must be `left`, `right`, or `centre` (the default).

#### Chapters and sections

chapter_skip_head (local)

  The value of this parameter must be `yes` or `no` (default). When the value is `yes`, page headings are omitted at the start of chapters. This parameter must be set before the first chapter to which it applies. If this is in the middle of the book, the best place is immediately before the relevant `<chapter>` element.

numbertitles (local)

  The value of this parameter is split up into up to 10 comma-separated substrings, each of which must be `yes` or `no`. If there are fewer than 10 substrings, the remainder are assumed to be `no`. The first substring determines whether or not chapters are to be numbered. The remaining substrings control sections, subsections, subsubsections, etc. By default, only chapters, sections, and subsections are numbered in a book. In an article, there is no numbering by default. You can change this by setting this parameter, and it works even if the setting precedes the `<article>` element.

#### Cross-references

xref_links (global)

  The value of this parameter must be `yes` (default) or `no`. If it is set to `no`, information for generating clickable links for cross-references and index page numbers in a PDF is not included in the PostScript output. Note that the use of the `-p` and `-pf` command line options also suppresses this output.

xref_rgb (global)

  This parameter specifies the colour of the text of cross-references and index page numbers that are made into clickable links when the output is converted to a PDF. For example:

      <?sdop xref_rgb="0,0,1"?>

  The value of the parameter is a red-green-blue triple of values between 0 and 1; the above example sets the colour to blue. If this parameter is not set, the text colour is determined in the same way as normal text (☞ ).

#### Examples in the text

example_number_format (local)

  This parameter controls the format of example numbers that are (optionally) added to example titles, and can also be inserted as cross-references. The value is a string that can contain up to two instances of `%s`. If there is just one, the example number, counting from the start of the document, is inserted. If there are two, the first is replaced by the chapter number, and the second by the example number, counting from the start of the chapter. The default setting is `%s-%s`, leading to example numbers of the form `2-7`.

example_title_format (local)

  This parameter controls the format of example titles. Its value is inserted before the text given in the `<title>` elelment of a example. The string may contain a single instance of `%s`, which is is replaced by the example number, in the format defined by example_number_format. The default setting is the string `Example` `%s:` followed by a terminating space.

example_title_justify (local)

  The value of this parameter specifies how example titles are formatted. Its value must be one of the words `left`, `right`, `centre` (or `center`), or `both`, with the default being `centre`. If a example contains a `<mediaobject>`, its alignment is taken as the example’s alignment. Otherwise the example is assumed to be left justified.

example_title_width (local)

  This parameter controls the width of example titles. Text that is longer than the width is split into multiple lines. The default is to take the width of a `<mediaobject>` if available, otherwise the page width. The value may be an absolute dimension, or the word `object`, signifying the default.

#### Figures in the text

figure_number_format (local)

  This parameter controls the format of figure numbers that are (optionally) added to figure titles, and can also be inserted as cross-references. The value is a string that can contain up to two instances of `%s`. If there is just one, the figure number, counting from the start of the document, is inserted. If there are two, the first is replaced by the chapter number, and the second by the figure number, counting from the start of the chapter. The default setting is `%s-%s`, leading to figure numbers of the form `4-5`.

figure_title_format (local)

  This parameter controls the format of figure titles. Its value is inserted before the text given in the `<title>` element of a figure. The string may contain a single instance of `%s`, which is is replaced by the figure number, in the format defined by figure_number_format. The default setting is the string `Figure` `%s:` followed by a terminating space.

figure_title_justify (local)

  The value of this parameter specifies how figure titles are formatted. Its value must be one of the words `left`, `right`, `centre` (or `center`), or `both`, with the default being `centre`. If a figure contains a `<mediaobject>`, its alignment is taken as the figure’s alignment. Otherwise the figure is assumed to be left justified. The title is formatted and positioned in relation to the figure, according to the value of figure_title_justify. For example, if the figure is left aligned and the title is centred, it is centred with the figure if possible (it may not be possible for an overlong title), not with the page.

figure_title_width (local)

  This parameter controls the width of figure titles. Text that is longer than the width is split into multiple lines. The default is to take the width of a `<mediaobject>` if available, otherwise the page width. The value may be an absolute dimension, or the word `object`, signifying the default. For many figures the default works well. However, for small figures it may be necessary to specify a width that is greater than the width of the figure.

#### Font specification

The local parameters in this section should not be changed within a footnote.

command_style (global)

  This sets the style of font to be used for `<command>` elements (☞ ). The default is italic.

font_blockquote_title (global)

  This specifies the font for blockquote titles. The default value is `"11,1,serif,bold"`.

font_booktitle1 (global)
font_booktitle2 (global)
font_booktitle3 (global)
font_booktitle4 (global)

  These four parameters specify the fonts that can be used for different levels of title on book title pages (☞ ). The defaults are all sanserif bold, with respective sizes and leading `"24,2"`, `"18,1.5"`, `"15,1.25"`, and `"13,1"`.

font_chapter (global)

  This specifies the font for chapter titles, which is also used for article titles. The default value is `"16,0,sanserif,bold"`.

font_chapter_subtitle (global)

  This specifies the font for chapter subtitles, which is also used for article subtitles. The default value is `"12,0,sanserif,bold"`.

font_figure_title (global)

  This specifies the font for figure titles. The default value is `"11,1,serif,italic"`.

font_footnote (global)

  This specifies the set of eight fonts that are used for footnotes (☞ ). The default value is `"9,1,serif"`.

font_footnotemono (global)

  This specifies just the set of four monospaced fonts that are used for footnotes. The default value is `"9,1"`.

font_formalpara_title (global)

  This specifies the font for formal paragraph titles. The default value is `"11,1,serif,bold"`.

font_headfoot (global)

  This specifies the set of eight fonts that are used in heads and feet. The default value is `"11,1,serif"`.

font_headfootmono (global)

  This specifies just the set of four monospaced fonts that are used for heads and feet. The default value is `"11,1"`.

font_ilist_tag (local)

  This specifies the font that is used for the ‘tags’ in subsequent idenfified lists. The default value is whatever is set for font_main; the style can also be changed by ilist_tag_style.

font_index (global)

  This specifies the set of eight fonts that are used for the text in indexes. The default is `"9.6,1,serif"`.

font_index_section (global)

  This specifies the font that is used for ‘section titles’ in indexes. The default is `"11.5,0,sanserif,bold"`.

font_indexmono (global)

  This specifies just the set of four monospaced fonts that are used for the text in indexes. The default is `"9.6,1"`.

font_main (global)

  This specifies the set of eight fonts that are used for the main body text. The default is `"11,1,serif"`.

font_mainmono (global)

  This specifies just the set of four monospaced fonts that are used for the main body text. The default is `"11,1"`.

font_note_title (global)

  This specifies the font for note titles. The default value is `"11,1,serif,italic"`.

font_olist_tag (local)

  This specifies the font that is used for the ‘tags’ in subsequent ordered lists. The default value is whatever is set for font_main; the style can also be changed by olist_tag_style.

font_section (global)

  This specifies the font that is used for top-level section titles. The default is `"13,0,sanserif,bold"`.

font_subsection (global)

  This specifies the font that is used for section titles other than those at the top level. The default is `"11,0,sanserif,bold"`.

font_sidebar_title (global)

  This specifies the font for sidebar titles. The default value is `"11,1,serif,bold"`.

font_small_main (global)

  This specifies the set of eight fonts that are used for ‘small’ main body text (☞ ). The default is `"9,1,serif"`.

font_small_mainmono (global)

  This specifies just the set of four monospaced fonts that are used for ‘small’ main body text (☞ ). The default is `"9,1"`.

font_table_title (global)

  This specifies the font for table titles. The default value is `"11,1,serif,italic"`.

font_title (global)

  This specifies the set of eight fonts that are used for any text that appears on title pages, except where such text is explicitly marked as being in a title font by the use of `<emphasis>` (☞ ). Normally the fonts set by font_title are used for general information on the reverse of a title page. The default value is `"11,1,serif"`.

font_title_section (global)

  This specifies the font that is used for any section headings on title pages. These might be used to separate information on the reverse of a title page. The default value is `"11.5,0,sanserif,bold"`.

font_titlemono (global)

  This specifies just the set of four monospaced fonts that are used for text on title pages. The default value is `"11,1"`.

font_toc (global)

  This specifies the set of eight fonts that are used for the text of the table of contents. The default value is `"11,1,sanserif"`.

font_toc_fill (global)

  This specifies the font that is used for the ‘filler’ in table of contents lines. The default value is `"11,0,serif,roman"`.

font_tocmono (global)

  This specifies just the set of four monospaced fonts that are used for text in tables of contents. The default value is `"11,0"`.

function_style (global)

  This sets the style of font to be used for `<function>` elements (☞ ). The default is italic.

ilist_tag_rgb (local)

  This specifies the colour of the tags for itemized lists (default black). The value is a comma-separated triple of red-green-blue values in the range 0 to 1.

ilist_tag_style (local)

  This parameter sets the font style (☞ ) for the identification ‘tags’ on each item of an itemized list. The default is taken from font_main, and can also be changed by font_ilist_tag.

monospace_family (global)

  The value of this parameter must be the name of one of the known font families (☞ ). The default is Courier. It is used for monospaced text. The results are unpredictable if the fonts are not in fact monospaced.

olist_tag_rgb (local)

  This specifies the colour of the tags for ordered lists (default black). The value is a comma-separated triple of red-green-blue values in the range 0 to 1.

olist_tag_style (local)

  This parameter sets the font style (☞ ) for the numeration on each item of an ordered list. The default is taken from font_main, and can also be changed by font_olist_tag.

option_style (global)

  This sets the style of font to be used for `<option>` elements (☞ ). The default is bold.

replaceable_style (global)

  This sets the style of font to be used for `<replaceable>` elements (☞ ). The default is italic.

sanserif_family (global)

  The value of this parameter must be the name of one of the known font families (☞ ). The default is Helvetica.

scale_typesize_base (global)

  This parameter can be used to scale all the font sizes at once. The value is a point size for ‘normal’ text. For example:

      <?sdop scale_typesize_base="13"?>

  This changes the normal font size from 11 to 13 points, and scales other fonts (for chapter titles, etc.) in proportion. This scaling is applied after specific font sizes have been set up by the font_xxx parameters. It is useful for making small adjustments to the default font sizes; if the change is large, you may have to adjust other spacing such as the indents.

serif_family (global)

  The value of this parameter must be the name of one of the known font families (☞ ). The default is Times.

userinput_style (global)

  This sets the style of font to be used for `<userinput>` elements (☞ ). The default is monospaced.

varname_style (global)

  This sets the style of font to be used for `<varname>` elements (☞ ). The default is italic.

#### Heads and feet

foot_centre_recto (local)
foot_centre_verso (local)
foot_left_recto (local)
foot_left_verso (local)
foot_right_recto (local)
foot_right_verso (local)

  These parameters set texts for use in page footers on righthand (recto) and lefthand (verso) pages (☞ ). The default value for the two centre parameters is `"&arabicpage;"`, which inserts an arabic page number. The others default to empty strings. You normally need to force a new page before changing footer contents in the middle of a document.

foot_length (global)

  This sets the amount of vertical space that is reserved for the footer at the bottom of each page. The default is 24 points.

head_centre_recto (local)
head_centre_verso (local)
head_left_recto (local)
head_left_verso (local)
head_right_recto (local)
head_right_verso (local)

  These parameters set texts for use in page headers on righthand (recto) and lefthand (verso) pages (☞ ). They all default to empty strings.

head_length (global)

  This sets the amount of vertical space that is reserved for the header at the top of each page. The default is zero, which causes no header to be output.

preface_foot_centre_recto (local)
preface_foot_centre_verso (local)
preface_foot_left_recto (local)
preface_foot_left_verso (local)
preface_foot_right_recto (local)
preface_foot_right_verso (local)

  These parameters set texts for use in preface page footers on righthand (recto) and lefthand (verso) pages (☞ ). The default value for the two centre parameters is `"&romanpage;"`, which inserts an roman page number. The others default to empty strings. You normally need to force a new page before changing footer contents in the middle of a document.

preface_head_centre_recto (local)
preface_head_centre_verso (local)
preface_head_left_recto (local)
preface_head_left_verso (local)
preface_head_right_recto (local)
preface_head_right_verso (local)

  These parameters set texts for use in preface page headers on righthand (recto) and lefthand (verso) pages (☞ ). They all default to empty strings.

#### Indexes

index_headings (local)

  The value of this parameter must be `yes` (default) or `no`. The default is to insert headings into indexes when the leading letter of the entries changes, unless every entry starts with the same character. No headings are inserted if the value is `no`. These headings never appear in a printed table of contents, but they may be present in PDF tables of contents (see next parameter).

index_headings_pdf_toc (local)

  The value of this parameter must be `yes` or `no` (default). It is inspected only if index_headings is is set and a table of contents is being created. If it is `yes`, entries for each index heading (change of letter) are created for a PDF table of contents.

index_sort_omit (global)

  This specifies a list of characters that are to be ignored when sorting index entries. The default is to ignore the ‘break permitted here’ (U+0082), ‘no break here’ (U+0083), zero-width space (U+200B) and opening and closing double quote (U+201C and U+201D) characters. Setting this parameter completely replaces the list of characters.

      <?sdop index_sort_omit="[]*&lsquo;"

  This example ignores only square brackets, asterisk, and opening single quote. As the example shows, you can use entity names in the list. However, only those entities that represent a single character are permitted.

#### Lists: itemized, ordered and variable

Parameters for specifying the colour and font style for itemized and ordered list ‘tags’ are described in the section on fonts (☞ ). The parameters in this section should not be changed within a footnote.

ilist_indent (global)

  This specifies the indent parameters for itemized lists (☞ ). The default value is `"12,12,0"`.

olist_format (local)

  The value of this parameter controls what is printed when numbering an ordered list. The format of item numbers is controlled by the `numeration` attribute of the `<orderedlist>` element – this parameter controls the additional characters (for example, punctuation) that are added. It may contain entity names, and must contain `%s` at the point where the item number is to be inserted. The default value is `(%s)`, which outputs the number in parentheses. The font style for the whole string can be specified by the olist_style parameter.

olist_indent (global)

  This specifies the indent parameters for ordered lists (☞ ). The default value is `"24,24,0"`.

vlist_indent (global)

  This sets the indent parameters for the paragraphs in a variable list (☞ ). The default is `"14,14,0"`.

vlist_term_indent (global)

  This sets the indent parameters for `<term>` items within a variable list (☞ ). The default is `"0,0,0"`.

vlist_title_indent (global)

  This sets the indent parameters for the title of a variable list (☞ ). The default is `"0,0,0"`.

#### Literal blocks

literal_indent (global)

  This specifies the indent parameters for blocks of literal text (☞ ). The default value is `"12,12,0"`.

literal_indent_fudge (global)

  The value of this parameter must be `yes` (default) or `no`. It controls the handling of lines within `<literallayout>` elements. If this facility is turned on, and there is a common indent for every line, it is removed. For example:

      <literallayout>
        abcd efgh
             ijkl
      </literallayout>

  is treated as if it were:

      <literallayout>
      abcd efgh
           ijkl
      </literallayout>

  This feature exists because SDoP automatically indents literal blocks within other indented items such as lists, whereas some other DocBook processors do not. Input that was created for other processors may therefore contain explicit indents that are not needed for SDoP and which, if heeded, lead to excessive indentation.

#### Notes

note_indent (global)

  This specifies the indentation parameters for notes (☞ ). The default value is `"24,24,24"`.

note_ruled (global)

  This specifies whether a note should be preceded and followed by horizontal rules. The value must be `yes` or `no` (the default).

note_title_justify (global)

  This specifies the justification for note titles. The value must be `left`, `right`, or `centre` (the default).

#### Page layout

format (local)

  The only recognized value for this parameter at present is `newpage`. It forces a new page in the output.

main_even_pages (global)

  The value of this parameter must be `yes` or `no` (default). If it is set to `yes`, SDoP ensures that the main body of the output fills an even number of pages, adding a blank page at the end if necessary.

margin_bottom (global)

  This specifies the amount of space at the bottom of each page. The default is 60 points (a bit less than an inch).

margin_left_recto (global)

  This specifies the amount of space at the lefthand side of righthand pages. The default is 72 points (one inch).

margin_left_verso (global)

  This specifies the amount of space at the lefthand side of lefthand pages. The default is 72 points (one inch).

page_columns (local)

  This parameter sets the number of columns on the page (default 1). It is used automatically to print indexes in two columns, and that is the main use for which it was implemented. It is not a very sophisticated implementation. A page break is forced if the number of columns is changed when text is currently being formatted into a column other than the first.

page_column_separation (local)

  This parameter specifies the separation between multiple columns on the page. The default value is 16 points.

page_foot_line_width (global)

  This specifies the width of lines in footers at the bottom of each page. The default is the value of page_line_width.

page_full_length (global)

  This specifies the full length of the page that is used for printing, including any heads and feet. The default is 720 points (10 inches).

page_head_line_width (global)

  This specifies the width of lines in headers at the top of each page. The default is the value of page_line_width.

page_line_width (global)

  This specifies the width of lines on the page. The default is 450 points (6.25 inches).

paper_size (global)

  If this parameter is set, it causes a `/PageSize` setting to be included in the PostScript. It is not necessary for normal output, but can be useful if SDoP is used to make a PDF for a slideshow (see chapter ). The value must be two numbers in points, separated by the letter `x`. For example:

      <?sdop paper_size="900x660"?>

  The first number specifies the width and the second the depth.

#### Paragraphs

formalpara_indent (global)

  This specifies the indent parameters for formal paragraphs (☞ ). The default value is `"0,0,0"`.

para_indent (global)

  This specifies the indent parameters for normal paragraphs (☞ ). The default value is `"0,0,0"`.

#### Side bars

sidebar_indent (global)

  This specifies the indentation parameters for sidebars (☞ ). The default value is `"24,24,24"`.

sidebar_ruled (global)

  This specifies whether a sidebar should be preceded and followed by horizontal rules. The value must be `yes` or `no` (the default).

sidebar_title_justify (global)

  This specifies the justification for sidebar titles. The value must be `left`, `right`, or `centre` (the default).

#### Subscripts and superscripts

subscript_small (local)

  If the value of this parameter is `yes` (the default), subscripts are printed in a small font. At present, the footnote font is used for this. If the value is `no`, subscripts are printed at normal size. This parameter is ignored when printing titles; the title font is always used.

subscript_down (local)

  The value of this parameter must be a number in the range 1–127. It specifies the percentage of the line depth by which subscripts are lowered. The default value is 33.

superscript_small (local)

  If the value of this parameter is `yes` (the default), superscripts are printed in a small font. At present, the footnote font is used for this. If the value is `no`, superscripts are printed at normal size. This parameter is ignored when printing titles; the title font is always used.

superscript_up (local)

  The value of this parameter must be a number in the range 1–127. It specifies the percentage of the line depth by which superscripts are raised. The default value is 33.

#### Tables in the text

table_indent (local)

  This parameter’s data is a single dimension that specifies an indent for all subsequent tables in the document.

table_number_format (local)

  This parameter controls the format of table numbers that are (optionally) added to table titles, and can also be inserted as cross-references. The value is a string that can contain up to two instances of `%s`. If there is just one, the table number, counting from the start of the document, is inserted. If there are two, the first is replaced by the chapter number, and the second by the table number, counting from the start of the chapter. The default setting is `%s-%s`, leading to table numbers of the form `2-7`.

table_title_format (local)

  This parameter controls the format of table titles. Its value is inserted before the text given in the `<title>` elelment of a table. The string may contain a single instance of `%s`, which is is replaced by the table number, in the format defined by table_number_format. The default setting is the string `Table` `%s:` followed by a terminating space.

table_title_justify (local)

  The value of this parameter specifies how table titles are formatted. Its value must be one of the words `left`, `right`, `centre` (or `center`), or `both`, with the default being `left`. The title is formatted and positioned in relation to the table. For example, if the title is centred, it is centred with the table if possible (it may not be possible for an overlong title), not with the page.

table_title_width (local)

  This parameter controls the width of table titles. Text that is longer than the width is split into multiple lines. The default is the width of the table. The value may be an absolute dimension, or the word `object`, signifying the default.

table_warn_overflow (local)

  This parameter controls what happens when a cell in a table overflows (☞ ). Text in table cells can be split into multiple lines if it contains any splitting points; the overflow case occurs when the text cannot be split. The value of this parameter must be `always` (default), `never`, or `overprint`. In the default case, a cell overflow is a hard error, and a warning message is always output. Conversely, if `never` is specified, the overflow is ignored.

  If the value is `overprint`, a warning is generated only when the overflow actually causes overprinting of the contents of an adjacent cell, or of a separator (vertical line) between the two cells. In other words, when there is no cell separator, one cell may overflow into the next, provided that its text does not actually overprint the adjacent cell’s text.

#### Table of contents

toc_chapter_blanks (global)

  The value of this parameter controls the spacing around chapter entries in the table of contents. It consists of two `yes`/`no` substrings, separated by a comma. The default value is:

      <?sdop toc_chapter_blanks="yes,yes"?>

  If the first substring is `yes`, a blank line is inserted before each chapter line in the table of contents, except for the first chapter. If the second substring is `yes` a blank line is inserted before the first section line that follows a chapter line. Missing substrings are interpreted as `no`.

toc_even_pages (global)

  The value of this parameter must be `yes` (default) or `no`. If it is set to `yes`, SDoP ensures that the table of contents fills an even number of pages, adding a blank page at the end if necessary.

toc_fill_leftspace (global)

  The value of this parameter is a dimension (default 2 points). It specifies the amount of space to leave after an entry in the table of contents before starting the ‘filler’ sequence (typically a row of dots).

toc_fill_rightspace (global)

  The value of this parameter is a dimension (default 4 points). It specifies the amount of space to leave after the ‘filler’ sequence in an entry in the table of contents, immediately before the page number.

toc_fill_string (global)

  The value of this parameter is a literal string (default `"."`). It specifies the string that is replicated to create the ‘filler’ in table of contents lines.

toc_foot_centre_recto (global)
toc_foot_centre_verso (global)
toc_foot_left_recto (global)
toc_foot_left_verso (global)
toc_foot_right_recto (global)
toc_foot_right_verso (global)

  These parameters set texts for use in table of contents page footers on righthand (recto) and lefthand (verso) pages (☞ ). The default value for the two centre parameters is `"&romanpage;"`, which inserts an roman page number. The others default to empty strings. These are global processing parameters because there is no way of changing them in the middle of a table of contents.

toc_head_centre_recto (global)
toc_head_centre_verso (global)
toc_head_left_recto (global)
toc_head_left_verso (global)
toc_head_right_recto (global)
toc_head_right_verso (global)

  These parameters set texts for use in table of contents page headers on righthand (recto) and lefthand (verso) pages (☞ ). They all default to empty strings. These are global processing parameters because there is no way of changing them in the middle of a table of contents.

toc_line_chapter_strings (global)

  The value of this parameter is split into six, comma-separated substrings. They control the format of lines in the table of contents that refer to chapters. If a literal comma is required in one of the substrings, it must be preceded by an ampersand. Here is a totally unrealistic example (a realistic one would be too wide for the page):

      <?sdop toc_line_chapter_strings="A&,A,BB,CC,DD,EE,FF"?>

  The six strings are used to construct the table of contents line as follows:

  - The first string is always used at the start of the line;

  - If chapter numbers are being included in the table of contents, the second string is inserted, followed by the chapter number and the third string. If chapter numbers are not being included, the second and third strings are ignored.

  - Then come the chapter title and the fourth string.

  - At this point, a suitable number of copies of the filler string, as defined by toc_fill_string, are inserted.

  - The line ends with the fifth string, the page number, and finally the sixth string.

  The default values for the strings are:

  | `<emphasis role='bold'>` | Start of line
  | (empty) | Before chapter number
  | `.&nbsp;&nbsp;` | After chapter number
  | `</emphasis>` | After title
  | `<emphasis role='bold'>` | Before page number
  | `</emphasis>` | After page number

  The entity `&nbsp;` is a ‘non-breaking space’, that is, it is a space that is treated as if it were a printing character.

toc_line_sect1_strings (global)

  The value of this parameter is treated in the same way as toc_line_chapter_strings, except that it applies to first-level section lines in the table of contents. The default values for the strings are:

  | `&nbsp;&nbsp;&nbsp;&nbsp;` | Start of line
  | (empty) | Before section number
  | `&nbsp;&nbsp;` | After section number
  | (empty) | After title
  | (empty) | Before page number
  | (empty) | After page number

toc_line_sect2_strings (global)

  The value of this parameter is treated in the same way as toc_line_chapter_strings, except that it applies to second-level (subsection) and any lower level section lines in the table of contents. The default values for the strings are the same as for first-level sections, except that the initial indent is eight spaces rather than four.

toc_printed_sections (local)

  This parameter works in conjunction with toc_sections. Its default value is the same as for toc_sections, and it is altered whenever toc_sections is changed. If you want toc_​printed_​sections to be different, you must set it after setting toc_sections (each time, if there is more than one setting). The value of toc_printed_sections is in the same format as toc_sections, but it can only specify fewer items. This makes it possible to limit the table of contents that is printed (that is, forms part of the document’s text), while at the same time retaining a more comprehensive version in the output file for conversion to a PDF table of bookmarks. For example:

      <?sdop toc_sections="yes,yes,yes,no"
        toc_printed_sections="yes,yes,no"?>

  This example restricts the printed table of contents to chapters and sections, but includes subsections as well in a PDF version.

toc_sections (local)

  The value of this parameter must be a sequence of up to 10 comma-separated substrings. It controls which parts of the document are to be listed in the table of contents. As it is a local processing parameter, the choice can be different in different parts of the document. For example, you can include section titles in the table of contents in the body of the book, but not for the preface. If you set toc_sections without setting toc_printed_sections, the selection applies both to what is printed, and to what is included in the online bookmarks if the output is converted to PDF.

  The first substring applies to chapters and chapter-like parts such as appendices. Subsequent substrings apply to successive levels of nested sections, until one of them is `no`. If the first value is `no`, no table of contents is output. In this case, no bookmark information is available in the PostScript, so if it is converted to PDF, there is no PDF table of bookmarks either.

  There are two default values, one for prefaces, and one for the body of the document. For prefaces, the default is:

      <?sdop toc_sections="yes,no"?>

  That is, only the preface title is included by default in the table of contents. Any sections within the preface are omitted. For the rest of the document, the default value is:

      <?sdop toc_sections="yes,yes,yes,no"?>

  This includes chapters, sections, and subsections, but nothing deeper. The way settings of this parameter are processed is as follows:

  - Before processing the prefaces, the preface default is set. A setting that precedes the first preface can be used to override the default. Thus, for example, if you have `<?sdop toc_sections="no"?>` before the first preface, it will not be included in the table of contents. Subsequent settings that are within the prefaces apply to the following preface material.

  - After the prefaces have been processed, the body default is set. A setting that precedes the first preface again overrides this, but settings that are within the prefaces are now ignored. The preface material is skipped, and the rest of the document is processed. Subsequent settings apply to the body material that follows them.

  Note in particular that a setting preceding the first preface applies both to the preface and to the main body of the document. If you want something different for the body, you must include another setting after the prefaces.

toc_title (global)

  The value of this parameter is used as the title for the table of contents. The default is `Contents`.

#### Warnings

warn_unsupported (global)

  The value of this parameter must be `yes` (default) or `no`. If it is set to `yes`, SDoP outputs a list of unrecognized DocBook elements and parameters to the standard error at the end of processing. This setting can be overridden by the use of `-q` or `-w` on the command line.

warn_unsupported_characters (global)

  The value of this parameter must be `yes` (default) or `no`. If it is set to `yes`, SDoP outputs a warning message the first time it encounters a character that is not supported. An unsupported character is one that is not present in the current PostScript font. This setting can be overridden by the use of `-qc` or `-wc` on the command line.

#### Other parameters

The remaining processing parameters are listed here in alphabetical order.

background_rgb (global)

  This sets a colour for the background of each page. Its intended use is for when SDoP is being used to create slides rather than printed pages (see chapter ). It is necessary also to set paper_size so that SDoP knows the area that is to be coloured. The value is a comma-separated triple of red-green-blue values in the range 0 to 1.

extra_leading (local)

  This parameter’s data must be a dimension. It specifies an extra amount of vertical space that is to be inserted between the lines of the next and subsequent paragraphs.

hyphenate (local)

  The value of this parameter must be `yes` (default) or `no`. When it is set to `yes`, hyphenation is enabled (☞ ).

kern (local)

  The value of this parameter must be `yes` (default) or `no`. If it is set to `yes`, kerning of adjacent letters in words is enabled. Kerning adjusts the spacing between letters to make the result look nicer.

#### Obsolete synonyms

As SDoP has developed, the names of some parameters have been changed to be more appropriate to their function. The old names still work, but cause warnings to be generated.

Old name | New name
ilist_font | ilist_tag_style
olist_font | olist_tag_style
olist_format | olist_tag_format
orderedlist_format | olist_tag_format
term_indent | vlist_term_indent
command_font | command_style
function_font | function_style
option_font | option_style
replaceable_font | replaceable_style
userinput_font | userinput_style
varname_font | varname_style

## Using information from `<bookinfo>` or `<articleinfo>`

Using `<`xxx `info>` information

Information is extracted from the `<bookinfo>` or `<articleinfo>` elements and made available for insertion at arbitrary places in the document in two different ways:

1. Simple text strings are placed in special entities; for example, the data from the `<surname>` element inside `<author>` is inserted anywhere that `&author_surname;` appears.

2. Two more complicated items that contain further entities are inserted by one of the following processing instructions:

       <?sdop insert="legalnotice"?>
       <?sdop insert="revdescription"?>

   If there are multiple occurrences of `<legalnotice>` or `<revdescription>`, they are inserted in order of definition.

Both kinds of insert can appear anywhere in the document, though they are most commonly found in title pages. The special entities are shown in the table below. If no title, subtitle, or title abbreviation is provided in the `<bookinfo>` element, values from the `<book>` element are used if they exist. In other words, `<bookinfo>` overrides `<book>`.

The names of the entities do not change for `<article>`s, even though the information is taken from `<articleinfo>` rather than `<bookinfo>`. For example, you must use `&book_title;` to insert the article’s title.

| `&author_address;`
| `&author_corpauthor;`
| `&author_firstname;`
| `&author_honorific;`
| `&author_initials;`
| `&author_jobtitle;`
| `&author_lineage;`
| `&author_orgname;`
| `&author_othername;`
| `&author_surname;`
| `&book_cpyholder;`
| `&book_cpyyear;`
| `&book_date;`
| `&book_edition;`
| `&book_issuenum;`
| `&book_pubdate;`
| `&book_publishername;`
| `&book_releaseinfo;`
| `&book_revauthorinitials;`
| `&book_revdate;`
| `&book_revnumber;`
| `&book_subtitle;`
| `&book_title;`
| `&book_titleabbrev;`
| `&book_volumenum;`
| `&editor_firstname;`
| `&editor_honorific;`
| `&editor_initials;`
| `&editor_jobtitle;`
| `&editor_lineage;`
| `&editor_orgname;`
| `&editor_othername;`
| `&editor_surname;`
| `&othercredit_firstname;`
| `&othercredit_honorific;`
| `&othercredit_initials;`
| `&othercredit_jobtitle;`
| `&othercredit_lineage;`
| `&othercredit_orgname;`
| `&othercredit_othername;`
| `&othercredit_surname;`

## SDoP data files

SDoP uses a number of auxiliary data files in its processing. The distributed versions are normally installed in a public directory such as `/usr/local/share/sdop/`. The `SDOP_SHARE` environment variable or the `-S` command line option can be used to supply a list of directories to search before the standard one, thereby providing a means for individual users to override the default files. This chapter discusses the uses that are made of the different files.

### PostScript header file

At the start of SDoP’s output, it writes a copy of the file `PSheader` (with PostScript comments removed). This is a typical PostScript header file that defines some PostScript functions for use by the following code. In particular, it contains a function for loading fonts and adjusting their encodings.

### Font metrics

Any typsetting program needs to know the metrics of the fonts it is using. SDoP is distributed with AFM files for all the standard Adobe fonts in a subdirectory called `fontmetrics`. For example, the file for the Times Roman font is in `fontmetrics/Times-Roman.afm`.

### Hyphenation dictionary

SDoP does hyphenation by means of a dictionary. A dictionary for British English is installed in the file `HyphenData`. The source of this file, and the program that prepares it for use are also distributed (see chapter ).

### Title pages for books

The file `titletemplate` is a template for the title pages of a book. There are some special entities and an ‘insert’ facility that can be used in the title pages to insert data obtained from the `<bookinfo>` element (see chapter ).

The distibuted version of `titletemplate` is an input fragment that defines two tables, one for each of two pages. The tables are defined in XML, but there are also a number of SDoP conditional processing parameters that control what is output on the title pages (☞ ), depending on what data has been supplied. If no book title is available, no title pages are output.

The `<emphasis>` element can be used in title pages with `role="booktitle` n`"`, where n is a number between 1 and 4. This selects one of four different sizes of title font: 24, 16, 18, or 13 points.

You can provide your own title page layout by copying `titletemplate` to another file, editing it to your own requirements, and passing the name of the directory where it resides to SDoP using the `-S` command line option.

### Article titles

The file `arttemplate` is a template for the title material of an article, which appears at the top of the first page if an article title has been defined. The distributed version is an input fragment that defines a single table containing the heading material. It is similar to the first table used for a book’s title page, as described in the previous section, except that the values of the special entities are obtained from the `<articleinfo>` element rather than `<bookinfo>`. Nevertheless, the same entity names are used (for example, `&book_date;` rather than `&article_date;`).

### Table of contents

The table of contents is mostly generated dynamically as a `<table>` that is processed internally by SDoP. However, the start of the table of contents ‘chapter’ and the beginning of the `<table>` is obtained from a file called `toctemplate`. You are unlikely to want to modify this, except perhaps to change the format of the title. The special entity `&toc_title;` contains the string set by the toc_title global processing parameter (☞ ). The default is `Contents`. If you just want to change this text, use the processing parameter.

### Headers and footers

A page header or footer is output only if space has been reserved for it. By default, SDoP reserves 24 points of vertical space for a footer, but no header. The head_length and foot_length processing parameters can be used to ajust the allocations. When headers are in use, those on pages that start chapters can be independently suppressed by setting the chapter_skip_head processing parameter to `yes`.

There are two files called `headtable` and `foottable` that define head and foot lines for the body of the document and any appendixes, indexes, and colophons. There are similar files called `headtable-t` and `foottable-t` for the table of contents, and a third set called `headtable-p` and `foottable-p` for the preface(s).

A two-level substitution process is used for head and foot lines. This makes it possible to have different heads and feet on left-hand and right-hand pages, while also making it easy to change their contents by means of local processing parameter settings. However, if you want to change the overall layout of heads of feet, you have to provide new template files.

In the supplied templates, an XML table is used, containing references to the following special entities:

| `&footcentre;` | centre foot text
| `&footleft;` | left foot text
| `&footright;` | right foot text
| `&headcentre;` | centre head text
| `&headleft;` | left head text
| `&headright;` | right head text

As their names suggest, these are placed in table cells that are respectively left-, centre-, and right-justified. The values of these entities for the main body of the book and the preface(s) can be set by local processing parameters (☞ ). This means they can be varied during the course of the document; it is usually necessary to force a new page before changing the contents of the footer.

For the table of contents, the values are set by global processing parameters (☞ ), because there is no way to change them in the middle of the table of contents.

References to other entities are permitted in the values set for the above special entities. The default for the main body pages is to print an arabic page number in the centre of the footer, equivalent to:

    <?sdop foot_centre_recto="&arabicpage;"
           foot_centre_verso="&arabicpage;"?>

This setting means that, on both right-hand (recto) and left-hand (verso) pages, the value of `&footcentre;` is `&arabicpage;`. If you want to have page numbers on the left and right instead, you could use:

    <?sdop foot_centre_recto=""
           foot_centre_verso=""
    <?sdop foot_right_recto="&arabicpage;"
           foot_left_verso="&arabicpage;"?>

It is not possible to include markup when changing the values of these strings. If you want to change the markup in headers or footers, you have to provide your own template files.

Other useful entities that are available in header and footer lines are `&chapternumber;`, `&chaptertitle`, `&sectionnumber`, and `&sectiontitle`. In the case of titles, the value is taken from a `<titleabbrev>` element if present, otherwise from `<title>`. Here is an example of a processing instruction that adds the chapter title and number to footer lines, on the right and left, respectively:

    <?sdop
      foot_right_recto="&chaptertitle; (&chapternumber;)"
      foot_left_verso="&chaptertitle; (&chapternumber;)"
    ?>

During chapter-like components such as prefaces, appendices, indexes, and colophons, the title is placed in `&chaptertitle`.

In an article, `&chaptertitle` contains the title of the article. In an appendix in an article, the title is placed in `&sectiontitle`, because it behaves like a section and does not start a new page.

You can use `&romanpage;` to obtain the page number as a roman numeral. This is used in the default settings for the table of contents and the preface(s), where the page number is printed in italic.

If you want to use a rule (a horizontal line) in a header or a footer, you can do so by providing your own template file containing a suitable table with a top or bottom frame line.

### Index sorting

The file called `indexcollate` controls the order in which index items are sorted. There are comments in the file that explain its format. You can change the index sorting order by overriding this file.

## Typesetting features

This chapter discusses some of the typesetting features of SDoP. The lack of some of these facilities in other processors was one of the reasons for writing SDoP.

### Vertical white space

Additional vertical white space can be obtained by inserting a paragraph containing just a single ‘hard space’ character (U+00A0). A smaller amount of vertical space can be obtained by inserting a paragraph containing just a single ‘zero-width space’ character (U+200B). SDoP treats this case specially, removing the line containing the space so that only the pre- and post-paragraph spaces remain.

### Indentation for literal blocks

SDoP automatically indents literal blocks within indented items. For example, paragraphs in a list are indented; if a `<literallayout>` block is part of a list item, SDoP indents it by the list item’s indent, in addition to any indent for the literal block itself.

Some other DocBook processors do not do this. They always set literal blocks with reference to the lefthand edge of the page. Consequently, input that was created for such other processors may contain extra indents for literal blocks that are not needed when it is processed by SDoP. To avoid excessive indentation, SDoP automatically removes an indent that is common to every line in a literal block. This feature can be turned off by setting the global processing parameter literal_indent_fudge to `no` (☞ ).

### Pagination

SDoP never outputs a section title as the last line on a page (chapter titles are always at the head of a page). A table that contains just a single row is treated as a sort of heading and is also not printed at the end of a page. SDoP generally avoids printing just one line of a multi-line paragraph as either the first or last line of a page (such lines are known as ‘widow’ and ‘orphan’ lines, respectively).

### Line splitting and hyphenation

Some other applications do overly-aggressive hyphenation. If a word that does not fit into a line can be hyphenated, they always split it. This leads to far too much hyphenation. SDoP attempts hyphenation only when the line is very ‘loose’ – that is, the ratio of space to text in the line is high, which would make it look ugly if no more text were added.

When it encounters a very loose line, SDoP first looks for explicit hyphens within the next word. If any are found, it tries to split the word at one of them. If this fails (because the shortest initial part of the word still makes the line overflow), no hyphenation occurs. There are four explicit hyphen characters:

- A ‘hard’ hyphen is the normal hyphen character (U+002D). It is output whether or not the word is split immediately after it.

- The ‘soft’ hyphen character (U+00AD) indicates a potential hyphenation point, but is output only if the word is actually split at that point. It is omitted when there is no split.

- The ‘zero width space’ character (U+200B) also indicates a potential hyphenation point. Unlike the soft hyphen, however, nothing is inserted if the word is split at that point. It is useful, for example, for allowing technical ‘words’ containing underscores to be split after the underscore without any insertion. When the spaces in a line are stretched to justify a line, zero width spaces are not affected. However, a zero width space does prevent kerning between the preceding and following characters.

- The Unicode character called BPH (‘break permitted here’) is treated in exactly the same way as a zero width space, except that, when the word is not split, it does not prevent kerning between the preceding and following characters.

If no explicit hyphens are found, SDoP tries automatic hyphenation. SDoP does not automatically hyphenate the last word in a paragraph, or any word that contains capital letters. If you need to hyphenate such a word (for example, a long word at the start of a sentence), you must insert one or more soft hyphen characters.

Both forms of hyphenation can be disabled by a processing instruction (☞ ). This is a local processing instruction, so hyphenation can be turned on and off as often as you like throughout the document. SDoP uses a dictionary for automatic hyphenation (☞ ).

It is also possible to disable automatic hyphenation at specific points in individual words by including the ‘no break here’ character (NBH, U+0083). For example, the word ‘elec-tri-fi-cation’ has three automatic hyphenation points, as shown. If you input it as `elec&#x83;trification`, the first of them is disabled. The inclusion of NBH does not prevent kerning between the previous and following characters.

### Fine adjustments to lines

Once it has formatted a paragraph, SDoP does a second pass over the lines to look for instances where a very tight, but not hyphenated, line is followed by a very loose line. If it finds such a pair of lines, it checks to see whether it is possible to move the last word from the first line onto the second line without making the first line unacceptably loose. This is a rare occurrence, but when it works it can make the paragraph look a lot nicer.

### Ligatures

SDoP automatically uses the single character ‘fi’ (U+FB01) whenever the letter ‘f’ is followed by the letter ‘i’ and the font is not monospaced and does contain the ligature character.

### Kerning

SDoP uses the kerning information in a font’s AFM file to move certain pairs of characters closer together or further apart, in order to improve the appearance of the text. There is a local processing setting that can suppress this for all or part of a document (☞ ). Kerning between two individual characters can be suppressed by inserting a zero width space between them. The ‘break permitted here’ and ‘no break here’ characters do not suppress kerning.

### The <emphasis> element

The `<emphasis>` element with no attributes specifies italic; the attribute `role="bold"` specifies a boldface font. Also supported is `role="roman"`, which can be useful for overriding a bold or italic font caused by an element such as `<varname>`.

The `role` attribute can also be used to specify special fonts or coloured text. In the template for the title page (the data file `titletemplate`) the form `role="booktitle` n`"`, where n is a number between 1 and 4, can appear. This selects one of four different sizes of title font.

### Using a small font

A normal font, but at a smaller that normal size, can be specified by:

    <emphasis role="smallfont">

The actual size of font can be set by the font_small_main processing parameter.

### Using exotic fonts

In the main text, the `role` attribute can be used to specify the use of a special font. The format for this is:

    <emphasis role="exotic-font-name/size/leading">

The leading (‘ledding’, not ‘leeding’) is a minimum amount of extra vertical white space that is inserted above each line that contains characters from this font. (The default font size is 11 points, with 1 point of leading.)

If the size and leading are omitted, the values from the current font are used. The size can be given as zero to mean ‘the current size’ if just additional leading is needed. Fonts with standard encoding are re-encoded as Unicode; for others, only characters in the range 0–255 are supported, in their native encoding. For example, to include a treble clef at a 9-point size from the musical font that is part of Philip’s Music Writer, you could use:

    <emphasis role="PMW-Music/9">!</emphasis>

The treble clef is encoded as character 33 (an exclamation mark in Unicode) in the PMW-Music font. If you use a special font in this way, you must ensure that its AFM file is available in the `fontmetrics` subdirectory of a directory that you pass to SDoP via the `-S` command line option or `SDOP_SHARE` environment variable.

### Specifying coloured text

You can specify that text is to be coloured like this:

    <emphasis role="rgb=r,g,b">...</emphasis>

The colour is defined by the three red-green-blue values, in the range 0 to 1. For example:

    This is a <emphasis role="rgb=1,0,0">red</emphasis> word.

The colour of text that forms a cross-reference or an index page number that is turned into a clickable link when the output is converted to a PDF can be separately specified by setting the xref_rgb parameter. This overrides any `<emphasis>` setting.

### Change bars

SDoP supports the `revisionflag` option on elements, but the only value that is recognized is ‘changed’. The effect is to print a vertical change bar at the right hand side of the affected text.

### Itemized lists

If no `mark` option is present on an `<itemizedlist>` element, SDoP uses a bullet (U+00B7) for top level lists, a dash (U+2212) for the first nested level, and a small circle (the letter ‘o’) for the next level. SDoP recognizes the words `bullet`, `dash`, and `opencircle` as values for `mark`. You can also give a Unicode code point, for example, `U+261E`. The font style for the mark can be set via the ilist_tag_style parameter, or the entire font (size, type, style) can be set via the font_ilist_tag parameter.

### Ordered lists

The olist_format parameter controls what is printed when numbering an ordered list. It specifies a text string that contains `%s` at the point where the item number is to be inserted. The default value is `(%s)`. The format of the item number itself (roman, arabic, alphabetic) is controlled by the `numeration` attribute of the `<orderedlist>` element. The font style for the whole string (default roman) can be specified by the olist_tag_style parameter, or the entire font (size, type, style) can be set via the font_olist_tag parameter.

### Tables

Space is left at the beginning and end of the entries in each column of a table. This reduces the column widths as specified in the XML. Vertical space is left between rows, above the top of the frame, and below the bottom of the frame (in cases where a top and bottom frame line is drawn). The thickness of the frame is in principle variable, but none of these values are yet adjustable (though they may be in a later release):

| Left entry space | 5pt
| Right entry space | 5pt
| Row separation space | 5pt
| Top frame space | 0pt
| Bottom frame space | 4pt
| Frame thickness | 0.5pt

Tables are by default set flush left on the page, but they can be indented by setting the table_indent processing parameter. There are a number of other processing parameters that can be used to control the way table titles are handled (☞ ). A further parameter can be used to alter the way SDoP diagnoses table cells that overflow. Setting:

    <?sdop table_warn_overflow="never"?>

suppresses all cell overflow warnings, whereas setting:

    <?sdop table_warn_overflow="overprint"?>

suppresses cell overflow warnings in two circumstances when there is no actual text collision, provided that no separator is being printed between the relevant columns:

1. The overflowing cell is not the last on the line, is left justified, and the next cell is not left justified.

2. The overflowing cell is not the first on the line, is right justified, and the previous cell is not right justified.

Both of these settings affect only what follows them; they can be changed as often as you like during the course of a document.

There is support for aligning cells by reference to a specific character (for example, to align monetary values on the decimal point). This takes the form of support for `align="char"` and the `char` and `charoff` attributes of the `<tgroup>`, `<colspec>`, and `<entry>` elements. The default values for `char` and `charoff` are `"."` and `"50"`, respectively. The value of `char` can be an entity name. If the aligning character is not found in a cell’s text, SDoP behaves as if it were present at the end of the string. If character alignment would cause overflow or underflow, an error is generated and right or left alignment (respectively) is used instead.

### Footnotes

Up to nine footnotes per page are fully supported, keyed by the numbers 1–9. If there are more than nine footnotes on a page, the lines containing footnote references greater than nine may be poorly spaced. A warning message is output. This is another example of the ‘simple’ approach that SDoP takes. Footnote numbering is a chicken-and-egg problem. Paragraphs have to be formatted before they can be assigned to pages. SDoP assumes that a footnote reference will be a single digit. Only after the page breaks are determined can the footnotes be numbered, and an extra digit alters the length of the line. If the line is justified and the extra digit can be accommodated by reducing the stretch for each space, all is well, but this cannot be guaranteed. If a `<footnote>` element is at the start of an input line, the newline character at the end of the previous line is ignored, so that the footnote key is hard up against the preceding word.

### Illustrations and figures

The `<textobject>` and `<imageobject>` elements within a `<mediaobject>` element are supported. For images, the `<imagedata>` element supports only the `fileref` attribute for the source of the image data and the `format` attribute to specify a format. If no format is given, the file name extension is used. The only formats currently recognized are EPS for encapsulated PostScript, JPEG or JPG for a JPEG image (if JPEG support is available), and PNG for a PNG image (if PNG support is available).

SDoP recognizes the `align`, `depth`, `width`, `scale`, and `scalefit` attributes on an `<imagedata>` element. If either of the width and depth are not given, they are taken from the bounding box data of the image, if available. If an explicit depth is greater than the bounding box depth, the image is vertically centred in the given depth.

If `scalefit` is set to 1, the image is scaled to fit the explicit width, if given, otherwise to the explicit depth, if given, otherwise to the page width.

Occasionally, an image may not appear exactly where you want it; this can happen if the bounding box values in the data are not quite right. A facility for adjusting the position of an image is therefore provided. If the `<imageobject>` element has a `role` attribute that consists of one or two dimensions, comma separated, they are used to ajust the position of the image. The values may be negative. The first dimension moves the image right or left, and the second, if present, up or down.

There is support for the `<figure>` element, and there are a number of processing parameters that can be used to control the format and alignment of figure titles (☞ ). However, figures are always set inline; there is no support for floating figures.

### Subscripts and superscripts

Subscripts and superscripts are supported. By default, in body text, they are printed in a small font, and are lowered or raised by 33% of the line depth, respectively. In titles, they are raised or lowered, but the font is unchanged. There are local processing parameters that can be used to adjust the amount of raising or lowering, and to disable the use of a small font in body text ((☞ ).

### Indexes

A document may contain multiple indexes, interspersed with chapters and appendices if required. The entries for a particular index are identified by the use of the `role` option on `<indexterm>` and `<index>` elements. Unlike some other DocBook processors, SDoP respects font-changing elements such as `<emphasis>` and `<filename>` in index entries. It is possible to alter the order in which index elements sort by overriding the default collation file (☞ ).

When comparing index items, both for sorting, and so that it can amalgamate multiple page numbers into a single entry, SDoP requires not only that the text be identical, but also that the same font (at the same size) is used, and also that the colour and any sub- or superscripting is the same.

Indexes are printed in two columns, using slightly smaller fonts than the body of the document by default. An index is omitted if there are no relevant entries. If there are at least two different leading characters in the index entries, headings are inserted before those that start with a symbol, those that start with a digit, and those that start with each individual letter. If all the entries start with the same character, no heading is inserted (this might be the case in an index of variables, for example, where they all start with `$`). Headings can be manually disabled by setting the processing parameter index_headings to `no`. Index headings never appear in the printed table of contents, but they can be requested for the PDF table of contents by setting index_headings_pdf_toc.

By default, the page numbers in indexes are identified in the PostScript output such that they are turned into clickable links if it is converted to a PDF. This can be disabled by setting xref_links to `no`.

Apart from the index sorting order, which is controlled by one of SDoP’s data files (☞ ), and the list of characters that are ignored when sorting (set by the index_sort_omit parameter), no other characteristics of indexes are at present configurable.

## Making Slides

As well as generating PostScript for printed page images, SDoP can be used to generate PostScript that, when converted to a PDF, can be used for slideshows. To do this you need to adjust some of the processing parameters. The following is an example:

    <?sdop background_rgb="0.8,0.8,1.0"
           page_foot_line_width="840"
           page_full_length="620"
           page_line_width="810"
           paper_size="900x660"
           font_main="26"
           font_mainmono="24"
           font_chapter="32"
           font_toc="18,1,serif"
           foot_centre_recto=""
           foot_centre_verso=""
           foot_right_recto="&arabicpage;"
           foot_right_verso="&arabicpage;"
           ilist_indent="24,24,0"
           margin_bottom="20"
           margin_left_recto="45"
           margin_left_verso="45"
           numbertitles="no"
           toc_sections="no"
    ?>

This sets up a pale background, adjusts sizes and widths, and arranges that slide (page) numbers are in the bottom lefthand corner. Each slide can then be defined as a ‘chapter’.

## Supported DocBook elements

The named entities and Unicode characters that SDoP supports are listed in the following two chapters. As well as elements and entities, SDoP recognizes these special XML constructs:

| `<!...!>` | XML heading: ignored
| `<!--...-->` | XML comment: ignored
| `<![CDATA[...]]>` | Literal character data

The following table lists the DocBook elements that are supported, in whole or in part, by SDoP. In some cases, though the element is recognized, it causes no change of processing. Examples of elements of this type are `<abbrev>`, `<acronym>`, and `<trademark>`. Elements that are defined for Simplified DocBook are marked with a dagger.

|  | Element*‘ ’*Comment
| † | `abbrev` | Ignored
| † | `abstract` | Ignored
| † | `acronym` | Ignored
|  | `address`
| † | `affiliation`
| † | `appendix` | Supports `id`
| † | `article`
| † | `articleinfo`
| † | `attribution`
| † | `audiodata` | Ignored
| † | `audioobject` | Ignored
| † | `author`
| † | `authorblurb` | Ignored
| † | `authorinitials`
| † | `blockquote`
|  | `book`
|  | `bookinfo`
| † | `caption`
|  | `chapter` | Supports `id`
| † | `citetitle` | Treated as `<emphasis>`
|  | `colophon`
| † | `colspec` | Supports `align`, `char`, `charoff`, `colwidth`, `colsep`
| † | `command`
| † | `computeroutput` | Treated as `<literal>`
| † | `copyright` | Supported in `<articleinfo>` and `<bookinfo>`
| † | `corpauthor`
| † | `date`
| † | `edition`
| † | `editor`
| † | `email` | Italic by default
| † | `emphasis` | Supports `role`
| † | `entry` | Supports `align`, `char`, `charoff`
| † | `epigraph` | Works like `<blockquote>`
| † | `example` | Supports `id`
| † | `figure` | Supports `id`
| † | `filename`
| † | `firstname`
| † | `footnote`
| † | `footnoteref` | Only on same page as the footnote
|  | `formalpara`
|  | `function`
| † | `holder`
| † | `honorific`
| † | `imagedata` | Supports `align`, `depth`, `fileref`, `format`, `scale`, `scalefit`, `width`
| † | `imageobject`
|  | `index` | Supports `role`
|  | `indexterm` | Supports `class`, `id`, `role`
|  | `informalfigure`
| † | `informaltable` | Supports `frame`, `colsep`, `rowsep`
| † | `inlinemediaobject` | Treated as `<mediaobject>`
| † | `issuenum`
| † | `itemizedlist` | Supports `mark`
| † | `jobtitle`
| † | `keyword` | Ignored
| † | `keywordset` | Ignored
| † | `legalnotice`
| † | `lineage`
| † | `lineannotation` | Uses a small italic font
| † | `link` | Ignored
| † | `listitem`
| † | `literal`
| † | `literallayout` | Supports `class`
| † | `mediaobject`
| † | `note` | Works like `<blockquote>`
| † | `objectinfo` | Ignored
| † | `option`
| † | `orderedlist` | Supports `numeration`
| † | `orgname`
| † | `othercredit`
| † | `othername`
| † | `para`
| † | `phrase`
|  | `preface`
|  | `primary`
| † | `programlisting` | Treated as `<screen>`
| † | `pubdate`
| † | `publishername`
| † | `quote`
| † | `releaseinfo`
| † | `replaceable` | Italic by default
| † | `revdescription`
| † | `revhistory`
| † | `revision`
| † | `revnumber`
| † | `revremark` | Ignored
| † | `row` | Supports `rowsep`
|  | `screen`
|  | `secondary`
| † | `section` | Supports `id`
| † | `sectioninfo` | Ignored
|  | `sect` n | Treated as `<section>`
|  | `see`
|  | `seealso`
| † | `sidebar` | Works like `<blockquote>`
|  | `simpara`
| † | `subject` | Ignored
| † | `subjectset` | Ignored
| † | `subjectterm` | Ignored
|  | `subscript` | No small font in titles; ignored in table of contents
| † | `subtitle` | For articles, chapters, appendixes, and indexes
|  | `superscript` | No small font in titles; ignored in table of contents
| † | `surname`
| † | `systemitem` | Ignored
| † | `table` | Supports `frame`, `colsep`, `rowsep`
| † | `tbody`
| † | `term`
|  | `tertiary`
| † | `textobject`
| † | `tfoot`
| † | `tgroup` | Supports `align`, `char`, `charoff`, `cols`, `colsep`, `rowsep`
| † | `thead`
| † | `title`
| † | `titleabbrev`
| † | `trademark` | Ignored
| † | `ulink` | Supports `url`
| † | `userinput` | Monospaced by default
| † | `variablelist`
| † | `varlistentry`
|  | `varname`
| † | `videodata` | Ignored
| † | `videoobject` | Ignored
| † | `volumenum`
| † | `xref` | Supports `linkend`
| † | `year`

In an `<article>` element, `<id>` and `<class>` attributes are recognized, but ignored.

The Simplified DocBook elements that are not supported are `<authorgroup>`, `<biblio` xxx`>`, `<entrytbl>`, and `<spanspec>`.

## Supported DocBook entities

Individual data characters can always be specified by their numerical code points using the entity notation `&#`n`;` (where n is a decimal number) or `&#x` n`;` (where n is a hexadecimal number). The latter form is more common because Unicode code points are normally listed in hexadecimal. For example, a copyright symbol can be specified as `&#xA9;`. SDoP also recognizes a number of named entities that represent special characters. They are shown in the table below. Additional special entity names are recognized in header, footer, title page, and table of contents templates (☞ , , ).

| Name | Code point | Character
| `&AElig;` | `U+00C6` | Æ
| `&Aacute;` | `U+00C1` | Á
| `&Abreve;` | `U+0102` | &Abreve;
| `&Acirc;` | `U+00C2` | Â
| `&Agrave;` | `U+00C0` | À
| `&Amacr;` | `U+0100` | &Amacr;
| `&Aogon;` | `U+0104` | &Aogon;
| `&Aring;` | `U+00C5` | Å
| `&Atilde;` | `U+00C3` | Ã
| `&Auml;` | `U+00C4` | Ä
| `&Cacute;` | `U+0106` | &Cacute;
| `&Ccaron;` | `U+010C` | &Ccaron;
| `&Ccedil;` | `U+00C7` | Ç
| `&Ccirc;` | `U+0108` | &Ccirc;
| `&Cdot;` | `U+010A` | &Cdot;
| `&Dagger;` | `U+2021` | ‡
| `&Dcaron;` | `U+010E` | &Dcaron;
| `&Dstrok;` | `U+0110` | &Dstrok;
| `&ENG;` | `U+014A` | &ENG;
| `&ETH;` | `U+00D0` | Ð
| `&Eacute;` | `U+00C9` | É
| `&Ecaron;` | `U+011A` | &Ecaron;
| `&Ecirc;` | `U+00CA` | Ê
| `&Edot;` | `U+0116` | &Edot;
| `&Egrave;` | `U+00C8` | È
| `&Emacr;` | `U+0112` | &Emacr;
| `&Eogon;` | `U+0118` | &Eogon;
| `&Euml;` | `U+00CB` | Ë
| `&Euro;` | `U+20AC` | &Euro;
| `&Gbreve;` | `U+011E` | &Gbreve;
| `&Gcedil;` | `U+0122` | &Gcedil;
| `&Gcirc;` | `U+011C` | &Gcirc;
| `&Gdot;` | `U+0120` | &Gdot;
| `&Hcirc;` | `U+0124` | &Hcirc;
| `&Hstrok;` | `U+0126` | &Hstrok;
| `&IJlig;` | `U+0132` | &IJlig;
| `&Iacute;` | `U+00CD` | Í
| `&Icirc;` | `U+00CE` | Î
| `&Idot;` | `U+0130` | &Idot;
| `&Igrave;` | `U+00CC` | Ì
| `&Imacr;` | `U+012A` | &Imacr;
| `&Iogon;` | `U+012E` | &Iogon;
| `&Itilde;` | `U+0128` | &Itilde;
| `&Iuml;` | `U+00CF` | Ï
| `&Jcirc;` | `U+0134` | &Jcirc;
| `&Kcedil;` | `U+0136` | &Kcedil;
| `&Lacute;` | `U+0139` | &Lacute;
| `&Lcaron;` | `U+013D` | &Lcaron;
| `&Lcedil;` | `U+013B` | &Lcedil;
| `&Lmidot;` | `U+013F` | &Lmidot;
| `&Lstrok;` | `U+0141` | &Lstrok;
| `&Nacute;` | `U+0143` | &Nacute;
| `&Ncaron;` | `U+0147` | &Ncaron;
| `&Ncedil;` | `U+0145` | &Ncedil;
| `&Ntilde;` | `U+00D1` | Ñ
| `&OElig;` | `U+0152` | Œ
| `&Oacute;` | `U+00D3` | Ó
| `&Ocirc;` | `U+00D4` | Ô
| `&Odblac;` | `U+0150` | &Odblac;
| `&Ograve;` | `U+00D2` | Ò
| `&Omacr;` | `U+014C` | &Omacr;
| `&Oslash;` | `U+00D8` | Ø
| `&Otilde;` | `U+00D5` | Õ
| `&Ouml;` | `U+00D6` | Ö
| `&Racute;` | `U+0154` | &Racute;
| `&Rcaron;` | `U+0158` | &Rcaron;
| `&Rcedil;` | `U+0156` | &Rcedil;
| `&Sacute;` | `U+015A` | &Sacute;
| `&Scaron;` | `U+0160` | Š
| `&Scedil;` | `U+015E` | &Scedil;
| `&Scirc;` | `U+015C` | &Scirc;
| `&THORN;` | `U+00DE` | Þ
| `&Tcaron;` | `U+0164` | &Tcaron;
| `&Tcedil;` | `U+0162` | &Tcedil;
| `&Tstrok;` | `U+0166` | &Tstrok;
| `&Uacute;` | `U+00DA` | Ú
| `&Ubreve;` | `U+016C` | &Ubreve;
| `&Ucirc;` | `U+00DB` | Û
| `&Udblac;` | `U+0170` | &Udblac;
| `&Ugrave;` | `U+00D9` | Ù
| `&Umacr;` | `U+016A` | &Umacr;
| `&Uogon;` | `U+0172` | &Uogon;
| `&Uring;` | `U+016E` | &Uring;
| `&Utilde;` | `U+0168` | &Utilde;
| `&Uuml;` | `U+00DC` | Ü
| `&Wcirc;` | `U+0174` | &Wcirc;
| `&Yacute;` | `U+00DD` | Ý
| `&Ycirc;` | `U+0176` | &Ycirc;
| `&Yuml;` | `U+0178` | Ÿ
| `&Zacute;` | `U+0179` | &Zacute;
| `&Zcaron;` | `U+017D` | &Zcaron;
| `&Zdot;` | `U+017B` | &Zdot;
| `&aacute;` | `U+00E1` | á
| `&abreve;` | `U+0103` | &abreve;
| `&acirc;` | `U+00E2` | â
| `&aelig;` | `U+00E6` | æ
| `&agrave;` | `U+00E0` | à
| `&amacr;` | `U+0101` | &amacr;
| `&amp;` | `U+0026` | &
| `&aogon;` | `U+0105` | &aogon;
| `&apos;` | `U+0027` | '
| `&aring;` | `U+00E5` | å
| `&atilde;` | `U+00E3` | ã
| `&auml;` | `U+00E4` | ä
| `&brvbar;` | `U+00A6` | ¦
| `&cacute;` | `U+0107` | &cacute;
| `&ccaron;` | `U+010D` | &ccaron;
| `&ccedil;` | `U+00E7` | ç
| `&ccirc;` | `U+0109` | &ccirc;
| `&cdot;` | `U+0A0B` | &cdot;
| `&cent;` | `U+00A2` | ¢
| `&check;` | `U+2713` | &check;
| `&clubs;` | `U+2663` | ♣
| `&copy;` | `U+00A9` | ©
| `&cross;` | `U+2717` | &cross;
| `&curren;` | `U+00A4` | ¤
| `&dagger;` | `U+2020` | †
| `&darr;` | `U+2193` | ↓
| `&dcaron;` | `U+010F` | &dcaron;
| `&deg;` | `U+00B0` | °
| `&diams;` | `U+2666` | ♦
| `&divide;` | `U+00F7` | ÷
| `&dstrok;` | `U+0111` | &dstrok;
| `&eacute;` | `U+00E9` | é
| `&ecaron;` | `U+011B` | &ecaron;
| `&ecirc;` | `U+00EA` | ê
| `&edot;` | `U+0117` | &edot;
| `&egrave;` | `U+00E8` | è
| `&emacr;` | `U+0113` | &emacr;
| `&eng;` | `U+014B` | &eng;
| `&eogon;` | `U+0119` | &eogon;
| `&eth;` | `U+00F0` | ð
| `&euml;` | `U+00EB` | ë
| `&filig;` | `U+FB01` | &filig;
| `&fllig;` | `U+FB02` | &fllig;
| `&frac12;` | `U+00BD` | ½
| `&frac14;` | `U+00BC` | ¼
| `&frac34;` | `U+00BE` | ¾
| `&gbreve;` | `U+011F` | &gbreve;
| `&gcirc;` | `U+011D` | &gcirc;
| `&gdot;` | `U+0121` | &gdot;
| `&gt;` | `U+003E` | >
| `&half;` | `U+00BD` | &half;
| `&hcirc;` | `U+0125` | &hcirc;
| `&hearts;` | `U+2665` | ♥
| `&hellip;` | `U+2026` | …
| `&hstrok;` | `U+0127` | &hstrok;
| `&iacute;` | `U+00ED` | í
| `&icirc;` | `U+00EE` | î
| `&iexcl;` | `U+00A1` | ¡
| `&igrave;` | `U+00EC` | ì
| `&ijlig;` | `U+0133` | &ijlig;
| `&imacr;` | `U+012B` | &imacr;
| `&inodot;` | `U+0131` | &inodot;
| `&iogon;` | `U+012F` | &iogon;
| `&iquest;` | `U+00BF` | ¿
| `&itilde;` | `U+0129` | &itilde;
| `&iuml;` | `U+00EF` | ï
| `&jcirc;` | `U+0135` | &jcirc;
| `&kcedil;` | `U+0137` | &kcedil;
| `&kgreen;` | `U+0138` | &kgreen;
| `&lacute;` | `U+013A` | &lacute;
| `&laquo;` | `U+00AB` | «
| `&larr;` | `U+2190` | ←
| `&lcaron;` | `U+013E` | &lcaron;
| `&lcedil;` | `U+013C` | &lcedil;
| `&ldquo;` | `U+201C` | “
| `&ldquor;` | `U+201E` | &ldquor;
| `&lmidot;` | `U+0140` | &lmidot;
| `&loz;` | `U+25CA` | ◊
| `&lsquo;` | `U+2018` | ‘
| `&lsquor;` | `U+201A` | &lsquor;
| `&lstrok;` | `U+0142` | &lstrok;
| `&lt;` | `U+003C` | <
| `&malt;` | `U+2720` | &malt;
| `&mdash;` | `U+2014` | —
| `&micro;` | `U+00B5` | µ
| `&middot;` | `U+00B7` | ·
| `&mldr;` | `U+2026` | &mldr;
| `&nacute;` | `U+0144` | &nacute;
| `&napos;` | `U+0149` | &napos;
| `&nbsp;` | `U+00A0` | hard space
| `&ncaron;` | `U+0148` | &ncaron;
| `&ncedil;` | `U+0146` | &ncedil;
| `&ndash;` | `U+2013` | –
| `&not;` | `U+00AC` | ¬
| `&ntilde;` | `U+00F1` | ñ
| `&oacute;` | `U+00F3` | ó
| `&ocirc;` | `U+00F4` | ô
| `&odblac;` | `U+0151` | &odblac;
| `&oelig;` | `U+0153` | œ
| `&ograve;` | `U+00F2` | ò
| `&omacr;` | `U+014D` | &omacr;
| `&ordf;` | `U+00AA` | ª
| `&ordm;` | `U+00BA` | º
| `&oslash;` | `U+00F8` | ø
| `&otilde;` | `U+00F5` | õ
| `&ouml;` | `U+00F6` | ö
| `&para;` | `U+00B6` | ¶
| `&phone;` | `U+260E` | &phone;
| `&plusmn;` | `U+00B1` | ±
| `&pound;` | `U+00A3` | £
| `&quot;` | `U+0022` | "
| `&racute;` | `U+0155` | &racute;
| `&raquo;` | `U+00BB` | »
| `&rarr;` | `U+2192` | →
| `&rcaron;` | `U+0159` | &rcaron;
| `&rcedil;` | `U+0157` | &rcedil;
| `&rdquo;` | `U+201D` | ”
| `&rdquor;` | `U+201D` | &rdquor; | (same as `&rdquo;`)
| `&reg;` | `U+00AE` | ®
| `&rsquo;` | `U+2019` | ’
| `&rsquor;` | `U+2019` | &rsquor; | (same as `&rsquo;`)
| `&sacute;` | `U+015B` | &sacute;
| `&scaron;` | `U+0161` | š
| `&scedil;` | `U+015F` | &scedil;
| `&scirc;` | `U+015D` | &scirc;
| `&sect;` | `U+00A7` | §
| `&sext;` | `U+2736` | &sext;
| `&shy;` | `U+00AD` |
| `&spades;` | `U+2660` | ♠
| `&sup1;` | `U+00B9` | ¹
| `&sup2;` | `U+00B2` | ²
| `&sup3;` | `U+00B3` | ³
| `&szlig;` | `U+00DF` | ß
| `&tcaron;` | `U+0165` | &tcaron;
| `&tcedil;` | `U+0163` | &tcedil;
| `&thorn;` | `U+00FE` | þ
| `&times;` | `U+00D7` | ×
| `&trade;` | `U+2122` | ™
| `&tstrok;` | `U+0167` | &tstrok;
| `&uacute;` | `U+00FA` | ú
| `&uarr;` | `U+2191` | ↑
| `&ubreve;` | `U+016D` | &ubreve;
| `&ucirc;` | `U+00FB` | û
| `&udblac;` | `U+0171` | &udblac;
| `&ugrave;` | `U+00F9` | ù
| `&umacr;` | `U+016B` | &umacr;
| `&uogon;` | `U+0173` | &uogon;
| `&uring;` | `U+016F` | &uring;
| `&utilde;` | `U+0169` | &utilde;
| `&uuml;` | `U+00FC` | ü
| `&wcirc;` | `U+0175` | &wcirc;
| `&yacute;` | `U+00FD` | ý
| `&ycirc;` | `U+0177` | &ycirc;
| `&yen;` | `U+00A5` | ¥
| `&yuml;` | `U+00FF` | ÿ
| `&zacute;` | `U+017A` | &zacute;
| `&zcaron;` | `U+017E` | &zcaron;
| `&zdot;` | `U+017C` | &zdot;

## Supported Unicode characters

SDoP supports all the Unicode characters that are in the common Adobe PostScript fonts and their compatible equivalents, plus some additional characters from the Symbol and ZapfDingbats fonts. You do not have to specify anything to cause SDoP to use the special fonts; they are used automatically for characters that are not in the ordinary fonts. When it encounters a character for which it does not have a PostScript equivalent, SDoP prints the rarely-used ‘currency symbol’ ¤.

All printing characters in the C0 Controls and Basic Latin code page (U+0020–U+007E, corresponding to ASCII) and in the C1 Controls and Latin-1 Supplement code page (U+00A0–U+00FF, corresponding to ISO 8859-1) are supported, including ‘hard space’ (U+00A0), ‘soft hyphen’ (U+00AD), ‘break permitted here’ (U+0082), and ‘no break here’ (U+0083). SDop also supports ‘zero width space’ (U+200B).

All characters in the Latin Extended-A page (U+0100–U+017F) are also supported. However, some of them are not in the original Adobe PostScript fonts, but are present in later versions and in compatible equivalent fonts. Nothing is printed for these characters in fonts that lack them:

| `U+0108` | C with circumflex | `U+013F` | L with middle dot
| `U+0109` | c with circumflex | `U+0140` | l with middle dot
| `U+010A` | C with dot above | `U+0149` | n with leading apostrophe
| `U+010B` | c with dot above | `U+014A` | capital eng (N with hook)
| `U+0114` | E with breve | `U+014B` | lower case eng (n with hook)
| `U+0115` | e with breve | `U+014E` | O with breve
| `U+011c` | G with circumflex | `U+014F` | o with breve
| `U+011d` | g with circumflex | `U+015C` | S with circumflex
| `U+0120` | G with dot above | `U+015D` | s with circumflex
| `U+0121` | g with dot above | `U+0162` | T with cedilla
| `U+0124` | H with circumflex | `U+0163` | t with cedilla
| `U+0125` | h with circumflex | `U+0166` | T with bar
| `U+0126` | H with bar | `U+0167` | t with bar
| `U+0127` | h with bar | `U+0168` | U with tilde
| `U+0128` | I with tilde | `U+0169` | u with tilde
| `U+0129` | i with tilde | `U+016C` | U with breve
| `U+012C` | I with breve | `U+016D` | u with breve
| `U+012D` | i with breve | `U+0174` | W with circumflex
| `U+0132` | IJ ligature | `U+0175` | w with circumflex
| `U+0133` | ij ligature | `U+0176` | Y with circumflex
| `U+0134` | J with circumflex | `U+0177` | y with circumflex
| `U+0135` | j with circumflex | `U+017F` | long s
| `U+0138` | small kra (Greenlandic)

The following tables show all the characters that are supported by SDoP. The first table shows those from the first three Unicode pages (U+0000–U+017F):

| `U+0020` | space | `U+00B4` | ´ | `U+00F9` | ù | `U+013E` | ľ
| `U+0021` | ! | `U+00B5` | µ | `U+00FA` | ú | `U+013F` | Ŀ
| `U+0022` | " | `U+00B6` | ¶ | `U+00FB` | û | `U+0140` | ŀ
| `U+0023` | # | `U+00B7` | · | `U+00FC` | ü | `U+0141` | Ł
| `U+0024` | $ | `U+00B8` | ¸ | `U+00FD` | ý | `U+0142` | ł
| `U+0025` | % | `U+00B9` | ¹ | `U+00FE` | þ | `U+0143` | Ń
| `U+0026` | & | `U+00BA` | º | `U+00FF` | ÿ | `U+0144` | ń
| `U+0027` | ' | `U+00BB` | » | `U+0100` | Ā | `U+0145` | Ņ
| `U+0028` | ( | `U+00BC` | ¼ | `U+0101` | ā | `U+0146` | ņ
| `U+0029` | ) | `U+00BD` | ½ | `U+0102` | Ă | `U+0147` | Ň
| `U+002A` | * | `U+00BE` | ¾ | `U+0103` | ă | `U+0148` | ň
| `U+002B` | + | `U+00BF` | ¿ | `U+0104` | Ą | `U+0149` | ŉ
| `U+002C` | , | `U+00C0` | À | `U+0105` | ą | `U+014A` | Ŋ
| `U+002D` | - | `U+00C1` | Á | `U+0106` | Ć | `U+014B` | ŋ
| `U+002E` | . | `U+00C2` | Â | `U+0107` | ć | `U+014C` | Ō
| `U+002F` | / | `U+00C3` | Ã | `U+0108` | Ĉ | `U+014D` | ō
| `U+0030` | 0 | `U+00C4` | Ä | `U+0109` | ĉ | `U+014E` | Ŏ
| `U+0031` | 1 | `U+00C5` | Å | `U+010A` | Ċ | `U+014F` | ŏ
| `U+0032` | 2 | `U+00C6` | Æ | `U+010B` | ċ | `U+0150` | Ő
| `U+0033` | 3 | `U+00C7` | Ç | `U+010C` | Č | `U+0151` | ő
| `U+0034` | 4 | `U+00C8` | È | `U+010D` | č | `U+0152` | Œ
| `U+0035` | 5 | `U+00C9` | É | `U+010E` | Ď | `U+0153` | œ
| `U+0036` | 6 | `U+00CA` | Ê | `U+010F` | ď | `U+0154` | Ŕ
| `U+0037` | 7 | `U+00CB` | Ë | `U+0110` | Đ | `U+0155` | ŕ
| `U+0038` | 8 | `U+00CC` | Ì | `U+0111` | đ | `U+0156` | Ŗ
| `U+0039` | 9 | `U+00CD` | Í | `U+0112` | Ē | `U+0157` | ŗ
| `U+003A` | : | `U+00CE` | Î | `U+0113` | ē | `U+0158` | Ř
| `U+003B` | ; | `U+00CF` | Ï | `U+0114` | Ĕ | `U+0159` | ř
| `U+003C` | < | `U+00D0` | Ð | `U+0115` | ĕ | `U+015A` | Ś
| `U+003D` | = | `U+00D1` | Ñ | `U+0116` | Ė | `U+015B` | ś
| `U+003E` | > | `U+00D2` | Ò | `U+0117` | ė | `U+015C` | Ŝ
| `U+003F` | ? | `U+00D3` | Ó | `U+0118` | Ę | `U+015D` | ŝ
| `U+0040` | @ | `U+00D4` | Ô | `U+0119` | ę | `U+015E` | Ş
| `U+0041` | A | `U+00D5` | Õ | `U+011A` | Ě | `U+015F` | ş
|  | … | `U+00D6` | Ö | `U+011B` | ě | `U+0160` | Š
| `U+005A` | Z | `U+00D7` | × | `U+011C` | Ĝ | `U+0161` | š
| `U+005B` | [ | `U+00D8` | Ø | `U+011D` | ĝ | `U+0162` | Ţ
| `U+005C` | \ | `U+00D9` | Ù | `U+011E` | Ğ | `U+0163` | ţ
| `U+005D` | ] | `U+00DA` | Ú | `U+011F` | ğ | `U+0164` | Ť
| `U+005E` | ^ | `U+00DB` | Û | `U+0120` | Ġ | `U+0165` | ť
| `U+005F` | _ | `U+00DC` | Ü | `U+0121` | ġ | `U+0166` | Ŧ
| `U+0060` | ` | `U+00DD` | Ý | `U+0122` | Ģ | `U+0167` | ŧ
| `U+0061` | a | `U+00DE` | Þ | `U+0123` | ģ | `U+0168` | Ũ
|  | … | `U+00DF` | ß | `U+0124` | Ĥ | `U+0169` | ũ
| `U+007A` | z | `U+00E0` | à | `U+0125` | ĥ | `U+016A` | Ū
| `U+007B` | { | `U+00E1` | á | `U+0126` | Ħ | `U+016B` | ū
| `U+007C` | | | `U+00E2` | â | `U+0127` | ħ | `U+016C` | Ŭ
| `U+007D` | } | `U+00E3` | ã | `U+0128` | Ĩ | `U+016D` | ŭ
| `U+007E` | ~ | `U+00E4` | ä | `U+0129` | ĩ | `U+016E` | Ů
| `U+00A0` | space | `U+00E5` | å | `U+012A` | Ī | `U+016F` | ů
| `U+00A1` | ¡ | `U+00E6` | æ | `U+012B` | ī | `U+0170` | Ű
| `U+00A2` | ¢ | `U+00E7` | ç | `U+012C` | Ĭ | `U+0171` | ű
| `U+00A3` | £ | `U+00E8` | è | `U+012D` | ĭ | `U+0172` | Ų
| `U+00A4` | ¤ | `U+00E9` | é | `U+012E` | Į | `U+0173` | ų
| `U+00A5` | ¥ | `U+00EA` | ê | `U+012F` | į | `U+0174` | Ŵ
| `U+00A6` | ¦ | `U+00EB` | ë | `U+0130` | İ | `U+0175` | ŵ
| `U+00A7` | § | `U+00EC` | ì | `U+0131` | ı | `U+0176` | Ŷ
| `U+00A8` | ¨ | `U+00ED` | í | `U+0132` | Ĳ | `U+0177` | ŷ
| `U+00A9` | © | `U+00EE` | î | `U+0133` | ĳ | `U+0178` | Ÿ
| `U+00AA` | ª | `U+00EF` | ï | `U+0134` | Ĵ | `U+0179` | Ź
| `U+00AB` | « | `U+00F0` | ð | `U+0135` | ĵ | `U+017A` | ź
| `U+00AC` | ¬ | `U+00F1` | ñ | `U+0136` | Ķ | `U+017B` | Ż
| `U+00AD` |  | `U+00F2` | ò | `U+0137` | ķ | `U+017C` | ż
| `U+00AE` | ® | `U+00F3` | ó | `U+0138` | ĸ | `U+017D` | Ž
| `U+00AF` | ¯ | `U+00F4` | ô | `U+0139` | Ĺ | `U+017E` | ž
| `U+00B0` | ° | `U+00F5` | õ | `U+013A` | ĺ | `U+017F` | ſ
| `U+00B1` | ± | `U+00F6` | ö | `U+013B` | Ļ
| `U+00B2` | ² | `U+00F7` | ÷ | `U+013C` | ļ
| `U+00B3` | ³ | `U+00F8` | ø | `U+013D` | Ľ

The next table shows the other supported characters that are taken from the normal PostScript fonts if possible (some older fonts lack some of these characters). U+021A and U+021B are mapped to Tcommaaccent and tcommaaccent, whereas U+0162 and U+0163 are mapped to Tcedilla and tcedilla. Although Unicode specifies these as alternative glyphs, they look the same in many fonts.

| `U+0218` | Ș | `U+0328` | ̨ | `U+2020` | † | `U+2211` | ∑
| `U+0219` | ș | `U+0394` | Δ | `U+2021` | ‡ | `U+2212` | −
| `U+021A` | Ț | `U+2013` | – | `U+2026` | … | `U+221A` | √
| `U+021B` | ț | `U+2014` | — | `U+2027` | ‧ | `U+221E` | ∞
| `U+0302` | ̂ | `U+2018` | ‘ | `U+2031` | ‱ | `U+2260` | ≠
| `U+0303` | ̃ | `U+2019` | ’ | `U+2039` | ‹ | `U+2264` | ≤
| `U+0306` | ̆ | `U+201A` | ‚ | `U+203A` | › | `U+2265` | ≥
| `U+0307` | ̇ | `U+201C` | “ | `U+2044` | ⁄ | `U+25CA` | ◊
| `U+030B` | ̋ | `U+201D` | ” | `U+20AC` | € | `U+FB01` | ﬁ
| `U+0326` | ̦ | `U+201E` | „ | `U+2122` | ™ | `U+FB02` | ﬂ

The next table shows characters that are supported by using the Symbol font (in some cases, only if the normal font lacks them):

| `U+0391` | Α | `U+03BA` | κ | `U+21B5` | ↵ | `U+2283` | ⊃
| `U+0392` | Β | `U+03BB` | λ | `U+21D0` | ⇐ | `U+2284` | ⊄
| `U+0393` | Γ | `U+03BC` | μ | `U+21D1` | ⇑ | `U+2286` | ⊆
| `U+0394` | Δ | `U+03BD` | ν | `U+21D2` | ⇒ | `U+2287` | ⊇
| `U+0395` | Ε | `U+03BE` | ξ | `U+21D3` | ⇓ | `U+2295` | ⊕
| `U+0396` | Ζ | `U+03BF` | ο | `U+21D4` | ⇔ | `U+2297` | ⊗
| `U+0397` | Η | `U+03C0` | π | `U+2200` | ∀ | `U+22A5` | ⊥
| `U+0398` | Θ | `U+03C1` | ρ | `U+2202` | ∂ | `U+22C0` | ⋀
| `U+0399` | Ι | `U+03C2` | ς | `U+2203` | ∃ | `U+22C1` | ⋁
| `U+039A` | Κ | `U+03C3` | σ | `U+2205` | ∅ | `U+22C5` | ⋅
| `U+039B` | Λ | `U+03C4` | τ | `U+2207` | ∇ | `U+2320` | ⌠
| `U+039C` | Μ | `U+03C5` | υ | `U+2208` | ∈ | `U+2321` | ⌡
| `U+039D` | Ν | `U+03C6` | φ | `U+2209` | ∉ | `U+2329` | 〈
| `U+039E` | Ξ | `U+03C7` | χ | `U+220D` | ∍ | `U+232A` | 〉
| `U+039F` | Ο | `U+03C8` | ψ | `U+220F` | ∏ | `U+239B` | ⎛
| `U+03A0` | Π | `U+03C9` | ω | `U+2211` | ∑ | `U+239C` | ⎜
| `U+03A1` | Ρ | `U+03D1` | ϑ | `U+2215` | ∕ | `U+239D` | ⎝
| `U+03A3` | Σ | `U+03D2` | ϒ | `U+221A` | √ | `U+239E` | ⎞
| `U+03A4` | Τ | `U+03D5` | ϕ | `U+221D` | ∝ | `U+239F` | ⎟
| `U+03A5` | Υ | `U+03D6` | ϖ | `U+221E` | ∞ | `U+23A0` | ⎠
| `U+03A6` | Φ | `U+12AA` | ኪ | `U+2220` | ∠ | `U+23A1` | ⎡
| `U+03A7` | Χ | `U+2032` | ′ | `U+2229` | ∩ | `U+23A2` | ⎢
| `U+03A8` | Ψ | `U+2033` | ″ | `U+222A` | ∪ | `U+23A3` | ⎣
| `U+03A9` | Ω | `U+20AC` | € | `U+222B` | ∫ | `U+23A4` | ⎤
| `U+03B1` | α | `U+2111` | ℑ | `U+2234` | ∴ | `U+23A5` | ⎥
| `U+03B2` | β | `U+2118` | ℘ | `U+223C` | ∼ | `U+23A6` | ⎦
| `U+03B3` | γ | `U+211C` | ℜ | `U+2245` | ≅ | `U+23A7` | ⎧
| `U+03B4` | δ | `U+2135` | ℵ | `U+2248` | ≈ | `U+23A8` | ⎨
| `U+03B5` | ε | `U+2190` | ← | `U+2260` | ≠ | `U+23A9` | ⎩
| `U+03B6` | ζ | `U+2191` | ↑ | `U+2261` | ≡ | `U+23AB` | ⎫
| `U+03B7` | η | `U+2192` | → | `U+2264` | ≤ | `U+23AC` | ⎬
| `U+03B8` | θ | `U+2193` | ↓ | `U+2265` | ≥ | `U+23AD` | ⎭
| `U+03B9` | ι | `U+2194` | ↔ | `U+2282` | ⊂ | `U+23AE` | ⎮

The final table shows characters that are supported by using the ZapfDingbats font:

| `U+25A0` | ■ | `U+2722` | ✢ | `U+2751` | ❑ | `U+2791` | ➑
| `U+25B2` | ▲ | `U+2723` | ✣ | `U+2752` | ❒ | `U+2792` | ➒
| `U+25BC` | ▼ | `U+2724` | ✤ | `U+2756` | ❖ | `U+2793` | ➓
| `U+25C6` | ◆ | `U+2725` | ✥ | `U+2758` | ❘ | `U+2794` | ➔
| `U+25CA` | ◊ | `U+2726` | ✦ | `U+2759` | ❙ | `U+2798` | ➘
| `U+25D7` | ◗ | `U+2727` | ✧ | `U+275A` | ❚ | `U+2799` | ➙
| `U+260E` | ☎ | `U+2729` | ✩ | `U+275B` | ❛ | `U+279A` | ➚
| `U+261B` | ☛ | `U+272A` | ✪ | `U+275C` | ❜ | `U+279B` | ➛
| `U+261E` | ☞ | `U+272B` | ✫ | `U+275D` | ❝ | `U+279C` | ➜
| `U+2660` | ♠ | `U+272C` | ✬ | `U+275E` | ❞ | `U+279D` | ➝
| `U+2663` | ♣ | `U+272D` | ✭ | `U+2761` | ❡ | `U+279E` | ➞
| `U+2665` | ♥ | `U+272E` | ✮ | `U+2762` | ❢ | `U+279F` | ➟
| `U+2666` | ♦ | `U+272F` | ✯ | `U+2763` | ❣ | `U+27A0` | ➠
| `U+26AB` | ⚫ | `U+2730` | ✰ | `U+2764` | ❤ | `U+27A1` | ➡
| `U+2701` | ✁ | `U+2731` | ✱ | `U+2765` | ❥ | `U+27A2` | ➢
| `U+2702` | ✂ | `U+2732` | ✲ | `U+2766` | ❦ | `U+27A3` | ➣
| `U+2703` | ✃ | `U+2733` | ✳ | `U+2767` | ❧ | `U+27A4` | ➤
| `U+2704` | ✄ | `U+2734` | ✴ | `U+2776` | ❶ | `U+27A5` | ➥
| `U+2706` | ✆ | `U+2735` | ✵ | `U+2777` | ❷ | `U+27A6` | ➦
| `U+2707` | ✇ | `U+2736` | ✶ | `U+2778` | ❸ | `U+27A7` | ➧
| `U+2708` | ✈ | `U+2737` | ✷ | `U+2779` | ❹ | `U+27A8` | ➨
| `U+2709` | ✉ | `U+2738` | ✸ | `U+277A` | ❺ | `U+27A9` | ➩
| `U+270C` | ✌ | `U+2739` | ✹ | `U+277B` | ❻ | `U+27AA` | ➪
| `U+270D` | ✍ | `U+273A` | ✺ | `U+277C` | ❼ | `U+27AB` | ➫
| `U+270E` | ✎ | `U+273B` | ✻ | `U+277D` | ❽ | `U+27AC` | ➬
| `U+270F` | ✏ | `U+273C` | ✼ | `U+277E` | ❾ | `U+27AD` | ➭
| `U+2710` | ✐ | `U+273D` | ✽ | `U+277F` | ❿ | `U+27AE` | ➮
| `U+2711` | ✑ | `U+273E` | ✾ | `U+2780` | ➀ | `U+27AF` | ➯
| `U+2712` | ✒ | `U+273F` | ✿ | `U+2781` | ➁ | `U+27B1` | ➱
| `U+2713` | ✓ | `U+2740` | ❀ | `U+2782` | ➂ | `U+27B2` | ➲
| `U+2714` | ✔ | `U+2741` | ❁ | `U+2783` | ➃ | `U+27B3` | ➳
| `U+2715` | ✕ | `U+2742` | ❂ | `U+2784` | ➄ | `U+27B4` | ➴
| `U+2716` | ✖ | `U+2743` | ❃ | `U+2785` | ➅ | `U+27B5` | ➵
| `U+2717` | ✗ | `U+2744` | ❄ | `U+2786` | ➆ | `U+27B6` | ➶
| `U+2718` | ✘ | `U+2745` | ❅ | `U+2787` | ➇ | `U+27B7` | ➷
| `U+2719` | ✙ | `U+2746` | ❆ | `U+2788` | ➈ | `U+27B8` | ➸
| `U+271A` | ✚ | `U+2747` | ❇ | `U+2789` | ➉ | `U+27B9` | ➹
| `U+271B` | ✛ | `U+2748` | ❈ | `U+278A` | ➊ | `U+27BA` | ➺
| `U+271C` | ✜ | `U+2749` | ❉ | `U+278B` | ➋ | `U+27BB` | ➻
| `U+271D` | ✝ | `U+274A` | ❊ | `U+278C` | ➌ | `U+27BC` | ➼
| `U+271E` | ✞ | `U+274B` | ❋ | `U+278D` | ➍ | `U+27BD` | ➽
| `U+271F` | ✟ | `U+274D` | ❍ | `U+278E` | ➎ | `U+27BE` | ➾
| `U+2720` | ✠ | `U+274F` | ❏ | `U+278F` | ➏
| `U+2721` | ✡ | `U+2750` | ❐ | `U+2790` | ➐

## Maintaining the hyphenation dictionary

Hyphenation dictionary

SDoP is distributed with a British English hyphenation dictionary in a file called `HyphenData`. This is installed with the other SDoP data files (often in `/usr/local/share/sdop/`). The distribution also contains tools that enable you to modify this dictionary, or create entirely different dictionaries. These tools are not installed as user commands – they are built by ‘make’, but remain in the build directory.

The `buildhy` program reads a file of hyphenated words and adds indexing information on the front so that SDoP can then use it as a hyphenation dictionary. Use it like this:

    buildhy <inputfile> <outputfile>

The input file is a list of words, one per line, in alphabetical order (not counting the hyphens in the sort). The list that is used to create the distributed dictionary is supplied in the file `hyphenlist`. It starts like this:

    aba-cus
    aba-lone
    aban-don
    aban-doned
    aban-doner
    aban-don-ment
    abase-ment

The index that is added to the start of the output file (which is otherwise a copy of the input) is in the form of four-letter entries with the offset of the relevant point in the dictionary in digits after them. The total number of entries in the index is output on the first line. The distributed dictionary starts like this:

    1541
    abdi148
    abdu225
    abid309
    abol413
    abor528
    abra576

You can test a newly-built dictionary using the `hytest` program:

    hytest <new dictionary> [<input file> [<output file>]]

If no input (output) file is given, the standard input (output) is used. A good test for a new dictionary is to take the input that you originally gave to `buildhy`, remove all the hyphens, feed it to `hytest` and check that you get back the original, hyphenated file. If you do not, the most likely cause is that the input file is not in the correct alphabetic order.

## Index