Skip to main content

 Configuration

Configuration manual for PageSeeder

Publications and publication types

This feature requires PageSeeder v5.96 or higher.

Background

A “publication” is a hierarchical collection of  PSML component documents joined by “embed” or “transclude” type xrefs. Publications are at group level.

The core of the feature is a process that seamlessly resolves the publication component into a single document for presentation or numbering. The following documentation explains the options for processing a publication.

For additional background, we recommend completing this tutorial. The challenges of document numbering are widely recognized and the sample files of the tutorial help to explain how PageSeeder addresses this issue.

Concepts

Following are some key ideas that have a role in PageSeeder publications.

Block labels

Publications process the content of a <block> element if the value of the @label attribute corresponds to a declaration in the publication config. Use cases for block labels include numbering figures or tables.

Block labels and headings

In the publication-config, the level of the <block> element declarations is significant. Any values to be included with the counter must already be declared in the config.  

For example, to prefix a figure caption with a chapter number, say – Chapter 4: Figure 7 – and chapter heading is @level="2", then block-label="figure-caption" cannot be declared at @level="1". To create a prefix that includes a value from level 2, the declaration for the counter must be at least @level="3".

Components / Shared components

Component document is a term to describe a document that has been referenced from a publication root using an embed, or transclude xref. A shared component is part of multiple publications. How the document is numbered, or its position in the Table of Contents, depends on which publication root is current (open).

See also “current publication”.

embed and transclude

These are the only two xref types that can be used to assemble component documents into a publication. 

Current publication

The publication that determines the display of a component document. Where a component is shared, at the top of the Table of Contents panel, to the right of the publication title, you can click the angle-down icon to select other publication root documents from the drop-down.

See also “shared component”.

@level vs @indent

In PSML, the <heading> element has a @level attribute and the <para> element has an @indent attribute. For the purposes of the publication configuration, unless the documentation is explicit, consider any references to level to also mean indent.

Microsoft Word

To reliably generate correctly numbered DOCX files, it is important to calibrate the Word template and the publication config. See DOCX support.

Numbered vs Unnumbered

Both <heading> and <para> elements support an attribute of @numbered that is available through the number icon in the editing interface. Any object where this attribute has a value of true is subject to processing by the publication config.

Publication config

Stores all configuration information for a given Publication Type in the following folder:

template/[project]/publication/[type]

Publication headings

The <heading> element is a fundamental part of PSML, and in a publication, it is the primary structural and navigational object. Only the content of <headings> elements are displayed in the ToC.

Publication ID

Adding a publication ID through the document properties makes any PSML document with embed or transclude xrefs into a publication. A document with a publication ID is known as the Publication root.

All documents with a publication ID are listed in the Publications tab on the group homepage:

Navigation menu > group Group > home Group home 

While future releases might provide tools to help manage publication IDs, at present, as it is with the Doc ID, users must ensure that IDs are unique within a server. Preventing ID clashes can usually be achieved by prefixes that incorporate the project or group name. 

Publication paragraphs

In publications, all the properties of a <heading> element are available to the <para> element, with one important distinction—<para> elements are not displayed in the ToC by default, and when displayed, their content is always truncated.

By default auto-numbered paras need to be indented to number correctly. However, if you want to not have them indented you can create a custom publication config and adjust it to handle that. For example on the default publication config you would change para-relative-to="6" to para-relative-to="7". Manually numbered (prefixed) paras do not need to be indented.

References document type

Although it is not mandatory, the references document type is the logical choice for the document-type of a publication root.

Table of Contents (ToC)

The PageSeeder interface supports two approaches to the ToC:

  • If all the headings are linked from a single references document, the entire ToC is displayed at once.
  • If the publication root links to a references document, the ToC displays the high-level xref titles always, but only displays a complete list of headings for the current references document.

Versions

Publications add a new dimension to PageSeeder document versions, especially documents that are part of multiple publications. See Versioning a publication.

Xref config

These are project-level configurable templates that automatically format links such as references to numbered paragraphs, footnotes or citations.

<xref display="template"
      title="{parentnumber}{prefix}"
      config="paragraph" ...>

Best practice

Getting the best results out of publications is easier under the following circumstances:

  1. Start every document with a heading level 1 then let the references document and publication process calculate the final level of heading. This is easier than trying to anticipate and adjust the position of the heading in the hierarchy.
  2. Do not put any paragraphs before the level 1 heading in a document.
  3. To include single fragments in a publication, use xref type of “transclude”, not “embed”.
  4. Whenever using an xref type of “embed”, the link cannot be one-way, it must reverse.

The in-built “best practice” schema validates for these issues.

Publication management

Following are the details for some routine tasks.

Create a publication

Publication ID

To create a publication requires a Publication ID. This value must be:

  • Unique for the PageSeeder server (similar to Document ID).
  • Up to 250 characters long (but usually less than 20 characters), and
  • It can only contain the following characters: [a-z][A-Z][0-9][-_]

To create a publication from an existing set of documents, follow these steps:

  1. Navigate to the root document and click the info icon in the right sidebar to open the Document info & metadata panel to the default Properties tab.
  2. Click the Make this document a publication button at the bottom of the panel.
  3. Enter an ID of your choice in the ID field.
  4. Unless users have specific instructions to choose a Publication type, ignore this field and let the system assign the default type.
  5. Click Submit.

create-publication.png

The Table of contents panel on the left displays all the headings that you have added to your root document, across the publication files—see the following image.

publication-toc.png

Delete a publication

To delete a publication, clear the value from the Publication ID field in the Document info & metadata panel.

This also deletes all the versions associated with the publication.

Change the publication root

To do this, the user must have at role of contributor or higher to edit the old root document to remove the Publication ID if they want to re-use it for the new root document.

Since Publication ID's must be unique server-wide, you must first delete the old publication. Then navigate to the document you want to be the new root document and make it a publication, or if already a publication, edit the Publication ID—you can re-use the Publication ID you deleted or you can use a different Publication ID.

Publication configuration

Each publication has a type that specifies the levels and numbering. If no value has been selected through the Publication type field on the Document info & metadata panel of the root document, then the type is default.

To define a custom publication-type needs a publication-config.xml file in the template/[project]/publication/[type] folder. To create this file, do the following:

  1. Go to the Document types page:

    1. Administration menu > [Project] > Template > Document types, OR

    2. Click the Manage document types button in the Developer tools panel , OR

    3. Click the Manage document types button at the top of the Navigation menu > Project > Document types page.

  2. Under the Publications type table, click Create publication type... and enter a name using only letter, number and underscore characters.

  3. Click Create and the name displays in the table—click the trash icon beside it to delete it, or click the Cancel button to abandon creating the publication type.

  4. Under the Config column, click create.

  5. Modify the publication config in the panel at the right (see options following).

  6. Save the publication config file.

  7. Navigate to the publication root and click the info icon to open the Document info & metadata panel on the right.

  8. In the Publication type field, select the new type from the drop-down.

  9. Save the changes.

After any edits, click the reload button under the Publication Table of contents column. This clears the cache and regenerates the Table of contents with the new settings.

publication-config.xml

Following is the default publication-config.xml used by PageSeeder.

<publication-config>
  <toc title-collapse="always" />
  <levels xref-relative-to="heading"
          para-relative-to="6" />
  <numbering>
    <schemes>
      <scheme level="1"
              type="decimal"
              format="[1.]" />
      <scheme level="2"
              type="decimal"
              format="[1.][2]" />
      <scheme level="3"
              type="decimal"
              format="[1.][2.][3]" />
      <scheme level="4"
              type="decimal"
              format="[1.][2.][3.][4]" />
      <scheme level="5"
              type="decimal"
              format="[1.][2.][3.][4.][5]" />
      <scheme level="6"
              type="decimal"
              format="[1.][2.][3.][4.][5.][6]" />
      <scheme level="7"
              type="loweralpha"
              format="[(7)]"
              element="para" />
      <scheme level="8"
              type="lowerroman"
              format="[(8)]"
              element="para" />
      <scheme level="9"
              type="upperroman"
              format="[(9)]"
              element="para" />
      <scheme level="10"
              type="upperalpha"
              format="[(10)]"
              element="para" />
    </schemes>
  </numbering>
</publication-config>

<toc> element

This element is optional and can have the following optional attributes:

AttributeDescriptionDefault value
title-collapse

By default, PageSeeder documents are created with the same value in the document title and the first heading of the document.

The reason to collapse the title is so that the default content doesn’t appear twice in the ToC. Allowed values for @title-collapse are:

  • always – if the first heading in a document has a higher level than all other headings, then always collapse it.
  • auto – if the first heading in a document has a higher level than all other headings and it matches the document title, then collapse it.
  • never – never collapse the headings.
always
para-indents

The allowed value for this attribute is a comma-separated list of indent values.

By default, only headings are included in the ToC. However, this attribute allows the content of auto-numbered or prefixed paragraphs to be included (only the first 40 characters are displayed).

Requires PageSeeder v5.9702 or higher.

block-labels

The allowed value for this attribute is a comma-separated list of block labels values).

By default, only headings are included in the ToC. However, this attribute allows the content of paragraphs wrapped by block labels to be included (only the first 100 characters).

Requires PageSeeder v5.9702 or higher.

<levels> element

When processing the publication components into a single instance, this element controls the resolution of the levels. This can affect the numbering and presentation of headings, paragraphs and xrefs. This element is optional and can have the following optional attributes:

AttributeDescriptionDefault value
xref-relative-to

Calculates the link title by processing the heading levels of the target document. Allowed values are:

  • heading – this option considers the xref’s target as a child of current heading in the source document. If the xref is below a heading 3 in the source document, the content of the xref is promoted by three levels.
  • document – this option ignores the content of the document that hosts the xref and adjusts the level according to the host document’s level in the ToC. If the host is level 2, the headings and paragraphs in the target document are promoted two levels.
heading
para-relative-to

Determines how paragraph indents are calculated when the documents in the publication are consolidated. Allowed values are:

  • heading – process according to the content in the source document, similar to xref-relative-to .
  • document – process according to the source document’s level, similar to xref-relative-to .
  • 5,6,7,8,9 – process by adding this fixed value to the indent. Requires PageSeeder v5.9702 or higher.
heading
heading-adjust

DEPRECATED as of v5.98. Indicates whether to adjust the @level attribute on the <heading> element. Allowed values are:

  • numbering – adjust for numbering only.
  • content – adjust for numbering and in document content.
numbering
para-adjust

DEPRECATED as of v5.98. Indicates whether to adjust the @indent attribute on the <para> element. Allowed values are:

  • numbering – adjust for numbering only.
  • content – adjust for numbering and in document content.
numbering

<numbering> element

The <numbering> element applies numbering schemes to a PSML document and can apply additional numbering schemes for documents that have a specific document label. See the example below. Without this element, there is no generation of numbers in the publication. The <numbering> element supports the following optional attributes:

AttributeDescriptionDefault value
skipped-levels

Non-consecutive, or “skipped” heading levels are for example when a <heading level="3"> follows <heading level="1">. Processing options include the following:

  • 1 – the publication makes the missing levels a “1” – for example, 2.1.3.
  • 0 – the publication makes the missing levels a “0” – for example, 2.0.3.
  • strip – the publication removes any reference to missing levels – for example, 2.3.
1
document-labelNumbering only applies to documents with the specified document label. When a document has multiple labels, the first <numbering> element in the config that matches is used.

<scheme> element

Each <scheme> represents a configuration of publication characteristics differentiated by a @level attribute.

For the sake of consistency and clarity, the configuration for each @level is explicit. Where the content of a publication does not conform with what has been declared in the scheme, a contingency must be declared (see the @skipped-levels attribute on the <numbering> element above).

The <scheme> element can have the following attributes:

AttributeDescriptionDefault value
level

@level represents the hierarchical position of the post-processed headings or paragraphs in the ToC. 

Each scheme level must have a unique value (required).

If the value of the @level attribute alone doesn’t make the scheme unique, a @block-label attribute can be used to disambiguate two schemes with the same level.

For example, there might be a requirement to process the level 2 differently in an Appendix than the body of a Report. To do this, one of the numbering schemes must have a block-label for disambiguation. The numbering/@document-label attribute can be used to have different schemes at the document level.

format

The formatting characteristics of each level of the scheme (required).

Defined by one or more patterns [x(level)x] where:

  • (level) – defines the level of numbering from 1 to 9.
  • x – is a string of static content to decorate the numbering. For example:
    • Figure” – before the number in an image caption, or
    • “Chapter ”  – before the number of each <heading level="1">.
type

The expression of numbering (optional). Allowed values are the following:

  • decimal
  • upperalpha
  • loweralpha
  • upperroman
  • lowerroman
decimal
element

The PSML element that each numbering level applies to (optional). Allowed values are the following:

  • heading
  • para
  • any

any is not supported by the export to DOCX format.

heading
block-label

Spawns a separate numbering stream when this value corresponds to the value of the @label attribute on a <block> element that is wrapping <para numbered="true"> or <heading numbered="true"> elements (optional).

Designed to support use cases such as numbering figures and tables separate to paragraphs or headings. For example, Table 1.1, Table 3.1.

Requires PageSeeder v5.98 or higher.

Example

<publication-config>
  <toc title-collapse="always" />
  <levels xref-relative-to="heading"
          para-relative-to="6" />
  <numbering>
    <schemes>
      <scheme level="1"
              type="decimal"
              format="[1.]" />
      <scheme level="2"
              type="decimal" 
              format="[1.][2]" />
      <scheme level="3"
              type="decimal"
              format="[1.][2.][3]" />
      <scheme level="4"
              type="decimal"
              format="[1.][2.][3.][4]" />
      <scheme level="5"
              type="decimal"
              format="[1.][2.][3.][4.][5]" />
      <scheme level="6"
              type="decimal"
              format="[1.][2.][3.][4.][5.][6]" />
      <scheme level="7"
              type="loweralpha"
              format="[(7)]"
              element="para" />
      <scheme level="8"
              type="lowerroman"
              format="[(8)]"
              element="para" />
      <scheme level="9"
              type="upperroman"
              format="[(9)]"
              element="para" />
      <scheme level="10"
              type="upperalpha"
              format="[(10)]"
              element="para" />
    </schemes>
  </numbering>

  <numbering skipped-levels="strip" document-label="component">
    <schemes>
      <scheme level="1"
              type="decimal"
              format="[1.]" />
      <scheme level="2"
              type="decimal"
              format="[1.][2.]" />
      <scheme level="2"
              type="decimal"
              format="[Table 1-][2]"
              block-label="table-caption" />
      <scheme level="2"
              type="upperalpha"
              format="[Fig 1-][2]"
              block-label="figure-caption" />
      <scheme level="3"
              type="decimal"
              format="[1.][2.][3.]"
              element="any"/>
      <scheme level="4"
              type="decimal"
              format="[1.][2.][3.][4.]"
              element="any"/>
      <scheme level="5"
              type="loweralpha"
              format="[(5)]"
              element="para"/>
      <scheme level="6"
              type="lowerroman"
              format="[(6)]"
              element="para" />
      <scheme level="7"
              type="upperalpha"
              format="[(7)]" />
      <scheme level="8"
              type="upperroman"
              format="[(8)]" />
      <scheme level="9"
              type="loweralpha"
              format="[9]" />
    </schemes>
  </numbering>
</publication-config>

DOCX support

It is important to understand the consequences of the settings in the publication-config.xml file and their effect on Microsoft Word or applications that can process DOCX file format such as Adobe InDesign.

Getting the needed results from the PageSeeder publication requires coordinating the publication config and the docx template to meet the objectives of the final output.

The intention of the publication is to deliver the wanted results. Sometimes the best way to do this is to capture the numbering logic but not necessarily to transfer these settings to DOCX or other formats. In many cases, the intention of these properties is to represent the same logic, so that the people editing have a representation that is closer to their final format. This might be something as straightforward as image numbers, so references are the same in the editing view as they are in the final format. For example, [Fig 1-2] instead image-456.jpg.

To calibrate the publication with a docx template or an InDesign import might require some deep understanding of non-PageSeeder technologies. In addition to the publication-config, users might need to configure the Default Numbering in the PageSeeder word-export-template.docx. See How to configure auto-numbering for additional information.

As many people might know already, applications like Word and InDesign are powerful, but complex. The good news is that PageSeeder publications can support very demanding numbering, done properly. Users can expect the numbering in their Word documents to be correct every single time they export. Unfortunately, this needs Word skills, not only PageSeeder.

Contact Allette Systems to discuss your requirements.

Versioning a publication

Only approvers can create document versions.

All the component documents in a publication can be versioned by taking the following steps:

  1. Navigate to the publication root document and click the Document versions icon in the right sidebar. The Document versions panel displays on the right.
  2. Click Create version... and in the Version dialog, enter the new version name:
    1. Maximum length 250 characters, or click one of the following buttons:
      1. Minor – default value is 0.1.
      2. Major – default value is 1.0.
      3. Date – select date, click the calendar.
  3. If needed, enter a note, add labels or change message settings.
  4. Click Submit.

The new version displays in the Document versions panel. When you hold the cursor over the publication icon beside the new version name, the publication ID (something like Publication ID: [mypub1]) is displayed in the tool tip. When component documents are shared, the publication icons for the different publications show as different colours, eg mypub1 might be blue and mypub2 might be red.

In the Document history panel for a document, any version changes to a document are grouped together for a given date. When you click the Show versions option, the Document versions panel opens on the right.

Currently, it isn’t possible to archive a publication version.

Exporting a publication

To export a publication version, follow these steps:

  1. When viewing a publication root document, click the export icon in the right sidebar. If in Folder view, click the ellipsis-v icon to the right of the root document, then click the export icon.
  2. Choose an export action from the drop-down:
    1. For example, select Export as PSML and click the Show more details option. Enter an appropriate number under Depth of cross references to create.
    2. Click the checkbox to generate a Table of Contents.
    3. If applicable, select a Version to export from the drop-down.
    4. Select the appropriate value under Publication ID for version. The publication ID must correspond to the publication version or compare version. A publication ID with no version or compare version exports the original uploaded version.
    5. If applicable, select a Log level from the drop-down.
    6. If needed, click the Edit config option at bottom right.
  3.  Click Run.

Created on , last edited on