Publications

50 min read

Publication Topic

Every publication in Paligo automatically gets its own "front matter" called Publication Topic. This topic is used for the front cover, publication date, version number and author details. You can add and delete elements according to own needs.

  • For PDF publications, the "front matter" provides some or all of the content that is on the front cover and any pages that come before the table of contents. Learn more, see Design Covers for PDFs .

    A publication could have a background image, title, and logo to create a front cover for a PDF.

  • For HTML outputs, the "front matter" is content that appears on a web page. You can access the page by selecting the link to the publication in the breadcrumb at the top of the topic. Learn more, see Themes for HTML5 Help Centers .

    The HTML output front matter

Tip

Learn more about styling the publication, see Style and Customize your Outputs.

Note

For reused publications, there are settings in the HTML layout that you can use to control the publication topics.

Define the "Front Matter"

As a Paligo author, you can edit the publication topic to control what information that appears in the "front matter". To display or edit a publication topic, see Display a Publication Topic and Edit a Publication Topic.

A publication topic has article as the top-level element instead of section. Inside the article element is an info element. The "front matter" elements need to go inside the info element. We use the term "info elements" to describe these elements collectively.

By default, Paligo includes the title, subtitle, mediaobject, volumenum, pubdate, copyright, legalnotice, and abstract elements inside the info element.

You can enter values for these elements, add other info elements, and remove any info elements you do not want to use.

Note

The mediaobject is set to have a role attribute with the value set to titleimage. This role and value is needed to make the image a cover image.

When you have set up your publication topics, you can use the layouts and CSS to control how Paligo processes them and styles them in the output.

  • For PDF output use the settings in the PDF layout, see Style the Info Elements.

  • For HTML5 output use the settings in the HTML5 layout and CSS. To learn how to view the styles in the HTML, make changes and upload CSS, see Style with CSS.

Supported Info Elements

A publication topic has article as the top-level element instead of section. Inside the article element is an info element. The "front matter" elements need to go inside the info element. We use the term "info elements" to describe these elements collectively.

By default, Paligo includes the title, subtitle, mediaobject, volumenum, pubdate, copyright, legalnotice, and abstract elements inside the info element.

You can see this structure in the XML tree panel:

There are also other elements that you can add, depending on your requirements. To learn how to access the various elements that are available, see Edit a Publication Topic. You can also Remove Info Elements as long as they are optional elements.

Note

By default, Paligo presents the info elements in a fixed order. This may not match the order of the elements in your publication topic. But you can set the published version to match the order shown in the editor. To find out more, see Order of Info Elements

Tip

To find out more about each of the elements, refer to the DocBook standard, where you can find descriptions and information about the structure.

Title

The name of the publication. This is a required element that is included by default and supported in PDF and HTML outputs.

Example 15. Title structure

In publication topics, the top-level element is article rather than section (regular topics have section as the top-level element). Then it has the info element, and inside this, the title element.

The following example shows the structure when title is the only info element being used.

<article>
    <info>
        <title>Acme 100X user guide</title>
    </info>
</article>

Typically, you would set up a publication topic to include many other info elements, including copyright, publish date, and edition. These would all be at the same level as title inside the info element.

Subtitle

A secondary heading for the publication, often used for describing the purpose of the document or for a strapline. For example, the document title could be "Acme Series 100X" and the subtitle could be "Developer Guide". This is an optional element that is included by default and supported in PDF and HTML outputs.

Example 16. Subtitle structure

To use the subtitle element, add it inside an info element in a publication topic. Typically, it is used immediately after a title element (so both the title and subtitle are inside info). If other info elements are also included, those are also added inside the info element.

<info>
    <title>Acme 100X user guide</title>
    <subtitle>Operation and maintenance</subtitle>
</info>
Mediaobject

Use to add a foreground image. It is intended for use as a product image, but it can be any image. This is an optional element that is included by default and supported in PDF and HTML outputs.

To find out more about adding images for the front pages, see Cover Foreground Images and Cover Background .

Note

If you have a foreground image in the publication topic, it takes priority over any product image that is set in a layout.

Volumenum

This is designed to identify the volume number of the publication in a set of publications. It is a "container" element for other bibliographical elements (which you can add manually). This is an optional element that is included by default and supported in PDF output.

Tip

For adding information about the name or number of a publication, we recommend that you add the edition element and use that instead of the volumenum.

Pubdate

Use to add the date of publication to a document. You can enter the date manually or let Paligo insert the date automatically. This is an optional element that is included by default and supported in PDF and HTML outputs.

Example 17. Publication date structure

The following example shows the date entered as text inside the pubdate element. The pubdate element has to be inside the info element in the publication topic. Typically, there will also be other elements inside the info element too, such as title and subtitle.

<info>
    <title>acme 100X user guide</title>
    <subtitle>Operation and maintenance</subtitle>
    <pubdate>May 17 2022</pubdate>
</info>

In the example above, the text is entered manually.

You can also set Paligo to add the date of publication automatically. For this, make sure that the pubdate element is in the publication topic and also that it is empty (has no text or variable value).

<info>
    <title>acme 100X user guide</title>
    <subtitle>Operation and maintenance</subtitle>
    <pubdate></pubdate>
</info>

Paligo will add the publication date automatically as long as you add a date value to:

  • General > Today's date for publication date in your HTML layout

  • Front page > Info elements > Today's date for publication date in your PDF layout.

If the pubdate element contains a value, that value is shown and the layout settings are ignored. If there is no date in the pubdate or the layout settings, the publication date is excluded from the output.

Copyright

Use to add copyright details to the publication. This is an optional element that is included by default and supported in PDF and HTML outputs.

Example 18. Copyright structure

The following code shows the correct structure for a copyright entry. Note that the copyright element has to be inside an info element, along with other info elements such as title. The year and holder are inside the copyright element.

<info> 
    <title>Acme 100X user guide</title>
    <copyright>
      <year>2022</year>
      <holder>Acme Enterprises</holder>
    </copyright>
</info>

In the output, the copyright part appears as:

Legalnotice

Use to add legal information such as disclaimers and statements regarding liability. This is an optional element that is included by default and supported in PDF and HTML outputs.

Example 19. Legal notice structure

The following example shows the correct structure for a legal notice. When you add the legalnotice element, it has to be inside an info element, along with any other info elements such as title. Also, you need to add another element inside it to contain the text, such as a para element.

<info>
    <title>Acme 100X user guide</title>
    <legalnotice>
        <para>All pertinent state, regional, and local safety regulations must be observed when installing and using this product. For reasons of safety and to help ensure compliance with documented system data, only the manufacturer shall perform repairs to components. Failure to observe this information can result in injury or equipment damage.</para>
        <para>All rights reserved. No part of this publication may be reproduced, distributed, or transmitted in any form or by any means, including photocopying, recording, or other electronic or mechanical methods, without the prior written permission of the publisher. For permission requests, write to the publisher, addressed “Attention: Permissions Coordinator,” at the address below.</para>
    </legalnotice>
</info>
Abstract

Use to add a summary of a publication and or topic. The abstract is also used as the meta description for the publication in HTML outputs. This is important for Search Engine Optimization (SEO) if you are making your HTML content available to Internet search engines.

This is an optional element that is included by default and supported in PDF and HTML outputs. You can also add it to individual topics (inside an info element) to provide meta descriptions for each topic.

Example 20. Abstract structure

To use an abstract element in a publication topic, add it inside the info element (alongside other info elements, such as title). Then add an element inside the abstract element to contain the text, for example, a para element.

<info>
    <title>Acme HomeHub User Guide</title>
    <abstract>
        <para>Learn how to use the Acme SmartHome hub to manage your household devices from your phone.</para>
    </abstract>
</info>
Address

Use to add the address of an organization. This is a verbatim element, so any formatting you apply, such as line breaks, is kept in the output. You can enter the entire address directly in the address element or you can add its "child" elements, such as street and city to create a more structured address.

This is an optional element that is supported in PDF output.

Example 21. Address structure

To use the address element and its child elements for each part of the address, add them in a structure inside the info element. The address element is at the same level as other info elements, such as title.

The following code shows an example:

<info> 
    <address>
        <street>1A Main Street Business Estate</street>
        <city>Randomtown</city>
        <state>NY</state>
        <postcode>12345</postcode>
        <country>USA</country>
    </address>
</info>

The benefit of this approach is that, if needed, you can reference each part of the address in other topics.

If you enter the address as regular text, the structure is much simpler:

<info>
    <title>Acme 100X user guide</title>
    <address>
        1A Main Street Business Estate
        Randomtown
        NY
        12345
        USA
    </address>
</info>

With this simpler approach, you can only reference the entire address in other topics.

Note

The address element is a verbatim element and so preserves any formatting and line breaks. But if it is referenced by a dynamic variable, the dynamic variable will insert the address content as plain text with no formatting.

Authorgroup

Use as a container for author elements when you want to list more than one author. You can then add multiple author elements inside the authorgroup. This is an optional element that is supported in PDF and HTML outputs.

Example 22. Authorgroup, author, and orgname structure

The following code shows an example of the structure needed if you are using authorgroup to contain details of multiple authors. The authorgroup element has to be inside the info element, at the same level as other info elements such as title. The author elements are then nested inside the authorgroup element.

<info>
<title>Acme 100X user guide</title>
<authorgroup>
    <author>
        <personname>Richard Greenwood</personname>
    </author>
    <author>
        <personname>Leanne Matthews</personname>
    </author>
</authorgroup>
</info>

To name an organization as the author rather than an individual, use the orgname element:

<info>
    <title>Acme 100X user guide</title>
    <authorgroup>
    	<author>
        	<orgname>Acme Enterprises</orgname>
    	</author>
    </authorgroup
</info>
Author

Use to add the name of the author to a document. You can enter the name manually or use a variable. This is an optional element that is supported in PDF and HTML outputs.

For examples of the structure for author elements, see Authorgroup.

Edition

Use to add information about the version of the document. We recommend that you use edition instead of volumenum for this type of information. This is an optional element that is supported in PDF output.

Example 23. Edition structure

Use the edition element inside the info element, along with any other info elements such as title. The structure should look like this and you can enter the edition information directly into the edition element.

<info>
    <title>Acme 100X user guide</title>
    <edition>Acme 100x/PBD-10003</edition>
</info>

By default, when you publish to PDF, the edition is shown with the word "Edition" after it. The "Edition" is an auto-label and you can remove it by changing the auto-label setting in the PDF layout (see Set Auto-Labels for Info Elements).

Othercredit

Use to credit a person other than the author or editor. This is an optional element that is supported in HTML output.

Example 24. Other credit structure

To use the othercredit element, add it inside the info element alongside other top-level info elements such as title. Inside the othercredit element, add a child element to contain the credit information, for example, you could add personname (other child elements are available).

The structure should look like this:

<info>
    <title>Acme 100X user guide</title>
    <othercredit>
        <personname>Sara Card</personname>
    </othercredit>
</info>
Releaseinfo

Use to provide a brief description of a publication release. For example, the release information may explain that the document is for a particular version of a product. This is an optional element that is supported in PDF and HTML outputs.

Example 25. Release info structure

To use the releaseinfo element in a publication topic, add it inside the info element alongside any other info elements such as title. You can then add the release details directly inside the releaseinfo element.

<info>
    <title>Acme 100X user guide</title>
    <releaseinfo>Documentation update to include added humidity controls.</releaseinfo>
</info>
Revhistory

Use to add a table that contains a row for each revision to the document. You can add revisions to the list manually, and include information about the changes you have made. This is an optional element that is supported in PDF and HTML outputs.

Although revhistory is an "info" element, you should not use it in the publication topic. Instead, you should create a regular topic for the revision history and add an info element to it, and then add the revhistory and revision elements inside that. For details see Revision History Topic.

Order of Info Elements

By default, Paligo uses a fixed order for the elements in publication topics. When you publish, Paligo will present the elements in this order:

  1. title

  2. subtitle

  3. mediaobject

  4. authorgroup

  5. author - This is added as a child of the authorgroup element.

  6. volumenum

  7. pubdate

  8. edition

  9. abstract

  10. copyright

  11. legalnotice

  12. address

  13. releaseinfo

Any other info elements that you add will appear in the same order that they are shown in the publication topic. Child elements are shown in order after their parent, for example, personname will appear as a child of the author element, so will appear before volumenum.

To change the order for an HTML output, create a custom JavaScript that will move the elements. Then upload the JavaScript file to your HTML layout and publish again (see Upload Customized JavaScript).

For PDF outputs, you can set Paligo to use a free order instead of fixed (see Set the Order of Info Elements). With a free order, the info elements are shown in the same order that they appear in the publication topic .

Example Publication Topic Structure

To help you understand the correct structure for the info elements, we have included a sample publication topic. The example shows the underlying XML so that you can see how the various info elements, such as copyright and pubdate, are structured and positioned inside the info element.

To learn how to add and remove info elements in your own publication topics, see Edit a Publication Topic.

Example 26. Publication topic example

Here is an example of an entire publication topic. Note that we have removed the XML IDs so that the structure is clearer to view. When you create your own publication topic, you will have XML IDs included as well as other XML data.

<?xml version="1.0"?>
<article>
    <info>
        <title>Acme HomeHub User Guide</title>
        <subtitle>The smarter way to manage your home</subtitle>
        <mediaobject role="titleimage">
            <imageobject>
                <imagedata fileref="UUID-4352d337-29fd-6ee2-e88c-e04bed3ce898" xinfo:image="UUID-4352d337-29fd-6ee2-e88c-e04bed3ce898"/>
            </imageobject>
        </mediaobject>
        <volumenum>ACME-SH-123456-A1</volumenum>
        <edition>ACME 100X PBD-10003</edition>
        <pubdate>May 17 2022</pubdate>
        <copyright>
            <year>2022</year>
            <holder>Acme Enterprises</holder>
        </copyright>
        <legalnotice>
            <para>All pertinent state, regional, and local safety regulations must be observed when installing and using this product. For reasons of safety and to help ensure compliance with documented system data, only the manufacturer shall perform repairs to components. Failure to observe this information can result in injury or equipment damage.</para>
            <para>All rights reserved. No part of this publication may be reproduced, distributed, or transmitted in any form or by any means, including photocopying, recording, or other electronic or mechanical methods, without the prior written permission of the publisher. For permission requests, write to the publisher, addressed “Attention: Permissions Coordinator,” at the address below.</para>
        </legalnotice>
        <address>Acme Enterprises
            <street>1A Main Street</street>
            <city>Generic City</city>
            <postcode>123 456</postcode>
            <country>USA</country>
        </address>
        <authorgroup>
            <author>
                <personname>Richard Greenwood</personname>
            </author>
            <author>
                <personname>Leanne Matthews</personname>
            </author>
                 <orgname>Acme Enterprises</orgname>
            <author>
            </author>
        </authorgroup>
        <releaseinfo>v16.1 release includes documentation for humidity monitoring and controls, extended range of supported lighting systems, and how to order replacement parts.</releaseinfo>
        <abstract>
          <para>Learn how to use the Acme SmartHome hub to manage your household devices from your phone.</para>
        </abstract> 
</info>
</article>
Display a Publication Topic

By default, the publication contains an article element, an info element, and then inside that, several other elements, including subtitle, copyright, and publication date. We use the term "info elements" to refer to these lower-level elements collectively, as these type of elements must all be inside the info element. Learn about the info elements, see Supported Info Elements.

You can make changes to the publication topic so that it meets your requirements, see Edit a Publication Topic and Images in a Publication Topic.

To display the publication topic for one of your publications:

  1. Select the Dotted Menu (...) for the publication in Content Manager.

  2. Select Edit and choose Open in editor.

    Paligo opens the publication topic.

Edit a Publication Topic

When you create a publication, Paligo adds some commonly used "info elements" to the publication topic, such as copyright and pubdate. There are other elements that you can add too, including authorgroup, author and edition.

If you do not want a Publication Topic to be clickable in the TOC sidebar or Breadcrumb Homepage Link, see Make Topics Non-clickable Labels (HTML5).

Tip

To help you understand the correct structure for a publication topic, we have included a sample, see Example Publication Topic Structure. The sample shows the XML for a valid publication topic and includes many of the available info elements.

To edit a publication topic:

  1. Establish which elements you want to include or exclude, see Supported Info Elements.

  2. Select the Dotted Menu (...) for the publication in Content Manager.

  3. Select Edit and choose Open in editor.

    Paligo opens the publication topic.

  4. Remove elements not needed.

  5. Position the cursor where the new element is to be inserted inside the info element.

  6. Press Alt + Enter ⏎ (Windows) or Command ⌘ + Enter ⏎ (Mac) to display the Element Context Menu.

  7. Scroll down the menu and add needed elements.

    The menu provides access to all of the valid elements for the selected position. While the elements are valid, Paligo does not make use of them all and some may be excluded from the output. You should only use the elements that are supported (see Supported Info Elements).

    Note

    For some elements, you will need to apply a certain structure, for example, if you want to credit multiple authors, you will need to use authorgroup and author elements. Other elements, such as copyright, have additional child elements, such as year and holder. See the examples for details.

  8. When you add an element, it is empty by default. You need to define the value that is going to be shown in the output. This could be:

    • Regular text - This is known as "hard coding" as the text is added to the topic and to change it, you would need to edit the topic.

    • Variable - These are containers for text that is defined elsewhere (in a variable set). The benefit of this approach is that you can use a variable set to modify or change multiple publications from one place. There is no need to edit each publication separately. To find out more, see Variables in Paligo.

    • Dynamic variable - These are special types of variable that take their value from either the client session or from other elements in your content. For example, you could set the copyright year to always use the year that the publication was published. To find out more, see Dynamic Text Variables.

    • An image file (for mediaobject structure).

    Note

    For the pubdate element, you can set Paligo to insert the date automatically. For details, see Change Publication Date and Time Format (PDF).

  9. Select Save.

  10. If you are publishing to PDF, check that the element(s) are set to be included in the output when published.

    1. Select Layout in the top menu.

      Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

    2. Select the Layout you want to update or Create a Layout.

      Tip

      You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

    3. Select Front page in the sidebar.

    4. Select Info elements.

    5. Make sure that the appropriate Render <element name> element on this side of the front cover setting has a value of recto (front page) or verso (reverse side).

      Note

      Some elements are set to none by default, meaning that they will not be included in the output unless you change them to recto or verso.

    6. Select Save.

Tip

When you publish your publication, it will include the info elements. To learn how to style the info elements, such as setting font colors and positioning content on the front cover or on the reverse side, see:

  • Style the Info Elements

  • Style with CSS - For HTML outputs, create a custom CSS file with styles to define the look and feel that you want, then upload it to the HTML layout and publish it again.

Remove Info Elements

Most of the elements in a publication topic are optional, so you can add and remove elements to design a publication topic to meet your requirements. For any elements that you do not want to use, select the element in the main flow of the text, and then select it in the element structure menu. From the menu that appears, select Delete.

Note

If you remove an element that is required, Paligo will warn you about this when you save the topic. You will see the message in a pop-up dialog and also in the Validation panel. You will only get the invalid content message if validation is enabled in your editor (see Validation).

Images in a Publication Topic

By default, the publication topic contains the structure for a single image. The image will automatically be used as the Product Image on the front page, as its mediaobject has a role attribute with titleimage as the value. Only the structure for the image is in place, so you will see a red question mark. To insert an image into the existing structure, see Add Image to Publication Topic.

The image structure consists of:

<mediaobject role=“titleimage”>
    <imageobject>
        <imagedata/>
    </imageobject>
</mediaobject>

You can also insert additional images in the publication topic, either by using the Insert > Image option or by dragging and dropping an image from your desktop onto the topic.

When you add new images, they use the regular mediaobject > imageobject > imagedata structure and do not have a role set. They will appear after the product image, in the order they appear in your topic. They are not affected by the product image styles in the layout or any CSS.

Important

Only one image in the publication topic can have the role attribute value set to titleimage.

If multiple images have this value, they will appear stacked on top of each other in the same position in PDF output.

You can turn a foreground image into a background image for the cover by adding the role attribute with the value bg-image, see Methods for Adding a Background Image to a Cover.

Tip

When you have added an image and set it as the product image, you can control its styling in the output by using the layout settings (PDF) or CSS (HTML). For details, see:

Miscellaneous Block Element Styling (PDF)

The PDF Layout has a Miscellaneous Block Elements category with settings for styling certain block elements, including address, literallayout, and legalnotice.

Style the Address (PDF)

Use the PDF Layout's Miscellaneous block elements settings to style the text that appears inside an address element. There is an Address category that contains a variety of styling options.

To style the Address category for PDF output:

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Miscellaneous block elements in the sidebar.

  4. Select address.

  5. Use Font-family to choose the typeface for the text.

  6. Use Font size to control the size of the lettering.

  7. Use Font weight to set the thickness of the characters.

    Note

    Some fonts do not support all of the weight options.

  8. Use Font style to add or remove emphasis styling from the text. Choose Normal for regular text, Italic for forward leaning text, or Backslant for backwards-leaning text.

    Note

    Using Backslant can produce poor results, as many fonts do not support it as a separate outline.

  9. Set the Font variant to normal for regular sized, mixed case letters or small-caps for smaller, upper-case letters.

  10. Use Text transform to capitalize the text. Choose from:

  11. Set the Letter spacing.

  12. Use Hyphenate to control how words wrap at the end of a line.

  13. Scroll down to Color to apply a custom color to the text inside the element.

  14. Clear the Use default color checkbox to select a color of your own choice.

  15. Set the color either by:

    • Entering an RGBA code for the color you want (1).

    • Selecting the Color square to display the color selector (2).

      1. Choose the color with the spectrum bar (3).

      2. Control the transparency with the opacity bar (4).

      3. Choose the color shade with the main color panel (5).

  16. Use the Background color setting to apply a custom color to the background of the block.

    Clear the Use default color checkbox and then use the color selector to choose your custom color.

  17. Set the styling for the border.

    • Enter a Border-width to define the thickness of the border line. Enter a value and its units of measurement, for example, 3pt or 0.3cm.

      Leave the field empty if you do not want a border.

    • Select a Border style from the list.

    • Use the Border color setting to apply a custom color to the border.

      Clear the Use default color checkbox and then use the color selector to choose a color.

  18. Use the Padding settings to set the amount of space inside the border of the block.

    • Use Padding-start to set the left-side spacing.

    • Use Padding-end to set the right-side spacing.

    • Use Padding-top to set the spacing above the text.

    • Use Padding-bottom to set the spacing below the text.

    For each setting, enter a value and its units of measurement, for example, 1.2em.

  19. Use the margin settings to set the amount of space around the block. There is a separate setting for each side: Margin-left, Margin-right, Margin-top, Margin-bottom.

    Enter a value and its units of measurement, for example, 1.2em or 6pt.

  20. Use the space settings to control the amount of space above and below the element block.

    The Space-before.optimum is for the space above and the Space-after.optimum is for the space below. Enter a value and its units of measurement, for example, 1.2em or 6pt.

    Note

    These are different to margin settings, as they define a maximum amount of space. For example, if you have an element with a space-after.optimum of 4pt and the next element has a space-before.optimum of 4pt, the space is 4pt. It works as a maximum amount of space, not a sum total.

    Also, Space-before.optimum and Space-after.optimum are normally ignored at the boundary of pages and columns.

  21. Select Save.

When you publish with this Layout, Paligo will apply the settings to the address element in your content.

Style Literallayout Elements (PDF)

Use the PDF Layout's Miscellaneous block elements settings to style the text that appears inside a literallayout element. There is a literallayout category that contains a variety of styling options.

To style the literallayout category for PDF output:

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Miscellaneous block elements in the sidebar.

  4. Select literallayout.

  5. Use Font-family to choose the typeface for the text.

  6. Use Font size to control the size of the lettering.

  7. Use Font weight to set the thickness of the characters.

    Note

    Some fonts do not support all of the weight options.

  8. Use Font-style to add or remove emphasis styling from the text. Choose Normal for regular text, Italic for forward leaning text, or Backslant for backwards-leaning text.

    Note

    Using Backslant can produce poor results, as many fonts do not support it as a separate outline.

  9. Set the Font variant to normal for regular sized, mixed case letters or small-caps for smaller, upper-case letters.

  10. Use Text transform to capitalize the text. Choose from:

  11. Set the Letter spacing.

  12. Use Hyphenate to control how words wrap at the end of a line.

  13. Scroll down to Color to apply a custom color to the text inside the element.

  14. Clear the Use default color checkbox to select a color of your own choice.

  15. Set the color either by:

    • Entering an RGBA code for the color you want (1).

    • Selecting the Color square to display the color selector (2).

      1. Choose the color with the spectrum bar (3).

      2. Control the transparency with the opacity bar (4).

      3. Choose the color shade with the main color panel (5).

  16. Use the Background color setting to apply a custom color to the background of the block.

    Clear the Use default color checkbox and then use the color selector to choose your custom color.

  17. Set the styling for the border.

    • Enter a Border-width to define the thickness of the border line. Enter a value and its units of measurement, for example, 3pt or 0.3cm.

      Leave the field empty if you do not want a border.

    • Select a Border style from the list.

    • Use the Border color setting to apply a custom color to the border.

      Clear the Use default color checkbox and then use the color selector to choose a color.

  18. Use the Padding settings to set the amount of space inside the border of the block.

    • Use Padding-start to set the left-side spacing.

    • Use Padding-end to set the right-side spacing.

    • Use Padding-top to set the spacing above the text.

    • Use Padding-bottom to set the spacing below the text.

    For each setting, enter a value and its units of measurement, for example, 1.2em.

  19. Use the margin settings to set the amount of space around the block. There is a separate setting for each side: Margin-left, Margin-right, Margin-top, Margin-bottom.

    Enter a value and its units of measurement, for example, 1.2em or 6pt.

  20. Use the space settings to control the amount of space above and below the element block.

    The Space-before.optimum is for the space above and the Space-after.optimum is for the space below. Enter a value and its units of measurement, for example, 1.2em or 6pt.

    Note

    These are different to margin settings, as they define a maximum amount of space. For example, if you have an element with a space-after.optimum of 4pt and the next element has a space-before.optimum of 4pt, the space is 4pt. It works as a maximum amount of space, not a sum total.

    Also, Space-before.optimum and Space-after.optimum are normally ignored at the boundary of pages and columns.

  21. Select Save.

When you publish with this Layout, Paligo will apply the settings to the literallayout element in your content.

Style Legalnotice Elements (PDF)

Use the PDF Layout's Miscellaneous block elements settings to style the text that appears inside a legalnotice element. There is a legalnotice category that contains a variety of styling options.

To style the legalnotice category for PDF output:

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Miscellaneous block elements in the sidebar.

  4. Select legalnotice.

  5. Use Font-family to choose the typeface for the text.

  6. Use Font size to control the size of the lettering.

  7. Use Font weight to set the thickness of the characters.

    Note

    Some fonts do not support all of the weight options.

  8. Use Font-style to add or remove emphasis styling from the text. Choose Normal for regular text, Italic for forward leaning text, or Backslant for backwards-leaning text.

    Note

    Using Backslant can produce poor results, as many fonts do not support it as a separate outline.

  9. Set the Font variant to normal for regular sized, mixed case letters or small-caps for smaller, upper-case letters.

  10. Use Text transform to capitalize the text. Choose from:

  11. Set the Letter spacing.

  12. Use Hyphenate to control how words wrap at the end of a line.

  13. Scroll down to Color to apply a custom color to the text inside the element.

  14. Clear the Use default color checkbox to select a color of your own choice.

  15. Set the color either by:

    • Entering an RGBA code for the color you want (1).

    • Selecting the Color square to display the color selector (2).

      1. Choose the color with the spectrum bar (3).

      2. Control the transparency with the opacity bar (4).

      3. Choose the color shade with the main color panel (5).

  16. Use the Background color setting to apply a custom color to the background of the block.

    Clear the Use default color checkbox and then use the color selector to choose your custom color.

  17. Set the styling for the border.

    • Enter a Border-width to define the thickness of the border line. Enter a value and its units of measurement, for example, 3pt or 0.3cm.

      Leave the field empty if you do not want a border.

    • Select a Border style from the list.

    • Use the Border color setting to apply a custom color to the border.

      Clear the Use default color checkbox and then use the color selector to choose a color.

  18. Use the Padding settings to set the amount of space inside the border of the block.

    • Use Padding-start to set the left-side spacing.

    • Use Padding-end to set the right-side spacing.

    • Use Padding-top to set the spacing above the text.

    • Use Padding-bottom to set the spacing below the text.

    For each setting, enter a value and its units of measurement, for example, 1.2em.

  19. Use the margin settings to set the amount of space around the block. There is a separate setting for each side: Margin-left, Margin-right, Margin-top, Margin-bottom.

    Enter a value and its units of measurement, for example, 1.2em or 6pt.

  20. Use the space settings to control the amount of space above and below the element block.

    The Space-before.optimum is for the space above and the Space-after.optimum is for the space below. Enter a value and its units of measurement, for example, 1.2em or 6pt.

    Note

    These are different to margin settings, as they define a maximum amount of space. For example, if you have an element with a space-after.optimum of 4pt and the next element has a space-before.optimum of 4pt, the space is 4pt. It works as a maximum amount of space, not a sum total.

    Also, Space-before.optimum and Space-after.optimum are normally ignored at the boundary of pages and columns.

  21. Select Save.

When you publish with this Layout, Paligo will apply the settings to the legalnotice element in your content.

Publication Topics for Subpublications

Every publication in Paligo has a Publication Topic that acts as a container for the front page. It is usually set up to include an image for the front cover, details about the author, copyright information and similar content, see Supported Info Elements. This also applies to subpublications, which are publications reused as sections inside a parent publication.

In the image shown below, there is the main publication named "ACME Smart Home" and it contains a mixture of topics and subpublications. Each publication and subpublication has its own "publication topic".

  • For PDF outputs, Paligo only includes a publication topic for the top-level publication (the main publication). It excludes the publication topics for any subpublications so that the "front matter" only exists at the start of the PDF file.

  • For HTML outputs, you can choose whether the output includes publication topics for both the top-level publication and the subpublications OR only for the top-level publication.

Note

A reused publication (subpublication) gets a different symbol in the publication structure.

Choose Publication Topic Behavior

For HTML outputs, you can choose whether the output include publication topics for both the top-level publication (main publication) and the subpublications OR only include a publication topic for the top-level publication (parent publication).

Before you can adjust the layout settings, you have to Create a Layout.

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select General.

  4. Use Create a title topic for reused publications to control whether publication topics are included for subpublications for HTML5.

    • Choose Enable to include a publication topic for both the main publication and each sub-publication.

    • Choose Disable to only include a publication topic for the main publication. The publication topics for subpublications will be excluded.

    Important

    This setting needs to be enabled for the filtering to work for the parent publication.

    Tip

    For HTML this setting is called Create a topic for reused publications.

  5. Use Only create topic for reused publications if no top-level topic to include or exclude the publication topics.

    • Choose Enable to use the top-level topic as a publication topic for the subpublications.

      If enabled, you must remember to link to a topic in the subpublication, not to the subpublication itself.

    • Choose Disable to use the regular publication topic for the subpublications.

    Note

    Paligo ignores this setting if your content does not match the criteria for the scenario. This setting requires that you have:

    • Enabled Create a title topic for reused publications.

    • Reused a publication that contains one top-level topic and the rest are nested low-level topics.

      Example shows "Acme Smart Home" publication has a subpublication. The subpublication has a single top-level topic called "Lighting". The other topics in the subpublication are nested at a lower level.

  6. Select Save.

Style the Subtitle for a Cover

By default, a publication topic contains a subtitle element that you can use to add a secondary title for a document. When the subtitle is in place, you can style it by using the settings in a PDF layout. There are various settings for margins, font style, size and color.

Note

If your publication does not have a subtitle, you can edit your publication topic and add the subtitle element and text (see Edit a Publication Topic).

To style the subtitle for a front cover:

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Front page in the sidebar.

  4. Select Subtitle.

  5. Use Display a single language subtitle to set the subtitle to appear in a single language or in many languages.

  6. Set the position for the subtitle in relation to the content area.

    Use:

    • Subtitle margin left to set a left indent for the subtitle. This indent applies when the subtitle is set to align to the left.

    • Subtitle margin right to set a right indent for the subtitle. This indent applies when the subtitle is set to align to the right side of the content area.

  7. Set the spacing for the subtitle:

    Use:

    • Space-before front cover subtitle to set the amount of space above the subtitle.

    • Space-after front cover subtitle to set the amount of space below the subtitle.

    For both settings, enter a value and its units of measurement.

    You can use absolute values, such as 1.2em or 6pt, or you can use relative values, for example, 110%. Relative values are calculated as a percentage of the main body font size.

  8. Use Font family for front cover subtitle to choose the typeface for the subtitle text.

  9. Set the Font size for the front cover subtitle.

  10. Set the Font weight for front cover subtitle. This sets the boldness of the font and the effect varies depending on what font-family is used.

  11. Use Font style for front cover subtitle to add or remove emphasis styling from the subtitle text. Choose Normal for regular text, Italic for forward leaning text, or Backslant for backwards-leaning text.

    Note

    Using Backslant can produce poor results, as many fonts do not support it as a separate outline.

  12. Set the Font variant for front cover subtitle to normal for regular sized, mixed case letters or small-caps for smaller, upper-case letters.

  13. Set the Capitalization for front cover subtitle. This controls whether characters are shown in upper case, lower case, or a combination of the two.

    Note

    If the Font variant for front cover subtitle is set to small-caps, and you choose Capitalize, the entire subtitle will be in capital letters. The first letters of each word will be larger.

  14. Set the Letter spacing for front cover subtitle. This is the amount of horizontal spacing between each letter.

    To increase the amount of spacing, enter:

    • A relative amount and units of measurement, for example, 0.2rem.

    • An absolute amount and units of measurement, for example, 1px.

    To decrease the amount of spacing, enter a negative relative or absolute amount, for example, -1px.

  15. Use Color for front cover subtitle to apply a custom color to the text in the subtitle.

    1. Clear the Use default color checkbox to select a color of your own choice.

    2. Set the color either by:

      • Entering an RGBA code for the color you want (1).

      • Selecting the Color square to display the color selector (2).

        1. Choose the color with the spectrum bar (3).

        2. Control the transparency with the opacity bar (4).

        3. Choose the color shade with the main color panel (5).

  16. Set the Alignment for front cover subtitle.

    Choose from:

  17. Select Save.

When you use this Layout to publish to PDF, Paligo will apply the settings you have chosen.

Style the Title for the Front Cover (PDF)

To style the title on a front cover for PDF outputs, use the PDF Layout settings.

In the Front page category, there are two subcategories of settings for styling the title:

Position the Title on the Front Cover

To control the position of the title on the front cover:

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Front page in the sidebar.

  4. Select Title block.

  5. Use Border for title block to add a border around the edges of the title block. A border can be useful as a temporary guide when you are setting the margins. It makes it is easier to judge the distances for margins.

    Enter the line thickness followed by the line style and color, for example, 3pt dotted green.

  6. Set the position of the title block on the front cover.

    Note

    We recommend that you read Understanding the Front Cover Margins before you set any title margins. There, you can learn how to calculate the margins for your content, taking into consideration any page margins and body margins that are already in place.

    Use these settings to set the position:

    • Title block distance from top - Use to set the distance from the top of the content area to the start of the title block.

    • Title block margin left - Use to set the distance from the left edge of the content area to the left edge of the title block.

    • Title block margin right - Use to set the distance from the right edge of the content area to the right edge of the title block.

    For each setting, enter the value and include the units of measurement, for example, 3.5cm.

  7. Select Save.

When you publish with this Layout, Paligo will apply the title block settings that you have chosen.

Style the Horizontal Rule Under the Title

You can choose to have a horizontal rule under the title on your front cover. For this, use the Title block settings in your PDF Layout. You can also set the line's thickness and color.

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Front page in the sidebar.

  4. Select Title block.

  5. Use the following settings to style a horizontal rule under the title:

    • Width of horizontal rule under title - If you want a horizontal line under the title, enter the line thickness, for example, 3pt.

    • Color of horizontal rule under title - Use to set the color of the horizontal line under the title.

      1. Clear the Use default color checkbox to select a color of your own choice.

      2. Set the color either by:

        • Entering an RGBA code for the color you want (1).

        • Selecting the Color square to display the color selector (2).

          1. Choose the color with the spectrum bar (3).

          2. Control the transparency with the opacity bar (4).

          3. Choose the color shade with the main color panel (5).

  6. Select Save.

When you publish with this Layout, Paligo will apply the title block settings that you have chosen.

Style the Title

To style the title for a front cover:

  1. Select Layout in the top menu.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select Front page in the sidebar.

  4. Select Title.

  5. Use Display a single language title to set the title to appear in a single language or in many languages.

  6. Use Font family for front cover title to choose the typeface for the title text.

  7. Set the Font size for the front cover title.

  8. Set the Font weight for front cover title. This sets the boldness of the font and the effect varies depending on what font-family is used.

  9. Use Font style for front cover title to add or remove emphasis styling from the title text. Choose Normal for regular text, Italic for forward leaning text, or Backslant for backwards-leaning text.

    Note

    Using Backslant can produce poor results, as many fonts do not support it as a separate outline.

  10. Set the Font variant for front cover title to normal for regular sized, mixed case letters or small-caps for smaller, upper-case letters.

  11. Set the Capitalization for front cover title. This controls whether characters are shown in upper case, lower case, or a combination of the two.

    Note

    If the Font variant for front cover title is set to small-caps, and you choose Capitalize, the entire title will be in capital letters. The first letters of each word will be larger.

  12. Set the Letter spacing for front cover title. This is the amount of horizontal spacing between each letter.

    To increase the amount of spacing, enter:

    • A relative amount and units of measurement, for example, 0.2rem.

    • An absolute amount and units of measurement, for example, 1px.

    To decrease the amount of spacing, enter a negative relative or absolute amount, for example, -1px.

  13. Use Color for front cover title to apply a custom color to the text in the title.

    1. Clear the Use default color checkbox to select a color of your own choice.

    2. Set the color either by:

      • Entering an RGBA code for the color you want (1).

      • Selecting the Color square to display the color selector (2).

        1. Choose the color with the spectrum bar (3).

        2. Control the transparency with the opacity bar (4).

        3. Choose the color shade with the main color panel (5).

  14. Set the Alignment for front cover title.

    Choose from:

  15. Select Save.

When you use this Layout to publish to PDF, Paligo will apply the settings you have chosen.

Note

It is possible to make changes beyond those that are supported by the PDF layout. An XSLT developer can make changes by creating a customization. We can provide this as a professional service. For details, please contact customer support.