Publications

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.

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>

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>

Here, the text is typed in manually, but you could use a variable for the date if you prefer.

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:

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.

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:

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>

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>

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.

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>

If there is only one author, there is no need to use authorgroup:

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

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

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

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).

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>

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>