INDEX

Documentation Library

Search for information on Hornbill Documentation.

Filter

Books

All
{{book.title}}
{{book.foundCount}}

Products

{{product.name}} {{docApp.searchFilteredProducts[product.id].returnedCount}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

{{resultItem.title}}

{{resultItem.url}}

Have questions about this site?

What is this site?

This website is Hornbill's new product documentation website and is currently under development.
It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
Please feel free to have a look around at any time.

Why has Hornbill created this site?

Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

Community contribution will be facilitated, encouraged, and most welcome.
High quality documentation, will be kept up to date as rapidly as our products evolve.
Real-time content search and discovery.
Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
Documentation available in browser as well as printable/viewable as PDF on demand.
Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

We have taken the decision to publish and make available early, there is very little content at this time.
As and when we have completed/usable documentation, it will be published here.
We have a host of additional features we wish to add over time, so please watch this space.
We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

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

{{book.title}}

{{book.title}}

More...

HDocBook Frontmatter

In the HDocBook system, within each article you can include additional metadata that describes author details, options for how the content should be rendered, its index, its inclusion in any taxonomy, keywords, and more. The additional metadata, called frontmatter, is used to provide this information to the HDocBook publishing system without rendering it as part of the article.

Frontmatter Content Example

Frontmatter content is actually expressed in another language called YAML, so this is really a language within another language. At least, this is how the processing tools see it.

By way of an example, here is a simple Markdown document with a H1 header and a paragraph:

# The Document Title

Some article paragraph text....

And here is that same article, but now with two metadata properties, title and layout, so now the document looks like this:

---
title: Doc Title
layout: article
---
# The Document Title

Some article paragraph text....

Frontmatter must always appear at the top of the article. The frontmatter content is fenced between two lines of three or more hyphens (—). The beginning and end of the frontmatter content block appear between these two fence lines. The Markdown parser will not directly render any of the frontmatter data or enclosing fence guards; Markdown rendering starts from the first text line after the second (—) Markdown fence line.

Frontmatter Metadata Properties

Property	Description
`title`	The title of this document; typically, but not always, the same as the first H1 in your document.
`layout`	The layout template to use when rendering this document. If not specified, this defaults to “article”. Click here for a list of Content Layout Templates.
`coverImage`	Fully qualified [options] path from root for an image used as a cover image. This will be used for gallery rendering and social sharing, using the Open Graph protocol. If not specified, the book-specific image will be used, and if not defined at book-level a global generic image will be used.
`description`	A description of the document. This will be used for gallery rendering and social sharing, using the Open Graph protocol. If not specified, a description will be generated using the first line of the book content.
`readingTime`	The amount of reading time required for this document. If not specified, this will be calculated automatically when the document is built, ready for publishing.
`pdfAvailable`	Set to ‘true’ if there is a PDF document available for this article.

In This Document

{{docApp.title}}

{{docApp.description}}