Getting Started with Paligo

Table of Contents

HTML5 Layout Editor Options

The tree of items you can choose to style in the Layout Editor is divided into a number of sections. Each section is described below, with the items you can style and the options available for them.

Many of the items and options are self-explanatory, and have explanations right in the Layout Editor. So only the items that may not be immediately transparent are explained below.

General

Category

Description

Logotype

Add your logotype to replace the Paligo logo in the output. Use CSS to style it.

CSS

Upload your own CSS to modify the default layout.

Permalinks

Enable if you want SEO friendly link names for your output (only applies to multi-page output).

Create a topic for reused publications

If you reuse publications within another publication, you can select whether that publication should be treated as a top-level topic, or if only it's child topics should be reused.

Format output

Usually not required, but if desired, HTML Tidy will be applied on the output to ensure strict XHTML format.

Use Algolia Search

If enabled, instead of the default javascript-based search, you can use the Algolia search engine (requires an Algolia account).

Use multilingual support for default search

If you use the out of the box default search for HTML5, you can enable multi-lingual support.

Note

Note that you should not do so if you only publish to English, as it adds more files to the output. You should also leave it disabled if you use Algolia, which supports multi-lingual by itself. Default: disabled.

Languages supported:

  • German

  • French

  • Spanish

  • Italian

  • Japanese

  • Dutch

  • Danish

  • Portuguese

  • Finnish

  • Romanian

  • Hungarian

  • Russian

  • Norwegian

TOC and chunking

Category

Description

TOC section depth

The Table of Contents for multi-page HTML5 output can include the number of levels you select here.

Chunk section depth

Chunking means to have a topic and nested subtopics become one larger topic in output. This option determines at what level any lower level topics are chunked as part of their parent topic. Default: 3.

Chunk first sections

If enabled, a chunk will be created for the first top-level section elements in each component. Otherwise, that section will be part of the chunk for its parent. Default: Enabled.

Classes and attributes

Category

Description

Output taxonomies as class names

If enabled, you can get your taxonomy categories into your output as class names for further processing (e.g by css and javascript).

Output role attribute as class names

If enabled, you can get your role attributes into your output as class names for further processing (e.g by css and javascript).

Output profile/filtering attributes as class names

If enabled, you can get your profile/filtering attributes into your output as class names for further processing (e.g by css and javascript), such as creating "on-the-fly" filtering.

Use xml:lang as profiling attribute

If enabled, the language attribute xml:lang can be used for filtering on language (natural languages like Swedish, Japanese, etc)

Verbatim (code elements)

Category

Description

Highlight verbatim elements

Enable syntax highlighting for code elements.

Highlight theme

Select the theme for your syntax highlighting (many different background colors and highlighting themes)

Use Font Awesome glyphs for code callouts

If you use calloutlist for annotating code samples, you can use Font Awesome for the "callout bugs". This is the default for HTML5.

Use graphics for code callouts

If you'd prefer, you can use a graphic for the code callout, an svg image will then be used. Max 30 callouts with this option.

Use unicode symbol for code callouts

Another option is to use a unicode symbol for callouts. If this is set a symbol similar to the graphic and Font Awesome version will be used. Max 20 callouts with this option.

Note

If all of the above code callout options are disabled, a simple plain text output will be used for the callouts. By default a number within parentheses like this (1), but this can be modified in your CSS.

Use code switcher for API style layout

Enabled by default. Only disable e.g if you need to mix programming languages in the same output and always show all samples without the user switching.

Graphical rendering of keycap

Use this if you want the keycap elements to render as a keyboard key, like so: AltShiftV.