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}}

Reusable Content

Creating reusable content for books or pages is often desirable. Good candidates for reusable content include copyright notices, terms and conditions, and any other commonly used content that, for maintenance requirements, should not have duplicates. The HDocBook Markdown format supports an INCLUDE directive to facilitate this. As of now, only Markdown text content is supported by this directive. To use it, include the fully qualified URL of a Markdown file in the directive. The INCLUDE statement will then be replaced by the content within that file at build time or runtime in dev preview.

The INCLUDE directive takes the following form:

[ [INCLUDE https://raw.githubusercontent.com/Hornbill-Docs/hdoc-library/main/hdoc-library/agreements/code-of-conduct.md] ]

(without the space between the opening and closing square brackets). This will inject the content from the file code-of-conduct.md into your article.

It is also possible to include content from within the same document. This is useful, for example, when you have content you might want to include in your document pages, but also want to include as _inline content for in-app product help.

The include directive takes the following form:

[ [INCLUDE /esp-fundamentals/_inline/roadmap-incoming.md] ]

(without the space between the opening and closing square brackets). This will inject the content from the file roadmap-incoming.md into your article.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document