Paligo Documentation

https://docs.paligo.net
Admin
Paligo provides documentation solutions, focusing on structured content authoring, collaboration,...
Tokens:72,552
Snippets:503
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Paligo procedure Example

Source: https://docs.paligo.net/en/quick-start

An example of a procedure in Paligo, used for sequential steps or instructions. It includes steps, optional substeps, and can contain titles and paragraphs.

```xml
<procedure>
    <title>An Example Procedure</title>
    <step>
        <para> A Step </para>
    </step>
    <step>
        <para> Another Step </para>
        <substeps>
            <step>
                <para> Substeps can be nested indefinitely deep. </para>
            </step>
        </substeps>
    </step>
    <step>
        <para> A Final Step </para>
    </step>
</procedure>
```

--------------------------------

### Configure Zendesk Guide Integration

Source: https://context7.com/context7/paligo_net/llms.txt

Settings for integrating with Zendesk Guide to publish help articles. This includes subdomain, API credentials, and destination category/section.

```json
zendeskConfig: {
  subdomain: "company",
  email: "api@company.com",
  apiToken: "***",
  category: "User Documentation",
  section: "Getting Started",
  locale: "en-us"
}
```

--------------------------------

### Set HTML5 Help Center Start Page Using Role Attribute

Source: https://docs.paligo.net/en/what-s-new-in-paligo-

Define the start page for your HTML5 Help Center output by enabling the 'Choose start page by role for HTML5 Help Center' setting and assigning the `role` attribute with the value `start-page` to the desired `section` element.

```html
<section role="start-page">
  ...
</section>
```

--------------------------------

### Unzip Paligo Content to Same Repository, Same Branch (Bitbucket Pipeline)

Source: https://docs.paligo.net/en/bitbucket-integration

This script unzips Paligo content to the current repository and branch. It requires `unzip` and `git` to be installed. The script finds all `.zip` files, unzips them, removes the `.zip` files, and commits the changes back to the target branch.

```yaml
image: php:7.2

pipelines:
    default:
        - step:
            script:
                - TARGET_BRANCH=$BITBUCKET_BRANCH
                - DESTINATION_FOLDER="."
                - apt-get update && apt-get install -y unzip git
                - cd $DESTINATION_FOLDER
                - FILE_COUNT=$(find ./ -name "*.zip" | wc -l)
                - if [[ $FILE_COUNT -gt 0 ]]; then
                - find ./ -name "*.zip" -exec unzip -o {} \;
                - rm *.zip
                - git add .
                - git commit -m "unzip the file from paligo and remove the zip file"
                - git push origin $TARGET_BRANCH
                - fi
```

--------------------------------

### Start Import Process (POST /v1/imports)

Source: https://context7.com/context7/paligo_net/llms.txt

Initiates an import process for content from a zip archive. Allows specifying the target folder and content type.

```APIDOC
## Start Import Process

### Description
Initiates an import process for content from a zip archive. Allows specifying the target folder and content type.

### Method
POST

### Endpoint
/v1/imports

### Parameters
#### Request Body
- **file** (file) - Required - The zip file containing the content to import. Use `"file=@import-package.zip"` in curl.
- **folder** (string) - Required - The ID of the target folder for the import.
- **type** (string) - Required - The type of content being imported (e.g., "docbook").

### Request Example
```bash
curl -X POST "https://api.paligo.net/v1/imports" \
  -H "Authorization: Bearer pk_live_abc123..." \
  -F "file=@import-package.zip" \
  -F "folder=folder-123" \
  -F "type=docbook"
```

### Response
#### Success Response (200)
- The response indicates the success of initiating the import process. Details may vary based on Paligo's implementation.
```

--------------------------------

### Comprehensive Table Styling Example

Source: https://docs.paligo.net/en/css-stylesheets-for-html-customization

An example demonstrating how to apply various styles to formal and informal tables, including borders, header background, body font size, cell alignment, and footer styling.

```css
/* Target table and informaltable, style the border around the edge of table, 
remove space after table but inside container div.  */

table.table,
table.table-bordered,
table.informaltable {

    /* table.table-bordered makes sure that we do not target tables that are used for layout, such as
        tables for image alignment.
  */

    /* remove space after table, inside div */
    margin-bottom: 0px !important;

     /* Your styles here */
    border: 2px solid #017efa !important;
}


 /* Target table and informaltable header, style the background color and text color */

.table thead, .informaltable thead {
	
    background-color: #017efa;
	color: white;
}


 /* Target table and informaltable body, style the font size */

.table tbody,
.informaltable tbody {

	 /* Your styles here */
	 font-size:8pt;
}


 /* Target table and informaltable row, style the font size */

.table tr, 
.informaltable tr {
         /* Your styles here */
	font-size: larger;
}


 /* Target all body and footer cells in table and informaltable, style the alignment */

.table td, 
.informaltable td {
          /* Your styles here */	
          text-align: center;
}

 /* Target all cells in header for table and informaltable, style the alignment */

.table th, 
.informaltable th {
          /* Your styles here */	
          text-align: center;
}


/* Target all cells in footer of table and informaltable, style the background color and text color */

.table tfoot td, .informaltable tfoot td {
	background-color: #FD1F9BBD;
	color: white;
}


/* Target all even rows in table and informaltable, style the background color */

.table tbody tr:nth-child(even),
.informaltable tbody tr:nth-child(even) {
   background-color: azure; /* Change to color of your choice */
}


/* Target internal borders of each cell in the header, body, footer of a formal table,
 style the cell borders */

.formaltable > tbody > tr > td,
 .formaltable > tbody > tr > th,
  .formaltable > tfoot > tr > td, 
  .formaltable > tfoot > tr > th, 
  .formaltable > thead > tr > td, 
  .formaltable > thead > tr > th {
	/* Your styles here */
        border: 1px solid #ddd;
}


/* Target internal borders of each cell in the header, body, footer of an informal table,
 style the cell borders */

.informaltable > tbody > tr > td,
 .informaltable > tbody > tr > th,
  .informaltable > tfoot > tr > td, 
  .informaltable > tfoot > tr > th, 
  .informaltable > thead > tr > td, 
  .informaltable > thead > tr > th {
	/* Your styles here */
        border: 1px solid #ddd;
}

```

--------------------------------

### Start Production (POST /v1/productions)

Source: https://context7.com/context7/paligo_net/llms.txt

Initiates a production process to generate output for a document in a specified format and layout. Supports multiple languages and notifications.

```APIDOC
## Start Production (production)

### Description
Initiates a production process to generate output for a document in a specified format and layout. Supports multiple languages and notifications.

### Method
POST

### Endpoint
/v1/productions

### Parameters
#### Request Body
- **document** (string) - Required - The ID of the document to produce.
- **format** (string) - Required - The output format (e.g., "html5", "pdf").
- **layout** (string) - Required - The ID of the layout to use.
- **languages** (array of strings) - Required - An array of language codes (e.g., ["en-US", "de-DE"]).
- **settings** (string) - Optional - The ID of the settings profile to use.
- **notify** (boolean) - Optional - Whether to send notifications upon completion.

### Request Example
```json
{
  "document": "doc-789",
  "format": "html5",
  "layout": "layout-modern",
  "languages": ["en-US", "de-DE"],
  "settings": "settings-default",
  "notify": true
}
```

### Response
#### Success Response (200)
- **productionId** (string) - The ID of the initiated production.
- **status** (string) - The initial status of the production (e.g., "processing").
- **started** (string) - The timestamp when the production started.

#### Response Example
```json
{
  "productionId": "prod-xyz789",
  "status": "processing",
  "started": "2025-10-11T15:00:00Z"
}
```
```

--------------------------------

### Paligo Topic Structure (section) Example

Source: https://docs.paligo.net/en/quick-start

Illustrates the structure of a 'topic' component in Paligo, represented by the 'section' element. This example shows a section containing a title, a figure with an image, and a detailed list of specifications.

```xml
<section>
  <title>The Engine</title>
  <figure>
    <title>Specifications</title>
    <mediaobject>
      <imageobject>
        <imagedata fileref="UUID-f8b27f8c-70ba-83d6-9223-3c1354c98047" width="400" xinfo:image="UUID-f8b27f8c-70ba-83d6-9223-3c1354c98047"/>
      </imageobject>
      <caption>
        <para>The vehicle is powered by a 3.2-litre straight-six engine (X55C33). The performance figures are:</para>
        <itemizedlist>
          <listitem>
            <para>3,246 cc displacements</para>
          </listitem>
          <listitem>
            <para>343 horsepower (256 kW) at 7,900 rpm</para>
          </listitem>
          <listitem xinfo:product="ACME 2000;ACME 5000">
            <para>269 lb·ft (365 N·m) of torque at 4,900 rpm, 8,000 rpm
              redline.</para>
          </listitem>
          <listitem xinfo:product="ACME 1500">
            <para>269 lb·ft (365 N·m) of torque at 4,900 rpm, 9,000 rpm redline.</para>
          </listitem>
          <listitem>
            <para>Acceleration to 60 mph (96 km/h) comes in 4.8 seconds. (0-62 mph
              / 100 km/h is 5.0) and top speed is limited electronically to 156 mph (251
              km/h)</para>
          </listitem>
          <listitem>
            <para>Output per litre is 95 bhp (80 kW; 108 PS), and power-to-weight
              ratio is 9.9 lb/bhp.</para>
          </listitem>
        </itemizedlist>
      </caption>
    </mediaobject>
  </figure>
</section>
```

--------------------------------

### Start Paligo Production (Production)

Source: https://context7.com/context7/paligo_net/llms.txt

Initiates a content production job in Paligo for generating output in a specified format and layout. Requires API authentication and specifies document, format, layout, languages, and settings.

```bash
curl -X POST "https://api.paligo.net/v1/productions" \
  -H "Authorization: Bearer pk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "document": "doc-789",
    "format": "html5",
    "layout": "layout-modern",
    "languages": ["en-US", "de-DE"],
    "settings": "settings-default",
    "notify": true
  }'
```

--------------------------------

### Start Paligo Import Process

Source: https://context7.com/context7/paligo_net/llms.txt

Initiates an import process in Paligo, uploading a specified zip file to a designated folder with a given type. This is used for bringing external content into Paligo.

```bash
curl -X POST "https://api.paligo.net/v1/imports" \
  -H "Authorization: Bearer pk_live_abc123..." \
  -F "file=@import-package.zip" \
  -F "folder=folder-123" \
  -F "type=docbook"
```

--------------------------------

### Configure Phrase Translation Integration

Source: https://context7.com/context7/paligo_net/llms.txt

Example configuration for integrating with the Phrase translation service. This includes project ID, source and target languages, and settings for automatic import and notifications.

```javascript
phraseIntegration: {
  projectId: "abc123",
  sourceLanguage: "en-US",
  targetLanguages: ["de-DE", "fr-FR", "es-ES"],
  autoImport: true,
  notifyOnComplete: true
}
```

--------------------------------

### Paligo orderedlist Example

Source: https://docs.paligo.net/en/quick-start

An example of an ordered list in Paligo, used for numbered lists. Items are marked with sequential symbols. Similar to itemized lists, it supports titles, paragraphs, and list items.

```xml
<orderedlist>
    <para>List of tools:</para>
    <listitem>
        <para>Hammer</para>
    </listitem>
    <listitem>
        <para>Screwdriver</para>
    </listitem>
    <listitem>
        <para>Drill</para>
    </listitem>
</orderedlist>
```

--------------------------------

### Exclude example from sidebar

Source: https://docs.paligo.net/en/how-to-use-the-api-style-output

To display an `example` or `informalexample` inline within the body content instead of the sidebar, add the `role` attribute set to "inline-example". Ensure your HTML5 layout is configured to output `role` attributes as class names.

```xml
<example role="inline-example">
  <title>Inline Example</title>
  <programlisting language="html">
&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;body&gt;
  &lt;h1&gt;Hello World&lt;/h1&gt;
&lt;/body&gt;
&lt;/html&gt;
  </programlisting>
</example>
```

--------------------------------

### Create Menu Choice and Keyboard Shortcut Instructions in XML

Source: https://docs.paligo.net/de/eine-sequenz-mit-ui-optionen-hinzuf%C3%BCgen

This XML snippet demonstrates how to structure content for user interface instructions, specifically for selecting menu items and using keyboard shortcuts. It utilizes elements like <para>, <menuchoice>, <guimenu>, <guimenuitem>, <shortcut>, <keycombo>, and <keycap> to define the UI interaction flow. The structure ensures Paligo can automatically format elements like arrows between menu items.

```xml
<para>When you have completed your design, select 
    <menuchoice>
        <guimenu><emphasis role="bold"><emphasis>File</emphasis></guimenu>
        <guimenuitem><emphasis role="bold"><emphasis>Save</emphasis></guimenuitem>
    </menuchoice>.
</para>
<para>Alternatively, use the keyboard shortcut: 
    <menuchoice>
        <shortcut>
            <keycombo>
               <keycap>Alt</keycap>
               <keycap>S</keycap>
            </keycombo>
        </shortcut>
    </menuchoice>
</para>
```

--------------------------------

### Example: XPath to Find 'remark' Elements

Source: https://docs.paligo.net/de/elemente-suchen

This is a practical example of an XPath query to find all 'remark' elements. This demonstrates the syntax for searching a single element type.

```xpath
//remark
```

--------------------------------

### ISO 690 Book Monograph Reference Example

Source: https://docs.paligo.net/en/references-to-a-monograph--book-or-similar-publication-

An example demonstrating a correctly formatted reference for a book monograph following the ISO 690 standard. This snippet illustrates the usage of required elements like biblioentry, author, title, publisher, pubdate, and biblioid for ISBN.

```XML
<biblioentry role="monograph">
  <abbrev>ISO690</abbrev>
  <author>
    <personname>
      <surname>Doe</surname>
      <firstname>Jane</firstname>
    </personname>
  </author>
  <title>The Art of Documentation</title>
  <edition>2nd</edition>
  <publisher>
    <publishername>Tech Press</publishername>
    <city>New York</city>
  </publisher>
  <pubdate>2023</pubdate>
  <date role="upd">2023-10-26</date>
  <date role="cit">2023-10-26</date>
  <biblioid class="isbn">978-3-16-148410-0</biblioid>
</biblioentry>
```

--------------------------------

### Paligo itemizedlist Example

Source: https://docs.paligo.net/en/quick-start

An example of an itemized list in Paligo, used for bulleted or unordered lists. Each item is marked with a symbol. It can contain a title, paragraph, and list items.

```xml
<itemizedlist>
    <para>List of tools:</para>
    <listitem>
        <para>Hammer</para>
    </listitem>
    <listitem>
        <para>Screwdriver</para>
    </listitem>
    <listitem>
        <para>Drill</para>
    </listitem>
</itemizedlist>
```

--------------------------------

### Productions API

Source: https://docs.paligo.net/en/paligo-rest-api

Endpoints for managing publishing productions, including starting new ones, listing recent productions, and downloading output.

```APIDOC
## Productions API

### Start New Production

### Method
POST

### Endpoint
/productions

### Description
Starts a new publication process (a "production").

### Parameters
#### Request Body
- **publication_id** (string) - Required - The ID of the publication to produce.
- **setting_id** (string) - Required - The ID of the publishing setting to use.

### Request Example
```json
{
  "publication_id": "pub-aaa",
  "setting_id": "pubset-111"
}
```

### Response
#### Success Response (201)
- **production_id** (string) - The unique identifier for the new production.
- **status** (string) - The initial status of the production (e.g., 'pending').

#### Response Example
```json
{
  "production_id": "prod-zzz",
  "status": "pending"
}
```

### List Recent Productions

### Method
GET

### Endpoint
/productions

### Description
Retrieves a list of recent production processes.

### Response
#### Success Response (200)
- **productions** (array) - A list of production objects, each containing:
  - **id** (string) - The unique identifier for the production.
  - **publication_id** (string) - The ID of the publication produced.
  - **setting_id** (string) - The ID of the publishing setting used.
  - **status** (string) - The current status of the production (e.g., 'completed', 'failed').
  - **created_at** (string) - The timestamp when the production was created.

#### Response Example
```json
{
  "productions": [
    {
      "id": "prod-zzz",
      "publication_id": "pub-aaa",
      "setting_id": "pubset-111",
      "status": "completed",
      "created_at": "2023-10-27T10:00:00Z"
    }
  ]
}
```

### Download Production Output

### Method
GET

### Endpoint
/productions/{production_id}/output

### Description
Downloads the output from a completed production.

### Parameters
#### Path Parameters
- **production_id** (string) - Required - The ID of the production whose output to download.

### Response
#### Success Response (200)
- **file** (file) - The output file (e.g., a zip archive).

#### Response Example
(Returns a file download, not JSON)
```

--------------------------------

### XML: Part of Monograph Bibliography Entry Example

Source: https://docs.paligo.net/en/references-to-parts-of-a-monograph

An example of an XML structure for a bibliography entry referencing a part of a monograph, such as a book chapter. It includes required elements like `abbrev`, author, section details, publisher information, and optional elements like `pagenums` and `biblioid`.

```XML
<biblioentry role="part">
    <abbrev>Rand18</abbrev>
    <author>
          <personname>
                <firstname>Sophia</firstname>
                <surname>Garcia</surname>
          </personname>
    </author>
    <editor>
        <personname>
            <surname>James</surname>
            <firstname>LP.</firstname>
        </personname>
    </editor>
    <orgname>Cosmic Industries</orgname>
    <bibliomisc role="secnum">12</bibliomisc>
    <bibliomisc role="sectitle">Navigating Celestial Trajectories</bibliomisc>
    <title>Advancements in Space Technology</title>
    <editor>Alex Johnson</editor>
    <pagenums>55-78</pagenums>
    <publisher>
        <publishername>General Press</publishername>
        <address>
            <city>London</city>
        </address>
    </publisher>
    <pubdate>2023</pubdate>
    <bibliomisc>Text in English and French</bibliomisc>
    <biblioid class="isbn">0-08-021680-3</biblioid>
</biblioentry>
```

--------------------------------

### Imports API

Source: https://docs.paligo.net/en/paligo-rest-api

Endpoints for managing import processes, including listing recent imports and starting new ones.

```APIDOC
## Imports API

### List Recent Imports

### Method
GET

### Endpoint
/imports

### Description
Retrieves a list of recent import processes.

### Response
#### Success Response (200)
- **imports** (array) - A list of import objects, each containing:
  - **id** (string) - The unique identifier for the import.
  - **source** (string) - The source of the import.
  - **status** (string) - The status of the import (e.g., 'completed', 'failed').
  - **created_at** (string) - The timestamp when the import was started.

#### Response Example
```json
{
  "imports": [
    {
      "id": "imp-777",
      "source": "external_system.xml",
      "status": "completed",
      "created_at": "2023-10-27T09:00:00Z"
    }
  ]
}
```

### Start New Import

### Method
POST

### Endpoint
/imports

### Description
Starts a new import process.

### Parameters
#### Request Body
- **source_url** (string) - Required - The URL of the content to import.
- **import_settings** (object) - Optional - Settings for the import process.

### Request Example
```json
{
  "source_url": "http://example.com/content.xml",
  "import_settings": {
    "target_folder_id": "folder-123"
  }
}
```

### Response
#### Success Response (201)
- **import_id** (string) - The unique identifier for the new import process.
- **status** (string) - The initial status of the import (e.g., 'pending').

#### Response Example
```json
{
  "import_id": "imp-888",
  "status": "pending"
}
```
```

--------------------------------

### DocBook XML for a Paligo Task

Source: https://docs.paligo.net/en/create-a-task

This snippet shows the DocBook XML structure for a task created in Paligo. It includes elements for the task title, summary, prerequisites, procedure steps, and related tasks. The structure adheres to the DocBook schema, with additional attributes for content management.

```xml
<?xml version="1.0"?>
<sidebar xmlns="http://docbook.org/ns/docbook" xmlns:xinfo="http://ns.expertinfo.se/cms/xmlns/1.0" xml:id="UUID-9fa6db45-2e2d-09b6-11f5-2bda3215f17b" version="5.0" xml:lang="en" xinfo:resource="UUID-9fa6db45-2e2d-09b6-11f5-2bda3215f17b" xinfo:resource-id="110111" xinfo:resource-type="component" xinfo:resource-subtype="informaltopic" xinfo:resource-title="Replace ACME 100 Battery" xinfo:resource-titlelabel="" xinfo:version-major="1" xinfo:version-minor="0">
  <task>
    <title xinfo:text="110123">Replace ACME 100 battery</title>
    <tasksummary>
      <para xinfo:text="110124">How to replace the battery in an ACME 100 device.</para>
    </tasksummary>
    <taskprerequisites>
      <para xinfo:text="110125">Prerequisites:</para>
      <itemizedlist>
        <listitem>
          <para xinfo:text="110126">ACME 100 replacement battery</para>
        </listitem>
        <listitem>
          <para xinfo:text="110127">ACME 100 unit key</para>
        </listitem>
      </itemizedlist>
    </taskprerequisites>
    <procedure xml:id="procedure-idm4679030963721632366065195995">
      <step>
        <para xinfo:text="110128">Use the ACME 100 unit key to unlock the 4 corner locks on the rear panel of the ACME 100. Turn the key anticlockwise to unlock.</para>
      </step>
      <step>
        <para xinfo:text="110129">Press the release latch and then gently pull the cover towards you.</para>
      </step>
      <step>
        <para xinfo:text="110130">Remove the battery from the ACME 100 device.</para>
      </step>
      <step>
        <para xinfo:text="110131">Insert the replacement battery, making sure that the positive and negative terminals of the battery are positioned correctly. The battery compartment has plus (positive) and minus (negative) markings to show the appropriate connections.</para>
      </step>
      <step>
        <para xinfo:text="110132">Close the hatch and make sure the latch clicks into place.</para>
      </step>
      <step>
        <para xinfo:text="110133">Use the ACME 100 unit key to lock the corner locks.</para>
      </step>
    </procedure>
    <taskrelated>
      <para xinfo:text="110152">See also:</para>

```

--------------------------------

### Paligo Publication Structure (article) Example

Source: https://docs.paligo.net/en/quick-start

Demonstrates the structure of a 'publication' component in Paligo, which uses the 'article' element. It primarily contains metadata within an 'info' element, such as title and author details.

```xml
<article>
    <info>
        <title>My Publication</title>
        <author>
            <orgname>Organization Name</orgname>
            <address>
                <city>City</city>
                <street>Street</street>
                <postcode>000000</postcode>
                <country>Country</country>
            </address>
            <email>user@example.com</email>
        </author>
    </info>
</article>
```

--------------------------------

### XML Structure for Publication Topic Info Elements

Source: https://docs.paligo.net/en/example-publication-topic-structure

This XML snippet demonstrates the complete structure of a publication topic, including various info elements such as title, subtitle, mediaobject, copyright, legalnotice, address, authorgroup, releaseinfo, and abstract. It serves as a template for creating well-structured documentation.

```xml
<?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>
```

--------------------------------

### Unzip Paligo Content to Different Repository, Same Project (Bitbucket Pipeline)

Source: https://docs.paligo.net/en/bitbucket-integration

This script handles unzipping Paligo content into a different repository within the same project. It requires `unzip` and `git`. The script unzips content to a temporary directory, commits it locally, and then prepares to clone the target repository. Note that the provided snippet is incomplete for cloning and pushing to the target repository.

```yaml
image: php:7.2

pipelines:
    default:
        - step:
            script:
                - DESTINATION_FOLDER="."
                - TARGET_REPOSITORY="paligo-publications"
                - TARGET_BRANCH="output"
                - BITBUCKET_NAME='John Doe'
                - BITBUCKET_USERNAME='johndoe'
                - BITBUCKET_USEREMAIL='john.doe@company.com'
                - apt-get update && apt-get install -y unzip git
                - cd $DESTINATION_FOLDER
                - FILE_COUNT=$(find ./ -name "*.zip" | wc -l)
                - if [[ $FILE_COUNT -gt 0 ]]; then
                - TMP_DIR=$(mktemp -d -t paligo-XXXXXXXXXX)
                - find ./ -name "*.zip" -exec unzip -d $TMP_DIR -o {} \;
                - rm *.zip
                - git add .
                - git commit -m "remove the zip file"
                - git push origin $BITBUCKET_BRANCH
                - sleep 1
                - CLONE_DIR=$(mktemp -d -t clone-XXXXXXXXXX)
                - cd $CLONE_DIR
```

--------------------------------

### XML Structure for Q&A Lists

Source: https://docs.paligo.net/en/add-sections-and-titles-to-q---a-lists

This XML snippet demonstrates the proper structure for creating question and answer lists using 'qandaset' and 'qandadiv' elements. Each 'qandadiv' contains a 'title' and multiple 'qandaentry' elements, where each 'qandaentry' holds a 'question' and 'answer'. This format is ideal for organizing FAQs or troubleshooting guides.

```xml
<?xml version="1.0"?>
<section>
  <title>ACME 100 Troubleshooting</title>
  <para>This article provides answers to some of the most common questions about ACME 100. To find an answer, go to the section that relates to your type of problem and then look to see if your question has been answered.</para>
    <qandadiv>
      <title>Battery Troubleshooting</title>
      <qandaentry>
        <question>
          <para>How long is the battery life?</para>
        </question>
        <answer>
          <para>With normal use, the battery should last around 10 hours before it needs recharging.</para>
        </answer>
      </qandaentry>
      <qandaentry>
        <question>
          <para>When will I need to replace the battery?</para>
        </question>
        <answer>
          <para>Typically, batteries last around 2 years with normal usage.</para>
        </answer>
      </qandaentry>
      <qandaentry>
        <question>
          <para>How do I get a replacement battery?</para>
        </question>
        <answer>
          <para>Batteries and chargers are available on our website.</para>
        </answer>
      </qandaentry>
    </qandadiv>
    <qandadiv>
      <title>Controls Troubleshooting</title>
      <qandaentry>
        <question>
          <para>How do I change the temperature controls?</para>
        </question>
        <answer>
          <para>Go to Controls &gt; Temp &gt; Limits to change the temperature limits for the automatic temperature controls. For manual temperature controls, go to Controls &gt; Temp &gt; Manual.</para>
        </answer>
      </qandaentry>
      <qandaentry>
        <question>
          <para>How do I control the vents?</para>
        </question>
        <answer>
          <para>Go to Controls &gt; Vents &gt; to open or close the vents. Note that you cannot control the vents if they are set to be automatically controlled (see Auto &gt; Vents).</para>
        </answer>
      </qandaentry>
    </qandadiv>
    <qandadiv>
      <title>Monitor Troubleshooting</title>
      <qandaentry>
        <question>
          <para>How do I monitor the temperature differences over a day?</para>
        </question>
        <answer>
          <para>Go to Dashboard &gt; Temp to view the temperature charts. You can set the charts for 1 day, 1 week, 1 month, or 1 year of data.</para>
        </answer>
      </qandaentry>
      <qandaentry>
        <question>
          <para>How do I monitor the effects of cooling?</para>
        </question>
        <answer>
          <para>Go to Dashboard &gt; Cooling to view the cooling charts. You can set the charts for 1 day, 1 week, 1 month, or 1 year of data.</para>
        </answer>
      </qandaentry>
    </qandadiv>
  </qandaset>
</section>
```

--------------------------------

### Configure Audio Preload Behavior

Source: https://docs.paligo.net/en/add-audio

Controls when the audio file is downloaded by the browser. Options include 'none' (download on playback start), 'auto' (download in advance), and 'metadata' (download only metadata). Default behavior often downloads only metadata.

```html
<multimediaparam name="controls" value="true"></multimediaparam>
<multimediaparam name="preload" value="auto"></multimediaparam>
```

--------------------------------

### Download Published Output (GET /v1/productions/{productionId}/download)

Source: https://context7.com/context7/paligo_net/llms.txt

Downloads the generated output for a completed production job. The output is typically a zip archive.

```APIDOC
## Download Published Output

### Description
Downloads the generated output for a completed production job. The output is typically a zip archive.

### Method
GET

### Endpoint
/v1/productions/{productionId}/download

### Parameters
#### Path Parameters
- **productionId** (string) - Required - The ID of the production whose output is to be downloaded.

### Response
#### Success Response (200)
- The response body will contain the binary content of the published output (e.g., a zip file).

### Response Example
(Binary content of output.zip)
```

--------------------------------

### Java Code Block using programlisting

Source: https://docs.paligo.net/en/quick-start

Illustrates the use of the 'programlisting' element to display a Java code block. This element preserves line breaks and spacing, suitable for code snippets. The example shows a simple Java program for calculating factorials.

```java
//This example is in itself using the programlisting element 
//to show the code below
public class Factorial
{
	public static void main(String[] args)
	{	final int NUM_FACTS = 100;
		for(int i = 0; i < NUM_FACTS; i++)
			System.out.println( i + "! is " + factorial(i));
	}
	
	public static int factorial(int n)
	{	int result = 1;
		for(int i = 2; i <= n; i++)
			result *= i;
		return result;
	}
}
```

--------------------------------

### XML Bibliography Structure Example

Source: https://docs.paligo.net/en/create-a-bibliography-as-a-separate-topic

This code snippet demonstrates the underlying XML structure of a valid bibliography topic using 'raw' entries. It includes various elements like title, bibliodiv, biblioentry, authorgroup, copyright, publisher, and biblioid, illustrating how different types of bibliographic information are organized.

```xml
<bibliography>
    <title>A Test Bibliography</title>
    <bibliodiv>
        <title>Books</title>
        <biblioentry>
            <abbrev>AhoSethiUllman96</abbrev>
            <authorgroup>
                <author>
                    <personname>
                        <firstname>Alfred V.</firstname>
                        <surname>Aho</surname>
                    </personname>
                </author>
                <author>
                    <personname>
                        <firstname>Ravi</firstname>
                        <surname>Sethi</surname>
                    </personname>
                </author>
                <author>
                    <personname>
                        <firstname>Jeffrey D.</firstname>
                        <surname>Ullman</surname>
                    </personname>
                </author>
            </authorgroup>
            <copyright>
                <year>1996</year>
                <holder>Bell Telephone Laboratories, Inc.</holder>
            </copyright>
            <editor>
                <personname>
                    <firstname>James T.</firstname>
                    <surname>DeWolf</surname>
                </personname>
            </editor>
            <biblioid class="isbn">0-201-10088-6</biblioid>
            <publisher>
                <publishername>Addison-Wesley Publishing Company</publishername>
            </publisher>
            <title>Compilers, Principles, Techniques, and Tools</title>
        </biblioentry>
        <biblioentry>
            <authorgroup>
                <author>
                    <personname>
                        <firstname>Andrea</firstname>
                        <surname>Bahadur</surname>
                    </personname>
                </author>
                <author>
                    <personname>
                        <firstname>Mark</firstname>
                        <surname>Shwarek</surname>
                    </personname>
                </author>
            </authorgroup>
            <copyright>
                <year>1974</year>
                <year>1975</year>
                <holder>Product Development International Holding N. V.</holder>
            </copyright>
            <biblioid class="isbn">0-88459-021-6</biblioid>
            <publisher>
                <publishername>Plenary Publications International, Inc.</publishername>
            </publisher>
            <title>Kites</title>
            <subtitle>Ancient Craft to Modern Sport</subtitle>
            <pagenums>988-999</pagenums>
        </biblioentry>
    </bibliodiv>
    <bibliodiv>
        <title>Periodicals</title>
        <biblioentry>
            <abbrev>Walsh97</abbrev>
            <biblioset relation="journal">
                <title>XML: Principles, Tools, and Techniques</title>
                <publisher>
                    <publishername>O'Reilly &amp; Associates, Inc.</publishername>
                </publisher>
                <biblioid class="issn">1085-2301</biblioid>
                <editor>
                    <personname>
                        <firstname>Dan</firstname>
                        <surname>Connolly</surname>
                    </personname>
                </editor>
            </biblioset>
            <biblioset relation="article">
                <title>A Guide to XML</title>
                <author>
                    <personname>
                        <surname>Walsh</surname>
                        <firstname>Norman</firstname>
                    </personname>
                </author>
                <copyright>
                    <year>1997</year>
                    <holder>ArborText, Inc.</holder>
                </copyright>
                <pagenums>97-108</pagenums>
            </biblioset>
        </biblioentry>
    </bibliodiv>
</bibliography>
```

--------------------------------

### Configure Freshdesk Integration

Source: https://context7.com/context7/paligo_net/llms.txt

Configuration details for integrating with Freshdesk to publish documentation. Requires domain, API key, and destination category/folder.

```json
freshdeskConfig: {
  domain: "company.freshdesk.com",
  apiKey: "***",
  category: "Documentation",
  folder: "User Guides"
}
```

--------------------------------

### Example: XPath for 'remark' within 'listitem'

Source: https://docs.paligo.net/de/elemente-suchen

This example shows how to search for 'remark' elements that are specifically nested within 'listitem' elements, illustrating parent-child searching.

```xpath
//listitem/remark
```

--------------------------------

### Publish Content using Bash and Profile Attributes

Source: https://context7.com/context7/paligo_net/llms.txt

This bash snippet illustrates the process of publishing content (publications or topics) from Paligo. It details the steps to initiate publishing, select output types (PDF, HTML5, SCORM, etc.), configure layouts, choose languages, apply profiling/filtering using attributes, and define output filenames with token customization.

```bash
# Publish a publication or topic
# 1. Select dotted menu (...) in Content Manager
# 2. Choose "Publish"
# 3. Configure publishing settings:

# Output Type Selection:
# - PDF (print output)
# - HTML5 (modern help center)
# - HTML (classic web output)
# - Word (DOCX)
# - DocBook XML
# - SCORM (eLearning/LMS)
# - Zendesk, Freshdesk, Salesforce Knowledge
# - JavaHelp, manpages (on request)

# Layout Configuration:
# Select layout with predefined settings for:
# - Page styling (PDF borders, breaks)
# - CSS/JavaScript files (HTML outputs)
# - Integration-specific options

# Language Selection:
# - Single language: Select one target language
# - Multiple languages: Check multiple (separate outputs)
# - PDF multilingual: Check "Combine selected languages"

# Profiling/Filtering (conditional text):
# Example: Include only content for expert users
profileAttributes: {
  audience: "Expert",
  outputformat: "PDF",
  product: "Acme 100"
}
# Leave blank to exclude filter
# Only matching content appears in output

# Output Filename Configuration:
# Default: ID-Title-Format
# Available tokens (type @ to see list):
outputFilename: "@ID-@Title-@Format-@EditDate-@BranchLabel-@UniqueValue"
# Example result: "12345-UserGuide-PDF-2025-10-11-v2.0-abc123.zip"
```

--------------------------------

### Unzip Paligo Content to Same Repository, Different Branch (Bitbucket Pipeline)

Source: https://docs.paligo.net/en/bitbucket-integration

This script unzips Paligo content to a different branch within the same repository. It utilizes a temporary directory for unzipping. Dependencies include `unzip` and `git`. The process involves unzipping to a temp dir, committing deletions, checking out the target branch, pulling changes, copying unzipped content, and pushing to the target branch.

```yaml
image: php:7.2

pipelines:
    default:
        - step:
            script:
                - TARGET_BRANCH="paligo-output"
                - DESTINATION_FOLDER="."
                - apt-get update && apt-get install -y unzip git
                - cd $DESTINATION_FOLDER
                - FILE_COUNT=$(find ./ -name "*.zip" | wc -l)
                - if [[ $FILE_COUNT -gt 0 ]]; then
                - TMP_DIR=$(mktemp -d -t paligo-XXXXXXXXXX)
                - find ./ -name "*.zip" -exec unzip -d $TMP_DIR -o {} \;
                - rm *.zip
                - git add .
                - git commit -m "remove the zip file"
                - git push origin $BITBUCKET_BRANCH
                - sleep 1
                - git checkout -b $TARGET_BRANCH && git pull
                - cp --recursive --force $TMP_DIR/* ./
                - git add .
                - git commit -m "unzip the file from paligo"
                - git push -f origin $TARGET_BRANCH
                - fi
```
Tokens:
Raw