Every block, cover element, content setting, colour, typography role, page overlay and insert token in the document layout designer, with defaults and limits.
This reference lists everything you can set in the document layout designer. For the tasks of creating, previewing and saving a layout, see design reusable document layouts. Labels are shown as they appear in the designer.
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
A rendered document is built in this order:
The Front matter blocks, in the order you arrange them.
The document body, section by section, styled by the Content settings.
The Back matter blocks, in the order you arrange them.
A Requirement Traceability Matrix page, which ends every rendered document. It lists the requirements the document covers with the columns Requirement, Clause and Fulfillment, or states that the document is not mapped to any requirements. It is not a block and cannot be removed or moved.
The Page overlays are then drawn on the pages. When the layout has a Front page, page numbering starts on the page after the cover, and Total pages does not count the cover.
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Block | Allowed in | How many | Settings (default) |
|---|---|---|---|
Front page | Front matter | One | A cover page built from elements; see the next section. Always followed by a page break. |
Table of contents | Front matter | One | Title ( |
Version history | Front matter or back matter | One in each | Title ( |
Free-text page | Front matter or back matter | Any number | Title (blank, up to 120 characters). Body (required, up to 8,000 characters, accepts tokens). |
Signature page | Back matter | One | Title ( |
References appendix | Back matter | One | Title ( |
A section holds up to 25 blocks.
Table of contents lists the document's section headings. In a PDF, each entry shows its page number. In a Word file, it is a Word contents field, which Word offers to update when the file is opened.
Version history is a table with the columns Version, Date and Summary, newest first, taken from the versions published to the vault. A document without published versions shows No versions recorded.
Free-text page puts the title as a heading and the body as paragraphs on a page of its own. Separate paragraphs with a blank line. Use it for a preface, a scope statement or a confidentiality notice.
Signature page starts a new page with the title, an Approved by: line with the approver's name and a Date: line with the approval date. Before the document is approved, both are left as blank lines. A ruled line labelled Signature follows, for a handwritten signature on printed copies.
References appendix starts a new page with a table of the document's cross-document references, with the columns Direction, Type and Document. Direction chooses references from this document to others (Outgoing), from other documents to this one (Incoming), or both. A broken reference is marked (broken) when Include broken references is on. A document without references shows This document has no cross-document references.
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Add elements to a Front page with Add element. They appear from top to bottom in the order you arrange them, below a thin bar in the Accent colour across the top of the cover.
Element | What it shows | Settings (default) |
|---|---|---|
Logo | Your organisation's logo, or another image you upload. | Source: Tenant branding logo (default) or Uploaded image asset. Image asset: the image to show when the source is Uploaded image asset. Max width (pt) ( |
Document title | The document's name. | Alignment (Center). |
Subtitle | The standard's code and name, such as | Alignment (Center). |
Metadata table | A two-column table of document details. | Fields: a checklist of the details to include; see below. |
Free text | Your own text, such as a confidentiality notice. | Text (required, up to 2,000 characters, accepts tokens). Alignment (Center). |
Image | An image you upload, such as a product photo or a certification mark. | Image asset (required). Max width (pt) ( |
Spacer | Empty vertical space. | Height (pt) (required, |
Signature line | A ruled line with a caption. | Label ( |
The Tenant branding logo is the logo uploaded under Branding; see branding.
For an Image asset field, upload the image in the designer, or type the asset key of an image that is already stored; a key begins with branding/ or layout-assets/. The same applies to Header logo and to the watermark Image.
Select the fields to show under Fields. A new Metadata table starts with Document Code, Version, Status and Effective Date. A field without a value for the document is left out of the table.
Field | Value |
|---|---|
Document Code | The document's code. |
Version | The approved version number. |
Status | The document's status, as shown in ComplyTrain, such as |
Effective Date | The document's effective date. |
Classification | The Classification banner text of the page footer. |
Standard | The standard's code. |
Date | The date the file was produced. |
Organization | Your organisation's name. |
Approved By | The name of the person who approved the document. |
Approved At | The approval date. |
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Section pagination has one setting, Start each top-level section on a new page. It is on by default: every top-level section of the body begins on a fresh page. Clear it to let sections follow each other on the same page.
Cross-document references decides where references between this document and other documents appear. Choose one mode.
Mode | Where references appear |
|---|---|
Appendix (default) | In the References appendix block. Add that block to Back matter; its Direction and Include broken references settings choose which references are listed. |
Inline section | A reference linked to a section is listed under References at the end of that section. |
Footnote | A reference linked to a section is shown as a note: under Notes at the end of the section in a PDF, and as a footnote in a Word file. |
In the Inline section and Footnote modes, references that are not linked to a particular section go to a references appendix at the end. If the layout has no References appendix block, ComplyTrain adds one. Broken references are not listed within sections.
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Document colours set the colours of the rendered document. Enter a colour as #RRGGBB or pick it with the colour swatch. Clear colour empties the field. A blank colour takes your organisation's brand colours from Branding, so a layout with no colour overrides follows your branding; see branding.
Colour | What it colours |
|---|---|
Primary | The document title, level 1 and level 2 headings, and the table of contents title. |
Secondary | Level 3 and lower headings. |
Accent | The bar across the top of the cover page and links. |
Text | Body text and table text. |
Muted text | The subtitle, captions, quotations, header and footer text, cover metadata labels, and a text watermark whose Colour is blank. |
Highlight background | Shaded backgrounds, such as behind code. |
Table header background | The background of table header rows. |
Border | Table borders, horizontal rules and signature lines. |
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Typography has one row per text role. For each role you can set its font, size and colour, and each value you set applies to that role's text in PDF and Word output. Leave a value blank to inherit the default.
Column | What you enter |
|---|---|
Font | Inherit, a built-in family such as Arial, Calibri, Georgia, Times New Roman or Courier New, or a family uploaded under Manage fonts. An uploaded family is embedded in the PDF and Word files, in every weight and style you uploaded. |
Size (pt) | A size in points, greater than 0 and no more than 400. |
Colour | A colour as |
The Preview column shows AaBbCc 123 in the chosen font, size and colour.
Role | Text it styles |
|---|---|
Title | The document title on the cover page. |
Subtitle | The subtitle on the cover page. |
Heading 1 | Top-level section headings. |
Heading 2 | Second-level headings. |
Heading 3 | Third-level headings. |
Body | Paragraph text. |
Caption | Captions and small notes. |
Table header | The header row of tables. |
Table cell | The body rows of tables. |
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Add a Page header under Page overlays to print a line at the top of each page.
Setting | Default | What it does |
|---|---|---|
Enabled | On | Clear it to keep the header's settings but stop printing it. |
Left text, Center text, Right text | Blank | The text at the left, centre and right of the header. Up to 200 characters each; accepts tokens. |
Header logo | Blank | An image printed in the header, such as a small logo. Upload the image in the designer. |
Skip on front page | On | Leaves the header off the cover page. |
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Add a Page footer to print a line at the bottom of each page.
Setting | Default | What it does |
|---|---|---|
Enabled | On | Clear it to keep the footer's settings but stop printing it. |
Left text | Blank | The text at the left. Up to 200 characters; accepts tokens. When blank, the footer shows your organisation's name. |
Show page numbers | On | Prints Page N of M in the centre. |
Center text | Blank | The text in the centre when Show page numbers is off. Up to 200 characters; accepts tokens. |
Classification banner | Blank | A classification such as |
Skip on front page | On | Leaves the footer off the cover page. |
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Add a Watermark to print a large, faint mark diagonally across the middle of each page.
Setting | Default | What it does |
|---|---|---|
Mode | None | Text prints the watermark text; Image prints the watermark image. With None, no watermark is printed. |
Text |
| The watermark text, up to 60 characters; accepts tokens. |
Image | Blank | The image for the Image mode, such as a faint company seal. Upload the image in the designer. |
Colour |
| The colour of the text, as |
Opacity |
| How visible the mark is, from |
Angle (deg) |
| The rotation in degrees, from |
Scope | All documents | All documents, or Draft documents only for documents whose status is Draft. |
Skip on front page | On | Leaves the watermark off the cover page. |
Adding a watermark does not print anything until you set Mode to Text or Image.
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Fields marked as accepting tokens (Free text, Body of a Free-text page, the header and footer texts and the watermark Text) have an insert panel. It groups the tokens under Document, Approval, Branding and Page. Choose a token to insert it at the cursor; the token itself appears when you point to its button.
Token in the panel | Group | Inserted text | What it prints |
|---|---|---|---|
Document title | Document |
| The document's name. |
Document code | Document |
| The document's code. |
Version | Document |
| The approved version number. Blank before the first approval. |
Status | Document |
| The document's status, as shown in ComplyTrain, such as |
Effective date | Document |
| The document's effective date. |
Classification | Document |
| The Classification banner text of the page footer. |
Approved by | Approval |
| The name of the person who approved the document. Blank before approval. |
Approved at | Approval |
| The approval date, such as |
Organization name | Branding |
| Your organisation's legal name, or its display name when no legal name is recorded, from the organisation profile. |
Page number | Page |
| The number of the current page. Prints only in the page header and footer. |
Total pages | Page |
| The number of pages. Prints only in the page header and footer. |
Current date | Page |
| The date the file was produced, such as |
You can also type a token, with or without spaces inside the braces, such as {{ version }}. A token name that is not in the list, such as {{doc_code}}, stops the layout from being saved. Page number and Total pages print nothing outside the page header and footer.
Product location: /settings/document-layouts/{layoutId} (fallback: /settings/document-layouts). Open Settings, then Document Layouts, and choose Edit on a layout.
Item | Rule |
|---|---|
Layout Name | Required, up to 100 characters, unique among your organisation's layouts. |
Layout Description | Up to 500 characters. |
Layouts per organisation | Up to 50. |
Blocks per section | Up to 25 in Front matter and up to 25 in Back matter. |
Colours |
|
Numbers | Within the range shown for each setting. A value outside it marks the block Incomplete. |
Asset keys typed by hand | Begin with |
Fonts | A built-in family or a family uploaded under Manage fonts. |