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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

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

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Translation Mode

Throughout every application within the Hornbill user interface you are presented with forms containing text to describe labels, messages, hints, and more. The Hornbill environment provides an in-app ability to translate this text, to make sure the translation is in context with how it is being used.

Rights and Roles

A Role called Translator is provided to allow selected users to be assigned the right to configure in-app translations. To assign a user to the Translator role following the instructions on managing Roles. The Translator Role is accessed in Administration by selecting Hornbill Collaboration Core from the application selector, and selecting Roles in the left hand menu.

Start Translation Mode

A user that has been assigned the Role of Translator will have an option within the top right Profile Menu next to the session language selector.

Translations can serve two purposes:

To provide an alternative translation to the English text that has been provided by default To translate the default text to a another language that you wish to provide for users. The translation will be applied to the language that is currently active within your session. This is displayed next to the Translation Mode button. Before enabling Translation Mode select the language that you which to provide translations for.

Translate UI

Once translation mode it enabled, each string that allows for a translation to be applied is presented with a colored squiggly underline. By right clicking on this text, you are presented with a Translate UI option.

  • From
    Shows the current value for the string
  • To
    Lets you manually enter a new value for this sting
  • In
    Lets you select an alternative language to translate this sting into
  • Default
    Returns the label to its original default value
  • Suggest
    This will perform a Google Translate to automatically populate the To box
  • OK
    This save this translation and make it visible everyone using that language.

Under some circumstances a string may not be presented with a squiggly underline. In the majority of cases these strings can still be translated in the Language section of Administration.