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

SEO-friendly Output Filenames

Enable if you want SEO-friendly link names based on the names of the topics in your output, instead of unique ids.

The link will also stay permanent if the topic name stays the same (the topic title is irrelevant).

You can change the name of a topic without changing the filename that is produced in the output. This is useful if you need to keep the existing URL for a page. To change the topic name but keep the existing filename, add the xinfo:outname attribute to the section element of the topic. Set the value of the xinfo:outname to the name of the file (not the full URL path) and do not include the .html file extension.

If the title used to be "Introduction to ACME", the auto-generated output file name would be "introduction-to-acme.html". If you now change the title to "Introducing ACME", that would change the output file name to "introducing-acme.html". You can then add xinfo:outname with a value of "introduction-to-acme" (no extension) to keep the previous output file name.

Use a short and flat URL structure for output files

If you have SEO-friendly Output Filenames enabled, output paths will have a nested folder structure, by default.

Enabling this option will instead create a flat URL structure, generating shorter URL paths. (Always enabled automatically if you select Ajax loading below)

Default: Disabled

Use output file names made from id and SEO name

When flat URL structure or Ajax loading is enabled, the output file name is based on the title. If you enable this setting, the output file name will be a combination of the topic id and the title instead, for example, '123-my-topic.html'.

Default: Disabled

Allow reserved characters in output file names

Some characters, such as commas and semicolons are classed as "reserved" characters. Use this setting to control whether reserved characters can be used in output file names. Set it to Enabled to allow reserved characters or Disabled to prevent them being used.

Default: Disabled

Reader-friendly fragment identifiers (hash links)

Enable this feature if you want links to subsections to use reader-friendly names instead of unique id names (UUIDs). For example, www.acme.com/docs/introduction.html#getting-started. Note that you also need to have the SEO-friendly Output File Names feature enabled.

Disable this feature if you want the output to use unique id names.

Default: Disabled

To find out more, see Reader-Friendly URLs for Subsections.

Preserve legacy anchors if using reader-friendly fragment identifiers

Enable this feature if you are using reader-friendly hash links and you want to support:

  • Existing links to subsections, where the links use the UUID of the subsection not the new reader-friendly URL

  • New links to subsections, where the links use the new reader-friendly URL.

Disable this feature if you are using reader-friendly hash links and you do not want to support existing links that use the UUID. If there are links that use the UUID, they will no longer work.

Default: Disabled

To find out more, see Reader-Friendly URLs for Subsections.

Multiple publication portal prefix

Enable this setting if you:

  • Publish multiple publications in one help center portal

and

  • Have publications that reuse other publications (i.e. have reused subpublications).

When this setting is enabled, the output names for the sub-publications are unique, as Paligo adds the publication id to the output file name.

Disable this setting if the two points we have described do not apply to your content.

Default: Disabled

Use resource name instead of title for HTML output filename

Use to control whether Paligo uses the topic name (resource name) or the title name when it creates the output file name for topics. Set to Enabled to use the topic name or Disabled to use the title.

Note that this setting applies to all topics. If you only want certain topics to use the topic name, you can give those topics the xinfo:outname attribute instead. Then set the attribute value to the name of the topic.

Default: Disabled

Keep the letter case of the title for the HTML output file name

Use this setting to control whether output names are all lower case or can use upper case letters too. By default, the output file names only use lower case letters, for example, my-topic.html.

Set to Disabled for lower case only or Enabled to allow upper case letters. We recommend that you only set this to Enabled if you have a specific reason for using upper case letters.

Default: Disabled

Ajax load content

When enabled, the HTML content will be dynamically loaded for each page, making the page switching very fast.

Note that you have to publish the output on a server for this to work.

Default: disabled.

Enable local context-sensitive help

You do not have to enable this to get context-sensitive help. It is by default enabled, but the default requires the content to be published on a web server, which is the most common.

If, however, you have a requirement to have the context-sensitivity work on a local help package without a web server, you can enable this option.

Default: Disabled

Custom meta tags

Enter global custom meta tags as key-value pairs (name/content) here.

E.g to add a 'noindex' tag, to exclude web site from search engine indexing, you would enter 'robots:noindex, follow;' End each key-value pair with a semi colon.

Note

Only for global tags. Specific meta tags can be added directly in your topic. Meta keyword tags can be added through a keywordset element with keyword elements in your topics. And meta description tags can be added by using an abstract element (inside an info element after the title).

If you use the abstract to output meta description tags, you may also want to add custom CSS to not display it, unless you want that abstract to appear also in the content page itself. Use filtering by outputformat if you don't want it to appear in other output, such as PDF.

Default: Disabled

Create a title 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.

Only create topic for reused publications if no top-level topic

With this option enabled, you can mix reused publications where there is a top-level topic in some (in which case no title topic will be created for the publication), together with publications that have no top-level topic (in which case a title topic will be created for the publication).

Default: Disabled

Format output

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

Copy anchor URL on click

When enabled, a link icon appears when you hover over a heading in the middle of a page. Clicking it copies the anchor url to the clipboard for easy sharing of a section.

copylink.png

Default: Disabled

Update URL on scroll

When enabled, the url in the browser address field will update as you scroll down a page to sub sections. This makes it easy to copy the url for any part of the content and improves usability.

This is normally a good idea, and the default is only disabled for backward compatibility. Default: disabled.

Company name

Will be used for copyright label if added, e.g in the Help Center output.

Copyright year

Only add this if you do not want the current year automatically used, which is the default.

Note that if you have a copyright element inside the publication, that will override this.

Last modified date

If you add a date format here, the last modified date for each topic will be output in the page footer.

E.g 'm/d/Y' (no quotes) for '03/25/2018', 'Y-m-d' for '2018-03-25', or 'F j, Y' for 'March 25, 2018'.

Leave empty to exclude the date.

Today's date for publication date

If you add an empty pubdate element in your publication, and add a date format here, today's date will be added to your output in the index-en.html file (or equivalent for other languages).

E.g 'm/d/Y' (no quotes) for '03/25/2018', 'Y-m-d' for '2018-03-25', or 'F j, Y' for 'March 25, 2018'.

Leave empty to exclude the date.

Color-mark non-approved translations

If the source language has changed since last translation, you can have this indicated with blue highlighting in the output (for draft publishing).

CSS, JS, logos, and other assets

Category

Description

Logotype

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

For the Help Center output this is only used in the content pages. Set the portal page logo below.

Help Center portal page logotype

Set the logo to use for the portal page.

This can be different than the one used on the main content pages to match the theme.

Logo link

By default, the logo in your HTML5 output will go to the main home page of the help itself. If you want it to go somewhere else, such as to your company home page, enter a URL here.

Note

This option should only be used if you are not using the portal page, or have another (customized) home link, as there will otherwise be no way to get back to that page.

Leave empty to use the default.

CSS

Upload your own CSS to modify the default layout.

Persistent custom CSS filename

By default, your custom CSS will get the unique id name on publish, everytime you upload a new update.

If you prefer to have a persistent name on each publish, you can enable this option, in which case the name will always be 'layout-custom-style.css'.

Default: disabled.

Help Center portal page background image

This image will be used for the header banner (or "hero") section of the portal page.

Custom javascript

You can upload your own javascript to add functionality to your HTML5 output

Global custom javascript

This option will only insert a javascript reference in your HTML5 output files. You need to supply the javascript file separately after publish.

In most common use cases the upload will be more convenient, but this option can be useful if you always want to use the same javascript for a number of different layouts, but do not want to have to upload and update it everywhere.

Add a Favicon

Upload an .ico or .png file here to use as your favicon. Even if you use .png, make sure to name your file 'favicon.ico' for it to be recognized. The favicon will only be visible when published on a web server.

Add a robots.txt file

Upload a robots.txt file here to give instructions about your published site to web robots.

The file will be placed in the root folder of your published output. It must be named 'robots.txt'.

Note

See http://www.robotstxt.org for information about what to include in your robots.txt file. If you are not very comfortable with how to do this, make sure to consult a web developer to create this file.

Create sitemap

If you want a sitemap.xml file for SEO and search engine crawling, enable this option.

Note: to use this option, you also need to provide the destination domain below. Default: disabled

Publishing destination domain

If you want to publish a sitemap.xml file, you also need to add the final destination domain where you will publish your content. Paligo will use this to provide the full absolute path of each topic in the sitemap.xml file.

For example: http://www.acme.com/acme1000/onlinehelp/

Help Center theme options

Category

Description

Base theme

There are a number of base themes to choose from for the Help Center output. Choose the one you want to base your own layout on.

Content theme

Besides the main base theme, you can also choose between different content themes, affecting mainly the body content, such as the styling of admonitions, lists, etc.

Sticky header

For the Help Center themes, you can enable a sticky header that is always visible when you scroll. Default: disabled

Full width header

For the Help Center themes, you can make the header in the main content pages full width. Default: disabled

Graphical lists

For the "Help Center" output only: When enabled, graphical numbers are used for procedures, etc (can be further customized by CSS). Default: enabled

Search engine

Category

Description

Use Algolia search

If you want to use the high-end Algolia search engine in your help output, enable this. (Requires separate Algolia subscription).

Elastic Search (Swiftype)

If you prefer a crawler-based indexing search engine, Elastic Search (Swiftype) is another powerful option.

To enable Swiftype, add the key (only) from the code snippet in the Swiftype control panel.

Use fuzzy search

If you do not want to use Algolia, and the default search is not your preference, the fuzzy search is another built-in option.

Use multilingual support for default search

If using the default search, but you need support for multiple languages, enable this. Disabled by default since it adds unnecessary files if you don't have the need for multilingual publishing.

Include excerpt snippets

Applies to default search or fuzzy search, if you use one of them you should normally enable it. Disabled by default only for backward compatibility. Algolia search always has snippets by default.

Use breadcrumbs path in search results

If you use the snippets option (required for this option), you will also get a path for the result topic. This can be the exact path with the HTML file name, or a more user-friendly breadcrumbs path with the titles of the topics.

Default: Breadcrumbs made from titles enabled.

Note

Search is currently not used by default in single-page outputs. This needs a customization if desired in such output.

Feedback

Category

Description

Use voting panel

Note

This option is currently only available for the Help Center output (Only for the main Help Center output, not available for the 'Preloaded' variant).

If this is enabled, your users will see a panel asking if they found a help page useful or not, with a 'Yes' and 'No' button to respond, like this:

votingpanel.png

The buttons have unique ids so you can collect the data through an analytics tool.

To track the number of clicks on Yes or No, you can use the analytics tool of your choice. As an example, see this page for how to do this in Google Analytics Tag Manager: Google Analytics events.

Default: Disabled

Allow users to submit feedback (suggest edits)

If this is enabled, your users will be allowed to submit feedback to you or suggest edits to a help page. By default the feedback will be by email. Other types of feedback can be purchased as a customization.

Default: Disabled

Toggle feedback with voting panel

Note

This option is currently only available for the Help Center output (Only for the main Help Center output, not available for the 'Preloaded' variant).

If using the voting panel, choose whether the link to provide feedback should be toggled on 'No', both 'Yes' and 'No', or always visible.

Default: Toggle on the 'No' button.

Email for feedback

Enter an email address here if you want your users to email you feedback.

Analytics and other integrations

Category

Description

Use cookie consent popup

If you are using any of the integrations below you should enable this popup to comply with legal regulations, such as the EU GDPR law.

You have the strict option where the user can opt out completely, or just the informational.

Warning

Paligo disclaims any responsibility for your output complying with cookie regulations, and it is up to you to ascertain that the output does not violate any cookie regulations or similar, with or without this popup enabled.

Privacy policy link

If you use the cookie consent popup, you must enter the URL to your privacy policy here.

Google Analytics

Add your property id (or "tracking id") to connect Google Analytics to your HTML5 output. Also select whether you want to use the analytics.js tag or the global site tag (default).

Mixpanel tracking

If you want to integrate with Mixpanel analytics.

Disqus comments

To get a section at the bottom of each topic with discussion threads, where users can add feedback, enable this with your Disqus domain.

Intercom chat

If you use Intercom, you can add the chat widget here to communicate live with your customers as they browse your help site.

Use Lightbox for images

If enabled, clicking images in the HTML5 output will enlarge them to full size. Default: disabled for legacy HTML5, enabled for the Help Center output.

Use thumbnails for all mediaobject (block) images

If enabled, every image in the HTML5 output will be rendered as a small thumbnail (for content where you want to reduce the space images take up).

It may be more common to only want certain images as thumbnails. If so, just leave this option disabled and set it individually in certain images:

  • Either select the image or the mediaobject, and use the keyboard shortcut AltShiftQ.

    (The image will display in a smaller size to show it's been set as a thumbnail)

  • Or set the role attribute manually on the mediaobject element (not the imagedata) to "img-thumbnail".

Default width for thumbnails is 200px. You can change that in your custom CSS if you want.

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

Note

You must have the "Output role attribute as class names" option enabled for this to work.

If using thumbnails on images, you should also make sure you have the Lightbox option enabled.

Example 1. Thumbnail with lightbox
Lightbox

TOC and chunking

TOC settings are for controlling options for the Table of Contents in your output. Chunking controls the size of your topics in the HTML output. Read more about chunking here.

Category

Description

Standalone TOC

If enabled, the Table of Contents will not be created inside each HTML file, but rather as a standalone file, inserted by javascript when rendering the page.

This makes HTML files smaller, and if not changed in content, identical even if the TOC has changed structure as a whole.

Default: Disabled

TOC section depth

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

Default: 3.

Only include chunks in TOC

If enabled, only those topics which become chunks (according to your settings) will be included in the TOC.

By default this would mean that e.g internal section elements in a topic will not be included in the TOC.

Default: Disabled

Chunk section depth

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

Note

If you have publications nested inside other publications (sub-publications), each level of publication also counts as a chunking level. For example, let's say you have a publication, a sub-publication, and four levels of topics in the sub-publication. You want the topics to be chunked at two levels. For this, you would set the Chunk section depth to 4 (1 for the publication, 1 for the sub-publication, 1 for the top level topics, 1 for the second-level topics).

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.

Use legacy section chunking

This should in most cases be disabled. But if you want to enable legacy chunking, where any section element, whether an internal element in a topic or not, would be treated just like a topic, you can enable this.

Default: Disabled

Use section TOC

With this enabled, you get a 'mini' TOC (Table of Contents) in each output topic. There are a few options: legacy, which produces a list of the direct child sections and the title 'Additional links', 'After' or 'Before', which produces a hierarchical list of the level of sub topics according to your TOC section depth, or 'None' if you don't want one at all.

Default: legacy.

Focus on current section on click

Use this setting to control the behavior of the table of contents (TOC) in the published output.

If you set this to enabled or default, and then select a sub-level topic, the TOC will collapse all "sibling" topics (topics at the same level as the topic you have selected). For example, let's say you have a TOC with 5 levels of topics. If you navigate down to the 5th level and select a topic, the TOC will update and show Levels 1-4 open, but level 5 closed.

If you set Focus on current section on click to disabled, it creates a "sticky menu". This is where all levels of the TOC, from the top level to the topic you select, are opened. The TOC does not collapse the "sibling" topics.

Note

This setting requires Ajax load content to be enabled in the General settings. Ajax loading only works on a web server. If you want to test locally, you will need to start a local server on your computer.

Use H1 headings for topic chunks

By default, the headings in each output page in HTML5 will follow the hierarchy of the publication. This means most topics start on a heading lower than H1, since the publication itself is the highest level.

With this option you can change that to either start only top-level topics on H1, or to start every chunked output page on H1. Default: Publication hierarchy.

Use a separate list of related topics

If you want the list of separate topics to be separate from the "Section TOC" (list of child topics), this should be enabled.

See Classes and attributes for selecting a taxonomy to use for selecting related topics.

Default: Enabled.

Include child topics in related topics section

If you are categorizing topics as related, and some of these topics happen to also be child topics of a related topic, you can choose to exclude such child topics here. Otherwise, if you also use the "Section TOC", which by default lists all child topics, you might get duplicate topics.

See Classes and attributes for selecting a taxonomy to use for selecting related topics.

Default: Disabled

Use page TOC

Add a small page navigation (Table of Contents) for only the headings in the current page that highlights when you scroll.

pagetoc.png

Note

If you enable this, you should normally also enable 'Only include chunks in TOC', so headings in a single page are not displayed in the main navigation.

This is currently only available for HTML5 Help Center theme 1 and 2 (not the "Preloaded" version).

Default: Disabled

Top navigation

If you want to use a top navigation menu in your Help Center theme, enable this. You can select topics by using role attribute set to 'top-nav-link' or a taxonomy value named top-nav-link or Top nav link.

Note

You must have enabled 'Output role attribute as class names' and/or 'Output taxonomies' for this to work. If you only want external links, you set them below. Both types of top nav links can also be combined.

Default: Disabled

Top navigation depth

If top navigation is enabled, and topics have been selected as top nav links, select the depth of links here. If a topic has child topics that are chunked, the child topics will become a dropdown menu.

Default: 2

External top navigation links

If you have enabled top navigation and want to use links to external sites, add them here in the format text:MyLinkText, url:https://www.myurl.com;. (Make sure you don't use extra spaces, and note the separators).

Separate text and url with a comma, and end each link with a semicolon. These characters are special characters and must not be used in the text or url themselves.

Default: none (empty)

Use translation strings for external top navigation link text

For external top navigation links, it is possible to have some such strings translated automatically.

These strings need to be available in the default translation strings configuration, or added to a customization (on applicable plans).

For example, if this option is enabled, using the string contact.support will generate the text "Contact support" in the language currently being published. Not all languages are supported for all available strings. Contact support to request if a string translation can be added.

Default: Disabled

Use section numbering

If you want section numbering in your HTML5 output, enable this option.

Default: Disabled

Section numbering max depth

When section numbering is enabled, you can select the depth for which numbering is applied.

Default: level 8

TOC sidebar placement (single page HTML5 only)

For the single page HTML5 output, the TOC sidebar is place on the right by default. Select whether to place the Table of Contents sidebar on the left or right here.

Default: Right

Note

The chunking options have no effect on single-page HTML5 outputs, as the output is all one large chunk in that case.

Classes and attributes

Category

Description

Output taxonomies

When enabled, taxonomies will be part of the output, and is automatically propagated as class names. If this option is enabled, taxonomies can also be used for filtering and more below.

Default: Disabled

Value structure for taxonomy class names

You can set whether class names from taxonomies should output the value and all its descendant values in a taxonomy tree, just the value itself, or the value and its parent.

Default: Value and descendants

Underscore delimiter for taxonomy class names

When enabled, an underscore ('_') will be used to separate the parts of a taxonomy value output for class names in HTML5, instead of a dash ('-').

For most common purposes this is not necessary, but can be useful if you need to further process the separate parts of the value.

Default: Disabled

Taxonomy filtering strategy

You can set whether taxonomies should be used for filtering, and whether to output the value and all its descendant values in a taxonomy tree, or just the value itself.

If you want to enable taxonomies for filtering, the most recommended value is to select "Descendants" to take advantage of the hierarchy of a taxonomy.

Default: Disabled

Relationship taxonomy

Select any taxonomy to create relationship links.

Enter the exact name of the taxonomy node (usually the root of a sub tree right under Taxonomies). Separate multiple names with a semicolon. Leave empty if you don't want to use taxonomies for relationship links.

See TOC and chunking for options how to output the related topic links in your output.

Default: none (empty)

Create HTML meta tags from taxonomies

Creates meta tags with the root (name) of the taxonomy tree as the name attribute, and the value as the content attribute. Multiple values will be separated by a comma. The 'Output taxonomies' option must also be enabled.

Default: Disabled

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)

Glossary popovers

When enabled, glossary terms will display the definition in a pop over in HTML5 Help Center output, when the user hovers over it.

Note: This currently has no effect on legacy HTML5.

Default: enabled for Help Center output.

Table styles

Category

Description

Output classes for styling of tables

It is recommended to enable this setting. The only reason it is not enabled by default is for backward compatibility.

Enabling it will make the publish process output class names and these will be used for e.g borders, rather than obsolete attributes for borders and rules.

Frame options

For either table or informaltable, set the frame (the border around the entire table) default.

For no frame, set "void". For frame around the entire table, set "border" or "box".

See this page for more on the options: Table options

Rules options

For either table or informaltable, set the rules (the border between cells) default.

For no border, set "none". For borders between all cells, set "all".

See this page for more on the options: Table options

Re-sort sorted tables automatically on publish

Even if you have sorted a table in the editor, re-sorting them on publish can be useful for example if you publish to multiple languages (in which case the sort order may be different), or if you have missed updating the sort before you publish.

Note

This will only affect tables that you have sorted with the sort commands in the editor first. 

Default: enabled.

Extra responsive table features

Tables will by default be responsive in HTML5 output. But when this option is enabled, large tables will get extra responsive features, such as adding a button for the user to filter columns and sticky table header.

To use it for only selected tables, choose 'Only selected', and use a role attribute on the table element set to 'extra-responsive

Default: Disabled

Formal elements

The term Formal elements comes from the content model. It basically is an umbrella term for elements like lists, figures, tables, equations, examples. In this section you can make general settings applying to all such elements consistently if desired.

Note that any settings you make on a higher level (General) can be overridden if you set another value on a lower level (like "informalexample")

Most options are self-explanatory and not described here.

Category

Description

Use separate styling for label, number, and title in formal elements

If enabled, each part of the title for a formal elements, like a table, example, or figure, will get a span element with a specific class name, so they can be styled differently or excluded, using CSS.

Default: Disabled

Restart auto-label numbering

If enabled, tables, figures, and examples will restart their numbering for each topic, section (including internal sections inside topics), or chunk.

Default: continuous numbering throughout the publication.

Exclude label for abstract

If enabled, the label for an abstract is excluded from output. This is useful if you do not need it, and if publishing to multiple formats where hiding it with CSS does not work.

Default: Disabled

Images

Category

Description

Image title attribute

Use to output a title attribute on the image in your output. The title appears in a tooltip when you over over the image (in the output).

Default: Disabled

To find out more, see Image Title as Hover Text.

Use lightbox for images

Use to enable or disable the lightbox feature for images in your output. When lightbox is enabled, you can select an image in the published output and the image will display at full size. If lightbox is disabled, selecting the image has no effect.

Default: Enabled for HTML5 help center. Disabled for legacy HTML layouts.

To find out more, see Lightbox for Images.

Use thumbnails for all mediaobject (block) images

Use to control whether every image in the HTML5 output appears as a small "thumbnail" image. Enabling this feature is useful if you want to reduce the amount of space that images use on the page. But note that this setting applies to all images.

Note

If you want to use thumbnails on all images, you should also make sure you have the Use lightbox for images option enabled.

You may find it more useful to apply thumbnails to only certain images, rather than all of them. To do this, leave this setting disabled and then add a role attribute to the images you want to have thumbnails. Set the role attribute on the mediaobject element and give it the value: img-thumbnail.

Default width for thumbnails is 250px. You can change that in your custom CSS if you want.

Default: Disabled

To find out more, see Thumbnail Images.

Image size

To find out more, see Image Resolution.

Cross-references

Category

Description

Enable cross-reference auto-title customization

When enabled, the cross-reference auto-title customizations below can be used. Otherwise legacy cross-reference auto-text is used, or any stylesheet customization you may have.

Default: Disabled

Cross-reference auto-title

Determines the format of the generated text for cross-references.

See Cross-Reference Styling (PDF and HTML5) for options available.

Default: 'title page', which produces a format like 'My Topic Title (page x)'.

Cross-reference auto-title for formal elements

Determines the format of the generated text for cross-references for formal elements (like tables, figures, examples).

See Cross-Reference Styling (PDF and HTML5) for options available.

Default: 'default', which produces a format like 'Example 5, "My Title"'.

Cross-reference label/title separator

Punctuation or space separating label (if used) from title in cross-references, when the auto-title parameter above is set.

Note

For a space, use 's' (without the quotes).

Default: ':s', which produces a format like 'Example 5: "My Title"'.

Verbatim (code and software)

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.