Skip to main content

XML Styling

Paligo can publish content as DocBook 5.1 XML. You can then use this in other systems and editors, just as if it were regular DocBook content.

To publish to XML, you need to create a Layout, in this case, an XML Layout. You can then edit the Layout and use it for publishing.

To edit an XML Layout:

  1. Select Layout in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

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

  2. Select the XML Layout you want to edit. Paligo displays it in the Layout Editor. Use the Layout Editor to set:

  3. Save the Layout.

When you publish your content, you can choose to use your XML Layout. Paligo will then generate an DocBook 5.0 XML version of your content, which will download in your browser. For details, see Publish as DocBook XML.

Include Link Text for XML

By default, when you publish to XML, Paligo includes the text for cross-references:

  • Resolved links

    Paligo can resolve the links between topics that are all included in the publication. It includes the XML for the links and also the text.

  • Unresolved links

    Paligo cannot resolve the links that are from topics in the publication to topics that are not included in the publication. For these links, Paligo includes the XML and adds a phrase element for each link. The text for the link is added inside the phrase element.

If you prefer, you can set Paligo to exclude the title of the link target. The XML for the links will remain in place, but the text and, in the case of unresolved links, the phrase element are removed. This can be useful if you import XML into Paligo and want the Paligo output to contain the same elements as the input.

  1. Select Layout in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

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

  2. Select the XML Layout that you are going to use for publishing.

  3. Select General.

  4. Set View links to:

    • Enable - If you want Paligo to include the text for links in the XML output.

    • Disable - If you want Paligo to remove the text for links (and the phrase element) in the XML output.

    • Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.

  5. Select Save.

When you publish with this Layout, Paligo will produce the XML output with link text shown or removed, depending on your choice.

Image Size for XML Output

When publishing to XML (DocBook), you may want to limit the images to a certain size, or perhaps have no images at all. To control the image size, use the Image Size setting on your XML Layout:

  1. Select Layout in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

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

  2. Select the XML Layout that you are going to use for publishing.

  3. Select Images.

  4. Set the Image size.

    You can choose from:

    • Do not include images

      Paligo will create an XML output that does not contain any images.

    • Use original images

      Paligo will keep the original size of the image files when it publishes the XML output.

    • Full size (2500 × 2500px, 120dpi)

    • Large (800 × 800px, 72dpi)

    • Medium (400 × 400, 72dpi)

    • Small (250 × 250px, 72dpi)

  5. Select Save.

When you publish with this Layout, Paligo will apply your chosen image size to the XML output.

Output Taxonomies for XML

By default, Paligo's XML output does not include taxonomy information. But if you require the attribute information, you can use the XML Layout to set Paligo to include taxonomy attributes in the XML.

  1. Select Layout in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

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

  2. Select the XML Layout that you are going to use for publishing.

  3. Select Classes and attributes in the sidebar.

  4. Set Output taxonomies to:

    • Enable - To include taxonomy information in the XML output. Paligo adds the information as an xinfo:taxonomy attribute on the section element, for example:

      xinfo:taxonomy="taxonomy_xml-cw_introduction_lvl0 selected-categories-1288332-1288330 "

    • Disable - To prevent Paligo from including any taxonomy information in the XML output.

    • Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.

  5. Select Save.

When you publish with this Layout, Paligo will include or exclude the taxonomy information in the XML output, depending on your choice.

Publish as DocBook XML

You can publish content to the DocBook 5.1 XML format. This is useful if you want to use your Paligo content in other systems or want to convert it into another type of XML, such as DITA.

When you publish to XML, Paligo produces a standard DocBook 5.1 XML output. You can use it as it is or you could get XSLT specialists to convert it into a different type of XML. The DocBook 5.1 output does not contain any metadata or information about text fragments and variables.

  1. Select the dotted menu (...) for the topic or publication in Content Manager.

    selectpublish.png

  2. Select Publish. Publish_button_small.png

    publish-document-jan23.png

    Paligo displays the Publish document dialog.

  3. Select the XML format in the Publish dialog.

    Publish document dialog. The XML output type is selected. A highlight box is around the XML option.

  4. Choose an XML Layout from the dropdown list.

  5. Select the languages to be published.

    Languages section of Publish document dialog. There are options for each language. English UK and Swedish are selected.

    Note

    If no translations are available, only the Source Language will show. If you have multiple languages translated and approved, you can select which ones to include. Paligo will publish each language as a separate output.

    For PDF output you can publish them as one multilingual publication, check the Combine selected languages box.

  6. Select Edit in the Profiling attributes section to apply Filtering / Profiling (Optional).

    If you do not want to apply a filter, leave the field blank.

    Profiling attributes dialog. Outputformat is set to include HTML.

    Select OK to add your chosen profiling attribute(s).

    Profiling attributes section of Publish document dialog. Shows Outputformat: HTML selected.

  7. Select Edit in the Variables section to apply Variables (Optional).

    If you do not want to apply a variable, leave the field blank.

    Variables dialog showing ACME 100 200 300 as variables and ACME 100 is set.

    Select OK to add the selected variables.

    Variables section of publish document dialog. The ACME 100 200 300 variable set is selected with the ACME 100 variant.

  8. Use the Upload output section to upload a zip file of the content to a repository, see Integrations.

  9. Use the Output filename section to control the filename.

    By default, Paligo will use the filename syntax that is defined in the System Settings.

    Output filename section. There is a Template field that contains the values ID, Title, and Format. In the top-right corner is a preview of the filename that Paligo will generate if the current settings are used.

    To change the information included in the filename, enter your preferred format in the publishing settings. Default is: ID-Title-Format.

    You can use:

    • ID - The ID of the document.

    • Title - The title of the publication or topic that you are publishing.

    • Format - The name of the output format, for example, PDF or HTML5.

    • Edit date - The date that the publication or topic was last edited.

    • Branch label - The text from the branch label for the publication or topic. This only applies if your content has been branched and it has a branch label. For details, see Add or Edit Branch Labels.

    • Unique value - A random string of characters, generated by Paligo, that is added to the filename to make it unique. This can stop the file from being overwritten by later publishes of the same document.

    Tip

    If you type @ into the field, Paligo displays a list of the available values and you can select from the list. To remove a value, click in it and use the delete key or backspace key to remove all of its characters.

    Note

    The filename shown in the top-right corner is a preview of the filename that Paligo will use when you publish.

  10. Set the Optional Parameters (leave unchecked if you do not want these features):

    • Save the output in Paligo - Check the box to save the zip file in the Resource View. Clear the box if you want Paligo only download the published output file in your browser.

      If you save the output in Paligo, you can download the zip file from the Resource Detail Panel for the publication or topic and then download the zip file from the Saved Outputs tab.

    • Email me - Check this box if you want Paligo to send you an email when the publication is ready. This is useful if you have very large publications that can take a longer time to process and publish.

    • Make debug build - Check this box if you want Paligo to include a log file and link report. If there is an issue with your content, Paligo support may ask you to enable this feature so that they can use the log files to investigate.

  11. Select Publish Document.

    Paligo starts processing your content and applies your layout and publishing settings. The time that this takes varies depending on how much content you are publishing (the more content, the longer it takes).

    Publish_Progress_Bar_small.jpg

    A progress bar appears. Select the arrow to hide the progress bar and reopen it by selecting the progress clock in the top menu. To abort the publish, select the X.

    The published output appears as:

    • A ZIP file with the published output appears in the downloads folder on your computer.

      If you have altered your browser's settings to store downloaded files somewhere else, the zip file will be found there instead.

      If you are using a publishing integration, the zip file will also be sent to the relevant service.

    • A link in the Activity Feed Panel to download the published content.

    Note

    To make the content available online, first unzip the file. You can then use the file locally or you can use an FTP client, such as Filezilla, to upload the unzipped content to a web server.

    Tip

    You can save your publishing settings and reuse them to achieve a smoother publishing process, see Publishing Settings. Any settings you save can also be used for Batch Publishing.

    Publish document dialog has a Save Settings option and a Saved Settings tab. The option saves the currently shown settings and these can then be selected in a single action on the tab.