Supported Element Attributes

Each element in Paligo can have one or more attributes, which are properties that Paligo can use to apply different characteristics when publishing. A common example is using attributes for including or excluding content (filtering). For example, you could give an element the xinfo:product filter attribute and set its value to Acme 100 (or any other product name). When you publish your content, you can then instruct Paligo to include or exclude any content that has the xinfo:product attribute with Acme 100 as the value.

Filters are just one example of how you can use attributes. There are many other uses too, for example, you can use the role attribute to set Paligo to include a class name in an HTML output.

To learn how to add an element attribute, see Add Attributes to an Element.

To learn about the different element attributes you can use, see Supported Attributes and their Uses.

Supported Attributes and their Uses

You can use the following attributes in Paligo:

  • Attributes included in DocBook 5.0

    Paligo is based on DocBook 5.0 and so supports most of the attributes that are included in that content model. But there are some differences to consider. Paligo uses the <article> element for publications and <section> for topics, so it is important to remember that when setting attributes on those elements. Also, Paligo does not support other root-level elements such as <book> and <set>.

    Note

    The role attribute is a DocBook 5.0 attribute that allows any text as its value. In Paligo, the role attribute is used in specific ways, and the value is an important part of the functionality. To learn about the supported role values, see Role Attribute Values in Paligo.

  • label

    Use on a topic's section element to prevent it being numbered in a PDF output (a value of 0 means no numbering).

  • xinfo:appid

    Use on the section element when setting up context-sensitive help (see Context-Sensitive Help).

  • xinfo:chunk

    Use on the section element to instruct Paligo to keep a topic as a separate page in HTML outputs (see Create Subsections).

  • xinfo:country

    Use to filter content by country (see Filters (Profiling) and Filter Attributes).

  • xinfo:keep-together

    Use to control the flow of elements over two pages in PDF outputs (see Soft Page Breaks).

  • xinfo:keep-with-next

    Use to control the flow of elements over two pages in PDF outputs (see Soft Page Breaks).

  • xinfo:market

    Use to filter content by market (see Filters (Profiling) and Filter Attributes).

  • xinfo:outname

    Use on the section element to control the URL for the topic when it is converted into a page for HTML outputs. The value that you enter is used as the URL (see Topic File Names (HTML).)

  • xinfo:pagebreak

    Use to set a hard page break in PDF outputs (see Hard Page Breaks).

  • xinfo:product

    Use to filter content by product name (see Filters (Profiling) and Filter Attributes).

  • xinfo:proglang

    Use to filter content by programming language (see Filters (Profiling) and Filter Attributes).

  • xinfo:version

    Use to filter content by version (see Filters (Profiling) and Filter Attributes).

To learn how to give an element an attribute, see Add Attributes to an Element.

Note

Paligo also supports some "internal attributes" such as xinfo:image, xinfo:resource, and xinfo:text. These "internal attributes" are created and maintained automatically by Paligo and are used for allocating IDs to elements. You should not edit them.

Role Attribute Values in Paligo

You can use the role attribute with specific values to set Paligo to provide particular functionality. There are many possibilities, including adding class names to HTML outputs, adding extra-responsive features to HTML tables, and controlling wrapping in PDFs.

Element attributes panel. The role attribute is added and it has a value of extra-responsive

The following list shows the specific role attribute values that Paligo uses for various features. We have included cross-references to the sections that describe those features:

To learn how to add an element attribute, see Add Attributes to an Element.