Template configuration page

Key point: Configure the document types, media types, URL types, publication types, Schematron and Xref configs used in your project.

Overview

This page lets you review and update the configuration for the templates defined in your project and in use in the group within it. This includes:

  • Document types
  • Media types
  • URL types
  • Publication types
  • Schematron
  • Xref configs

If the project is defined as the global template, the changes affect all the groups and projects in your PageSeeder instance.

lightbulb icon

When you click a link under a column, the corresponding file opens in the template file panel to the right, where you can either edit the content of the file if link preceded by pencil icon or plus icon icon, or review the content if link is preceded by eye icon icon.

file-template icon Edit global template configuration – customize the global template. See the global template page.

ok icon Validate all button – validate all the configuration files in this template. See document types validation page.

xref icon Edit Xrefs config button – xref-config.xml – configure xrefs across a whole project to make it easier for users to create them consistently for different purposes.

For developers: For more information, see the following article on the PageSeeder developer’s website: xref config.

Document types

A document type is a collection of files that define all the necessary characteristics for representing a specific type of content.

The default PSML document type configurations for a default document, or default for a references document, can be used, or overridden. You can opt to create custom configurations for the type in the panel that opens on the right:

  • document-config.xml – in the Config column, the document config defines:
    • <creation> – Specify where documents of the type are created.
    • <labeling> – Specify labels available in the document type, including block, inline, image, link, xref, edit-note, fragment, and document.
    • <publishing> – Specify custom processing for different documents when invoking publishing action types export, publish, or process.
  • document-template.psml – in the Template column, the document template defines the content, structure and heirarchy of PSML documents, including sections, fragments, labels, properties and metadata. See How to create a document template.
  • default.sch – in the Schematron column, the default schema is used to specify rules to validate the entire document or document fragments. See How to create a schema for a document.

    For developers: See the developer’s documentation for more information, Validating documents.

  • editor-config.xml – in the Editing column, can override the default settings with customizations for the editing interface, making it possible to configure the document editor with components such as drop-down lists for property values:
    • PSMLPropertiesproperties editor, customize the editing interface for properties to improve productivity or data quality.
    • PSMLMetadata – same options as PSML properties editor but used for document metadata properties.
    • PSMLXRefsxref list editor, used to customize the list of xrefs in a references document.
    • PSMLCreation – same options as PSML properties editor but used for document and fragment creation. Requires PageSeeder v5.98 or higher.
  • document.css – in the Style column, the style template modifies the default UI display for the content of a document type. It is used to customize the display of the PSML.

To create a new PSML document type, click the plus icon Create document type button. A row for the new type is added to the PSML document types table.

Media types

media type (also referred to as a content type or MIME type) defines the kind of content, and tells what kind of app is needed to process the content of a file. These configuration files specify the PSML metadata and processing associated with a media type.

  • media-template.psml – in the Template column, individual templates control the processing of the metadata fields for each file type.
  • default.sch – in the Schematron column, the default schema defined for validating the metadata for a media type.
  • editor-config.xml – in the Editing column, can override the default settings for the media type with customizations for the metadata editing interface, making it possible to configure the document editor with components such as drop-down lists for property values.
  • word-import-config.xml – in the Word Import column for media type DOCX, maps Word styles to PSML elements.
  • psml-split-config.xml – in the Split column for media type DOCX, defines rules for splitting a single PSML file (as a secondary part of a Word import process) into multiple documents and fragments.

cog icon Reprocess... button – in the Metadata column, after creating or modifying a media template, all relevant files can be updated using the Reprocess... button.

To create a new media type, click the plus icon Create media type... button. A row for the new type is added to the Media type table.

URL types

A URL type  is a collection of files that define the metadata, processing and validation for different kinds of URLs.

info-circle icon

URL types can only be configured in the global template, so if you have the correct access click on file-template icon Edit global template configuration to modify these.

  • url-config.psml – in the Config column, defines:
    • <creation> – The domains and media types allowed for these URLs.
    • <labeling> – Specify labels available in the URL type but labels/@type must be url.
    • <publishing> – Specify custom processing for different URLs when invoking publishing action types export, publish, or process.
  • url-template.psml – in the Template column, individual templates control the processing of the metadata fields for each URL type.
  • default.sch – in the Schematron column, the default schema defined for validating the metadata for a URL type.
  • editor-config.xml – in the Editing column, can override the default settings for the URL type with customizations for the metadata editing interface, making it possible to configure the document editor with components such as drop-down lists for property values.

cog icon Reprocess... button – in the Metadata column, after creating or modifying a URL template, all relevant URLs can be updated using the Reprocess... button.

To create a new URL type, click the plus icon Create URL type... button. A row for the new type is added to the URL type table.

Publication types

The key function of the publication type is to configure how heading and paragraph hierarchy and numbering is processed throughout a collection of documents. The publication type also allows for the configuration of a custom format to be included for generating Word or PDF output.

The default publication configurations can be used, or overridden. Then, you can opt to create custom configurations for the type in the panel that opens on the right:

  • publication-config.xml – in the Config column, configures heading and paragraph numbering across the documents in the publication.
  • pdf-export-config.xml – in the PDF Export column, configures the formatting of PSML when exported to PDF.
  • word-export-config.xml – in the Word Export column, maps PSML elements to Word styles.
  • word-export-template.docx – in the Template column, uploads a DOCX template containing the Word styles your word-export-config.xml maps to.

To create a new publication type, click the plus icon Create publication type... button. A row for the new type is added to the Publication types table.

How to find this page

Administration menuproject icon [Project] > file-template icon Template > Template configuration, OR

In the Document developer panel, click the wrench icon Manage document/URL/media types button. OR

Navigation menu > Project > Document types browse page, click the wrench icon Manage document types button at the top right