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

Writing and Content Style Guide

When publishing content, we do our best to keep all content contributions consistent, knowing that we will have contributors of all levels with multiple writing styles. To that end we have created a General Writing Style Guide to provide some guard rails in terms of our content voice and writing style. For visual style guidelines, read on in this article.

Product Screen Shots

Product screenshots are an excellent way to enhance documentation. Strategically positioned screenshots can provide a much better visual balance to the document compared to text alone. Professionally annotated screenshots are even more effective. For instance, if you have a screenshot where you want to highlight several specific features or elements, each element can be annotated and numbered directly on the image. This approach provides clear reference points that can be easily referred to in the article text.

Caution

While screenshots provide a simple and low-cost way to add visual balance to your articles, it’s important to consider that screenshot images can quickly become outdated as the software changes. This can lead to quality issues in the documentation. Generally speaking, it is advisable to use screenshots sparingly. Every screenshot you add creates future maintenance overhead, which we should aim to minimize.

Graphics and Illustrations

When creating content that requires illustrations, info graphics, and diagrams you should aim to create graphic assets rendered in Scalable Vector Graphics (SVG) format.

Content on Hornbill Docs can be rendered in both “light mode” and “dark mode” and this should be considered when designing graphics for inclusion. Using two monochromatic scales one based on a neutral gray scale and the other based on the Hornbill Docs website accent color, you can create surprisingly sophisticated images. By using the recommended color palettes as the basis for your image’s color theme you will help in maintaining consistency in the Hornbill Docs website appearance.

Tip

If you use the exact color values defined below, this will help the Hornbill Docs system provide automatic color adjustments for dark/light mode as well as high contrast modes for accessibility.

When creating an SVG or PNG (with a transparent background/alpha channel), you should choose color contrasts that work well in both dark and light mode. When selecting colors, test in both light and dark mode to make sure images are visually easy to read and understand.

You can test the dark/light mode rendering by switching modes at the top right of the preview screen.

The following monochromatic color palettes are recommended for use with illustrations and other image assets to ensure there is a consistency of styling and appearance across documents.

Accent Color

#85D2FF

#219BFF

#007ADB

#0065CB

#0C4C8C

Gray Scale

#C0C0C0

#A0A0A0

#808080

#606060

#404040

In This Document

{{docApp.title}}

{{docApp.description}}