Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Content Layout Templates

You can control the rendered layout of an HDocBook page by selecting the appropriate layout property in the frontmatter content of the article. If not specified, then the default layout is set to article.

Article Screen Area

The content layout UI is responsive and will adapt the best it can to different screen sizes. Elements of the layout are adjusted/shown/hidden as required to get the best reading experience at any given screen resolution and screen orientation.

Available Layout Templates

You can specify the layout property of each article to be any one of those in the table below. The preview column shows you how the article content will be laid out when rendered. If you do not specify a layout in the article frontmatter section, then the default article layout will be used.

Layout Description Preview
article The default article layout including a page table of contents automatically generated from H2/H3 on the right side. The width of the content, while responsive, has a maximum width, after which the content is padded to the right or, on wider screens, centered in the content area.

The links provide access to sections of the page. This layout provides a typical vertical document layout, a good default for most articles.		 Article Screen Area
article-no-toc This layout is basically the same as “article”, but without the addition of the right-side page table of contents. Article Screen Area
article-wide A full-width table layout, where the content (normally a table) will be shown. This layout is useful when you have content that will benefit from the full width of the content area, when there is definitely no anchor link document index. Article Screen Area
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document