The numbers the reader shows

Restart the numbering somewhere in the document, in roman numerals, in letters, or behind a prefix.

Written at the top level of a request, under "renumber"

In plain words

Written for anybody. It says what this puts on a sheet of paper, and asks nothing of you beyond that.

In a book, the opening pages — the preface, the contents — are numbered in small roman numerals, and the real text starts again at page 1. The annex often carries A-1, A-2. You can ask for exactly that: from such a sheet on, the numbering starts again at such a number, spelled such a way. It is the number the reading software shows in its little box, the one you type to jump straight to a page.

For a developer

Written for somebody who writes the calling program: the model, the units, and the settings that carry the weight.

renumber carries the numbering restarts: each entry makes the number a reader shows start again from a given sheet. That number is a separate thing from the sheet's physical position in the file; it lives in the page label. Six spellings exist, one of which writes a prefix and no figure at all. The {page_label} substitute inside a text draws that label as a reader shows it.

Every key, with its default

The reference: which keys are required, which are optional, what each one defaults to and which combinations the server declines.

  • renumber — array, optional, empty by default.
  • renumber[].from_page — integer, required. The sheet the restart takes effect from; sheets count from 1.
  • renumber[].value — integer ≥ 1, required. The number shown on that sheet. Zero is refused: a reader's numbering has no way to spell it.
  • renumber[].style — string, optional, decimal by default. Six values: decimal (1, 2, 3), upper_roman (I, II, III), lower_roman (i, ii, iii), upper_letters (A, B, C then AA, BB), lower_letters (a, b, c then aa, bb), prefix_only (the prefix alone, no figure).
  • renumber[].prefix — string, optional, empty by default. What each page of the run shows before its number: A- for an annex numbered A-1, A-2.

A whole request that draws it

Post this as it stands and a PDF comes back. Nothing has been left out of it.

{
  "renumber": [
    { "from_page": 1, "value": 1, "style": "lower_roman" },
    { "from_page": 3, "value": 1, "style": "decimal" }
  ],
  "standard_fonts": [{ "name": "sans", "face": "helvetica" }],
  "items": [
    {
      "type": "text",
      "rect": { "llx": 60, "lly": 60, "urx": 535, "ury": 74 },
      "content": ["Page {page_label}"],
      "font": "sans",
      "font_size": 10,
      "align": "center"
    },
    {
      "type": "text",
      "pages": [4],
      "rect": { "llx": 60, "lly": 740, "urx": 535, "ury": 765 },
      "content": ["The annex"],
      "font": "sans",
      "font_size": 14
    }
  ]
}

The line that sends it, in three languages

The document as a whole

A hundred letters in a single file What the document says about itself A file still readable in thirty years An invoice a person and a machine both read The address relative links are read against The PDF version the file declares What an image says about itself

Where to go next

Every key of a request, in one page The other thirty-two settings of a request

See the prices See the examples

Glossary

page label
The number a reader shows for a page, which is not the same thing as its position in the file. It is what lets a foreword run i, ii, iii and the body start again at 1.

Every word the site explains