Skip to main content

Supported Attributes

Paligo is based on DocBook 5.1 and supports most of the attributes that are included in that content model. Read more about DocBook 5.1. But there are some differences to consider that Paligo:

  • Uses the <article> element for publication topics, see Supported Info Elements.

  • Uses the <section> for topics.

  • Does not support other root-level elements such as <book> and <set>.

Caution

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.

Every element has a set of attributes, which are properties that define the element's characteristics. For each attribute, there is a value, and by changing the value, you can control how Paligo uses the element. Common usage areas are:

  • Filter attributes for marking up content so that you can choose to include or exclude it when you publish, see Filtering / Profiling.

  • Width attributes for adjusting image sizes.

  • Role attributes for various features, including collapsible sections and adding class names to HTML, see Role Attribute Values.

Element attributes panel. The td element is selected and it has a style attribute. The value of the style attribute is set to background-color:bg1

Above Style is the attribute and background-color:bg1 is the value.

Paligo supports the Types of Filter as well as the following attributes:

Attribute

Description

depth 

Use on the imagedata element to set the image depth (height) value in relation to the viewport. The viewport is the available space for the imageobject. Learn more about Image Sizing.

contentdepth 

Use on the imagedata element to set the image depth (height) value and has no effect on the viewport. The viewport is the available space for the imageobject. Learn more about Image Sizing.

contentwidth 

Use on the imagedata element to set the image width value and has no effect on the viewport. The viewport is the available space for the imageobject. Learn more about Image Sizing.

continuation

To get a continued numbering in sidebars, see Use Numbering in Sidebars.

label

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

language

Use on a programlisting element to set the language for a code sample, see Syntax Highlighting.

role

Use the role attribute with specific values to set Paligo to provide particular functionality, see Role Attribute Values

scalefit

Allows an image to be scaled up or down to fit within available space. If scalefit="1" the image is scaled (with the same factor in both dimensions) so that the graphic will just fit within the available height or width (whichever is more constraining). If any other image size attribute is specified, those attributes determine the graphic size and scalefit will be ignored.

style

Style the background colors for individual individual table cells (td or th) for PDF output, see Style Table Body (PDF).

tabstyle

Style the table element to use compact paragraph spacing, see Set Table Cell Paragraph Spacing.

width 

Use on the imagedata element to set the image width value in relation to the viewport. The viewport is the available space for the imageobject. Learn more about Image Sizing.

xinfo:appid

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

The @xinfo: prefix tells that this is an extension attribute.

xinfo:chunk

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

The @xinfo: prefix tells that this is an extension attribute.

xinfo:keep-together

To control the flow of elements over two pages in PDF outputs, see Soft Page Breaks.

The @xinfo: prefix tells that this is an extension attribute.

xinfo:keep-with-next

To control the flow of elements over two pages in PDF outputs, see Soft Page Breaks.

The @xinfo: prefix tells that this is an extension attribute.

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.

The @xinfo: prefix tells that this is an extension attribute.

xinfo:pagebreak

To set a hard page break in PDF outputs, see Hard Page Breaks.

The @xinfo: prefix tells that this is an extension attribute.

xlink:href

To make images work as links, see Turn Images and Other Elements into Links.

xlink:show

To override the default link behavior for individual links, see Update Individual Link Behavior.

Tip

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

Role Attribute Values

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 PDF output.

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

Tip

If you already have a role attribute, separate the values with a semi-colon.

The following table shows the role attributes and values that you can use in Paligo.

Attribute value

Description

accordion

Use to create a collapsible section. The section title is shown and when the user selects it, the section expands to reveal the content, see Accordions (Collapsible Sections).

column-count

Use to set the number of columns in a sidebar element in PDFs, see Enable Multi-Columns (PDF).

column-gap

Use to set the amount of space between columns in a sidebar element for PDFs, see Enable Multi-Columns (PDF)).

extra-responsive

Use on table elements to set them to add a sticky header and column filter to a table for HTML5 outputs, see Enable Column Filter and Sticky Header.

font-size

Use to set the size of the lettering on a verbatim element, such as programlisting , see Verbatim (code and software) PDF.

<free text>

Can be used on any element and you can enter any text as the value, for example, role: online-image. The value is used as a class name in HTML outputs. This only applies if the HTML layout is set to include the role attribute as a class name, see Classes and Attributes HTML5.

img-thumbnail

Use on mediaobject elements to set them as small "thumbnail" images in HTML outputs, see Thumbnail Images.

img-thumbnail-reset

Use on mediaobject elements to prevent them from being presented as small "thumbnail" images in HTML outputs, see Thumbnail Images.

multi-publication-portal

Use on article elements when publishing multiple publications to the same help center, see Multi-Publication Portal.

notintoc

Use on section elements to prevent a topic from appearing in the table of contents in PDF outputs, see PDF Layout Editor Options.

portal-category

Use on the section element to create category panels for topics in HTML help center outputs, see Topics for Category Panels.

promoted-content

Use on the section element to set a topic as "featured content", see Topics for Featured Content.

reuse-range

Use on procedure and orderedlist elements when you want the steps/items to continue the numbering sequence of a previous procedure or list, see Reuse List Items.

swagger-topic

Use on the section element when embedding Swagger/Open API content in Paligo for publishing to:

top-nav-link

Use on the section element to add a link to a topic from the top-navigation menu, see Add Top-Navigation Links to Topics.

wrap-option

Use on verbatim elements, such as programlisting, to control line wrapping, see Verbatim (code and software) PDF.