Publication

Key point: As a logical binder for a collection of documents, the publication enables critical functionality for long documents.

Is a mechanism to process a collection of PSML documents. Typically, a publication is created when a publication ID is added to a references document to create a publication root document.

Publication ID

The publication ID enables some functionality that is critical for long documents. This includes the following:

  • Adding navigation to the collection by presenting the headings from each document as a Table of Contents.
  • Support for heading and paragraph numbering to increment across documents and to display paragraph numbers as the title of an xref. This also allows the xref title to update if the paragraph number changes.
  • The ability to simultaneously version all the documents in the publication and allow individual documents to be used in multiple publications, each with their own version values.

Also see How to create a publication.

Publication root

Adding the publication ID to a document creates the publication root document. After the root document is created, all documents linked from the root using an embed-type of xref are automatically considered part of the publication.

Publication type

Conceptually similar to a document type but with a different role, the key function of the publication type is the configuration of how the heading and paragraph hierarchy and numbering are processed throughout the collection, including:

  • How numbers are inherited from higher level lists – 1.1, 1.1.1, 1.2, 1.2.1.
  • Number formats – such as 1, 2, 3 – a, b, c – i, ii, iii.
  • How numbers are decorated – 1.a – 1.a. – 1(a) – 1. a).
  • When numbering must restart.
  • Whether to attach numbering to block labels.

The publication type also allows for the configuration of a custom format to be included for generating Word or PDF output.

For managers: Managers configure auto-numbering at the project level. For more information, see publication type on the Template configuration page.