Documentation

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

Document Manager Mobile

Hornbill’s Document Manager can be accessed as part the Hornbill Mobile client to ensure that you have your documents on hand wherever you are. Documents can be downloaded from either your own personal library or you can access any of the available public libraries. Once you have your document you can view, email, copy, print, and more.

Share your document and collaborate on the contents with your co-workers. Publish your document to a public library to share with everyone in your company and access documents published by other users.

My Library

View all documents in your library or libraries which have been shared with you. By default this will be set to view Your Library

Switch the library view using the > icon and choosing the library you wish to view Change the order the documents are displayed by selecting the … icon and choosing to sort by:

  • Title
  • Owner
  • File Type
  • Creation Date
  • Updated Date

Open Documents

Select a document name to open / download the document on the mobile

Use the mobile devices propriety features to then

  • Print
  • Share
  • Email Select Done to return to the list of documents

Document Information

Select the i icon next to a document to view it’s details and options

Depending on if you are the owner of a document, or the rights which have been afforded to you, you may see the following options available to you.

  • Edit
    Select the Pencil icon to edit the document title or description
  • Comment
    Add a comment to the activity stream of the document
  • Share
    Choose to share the document with a co-worker, assign rights to view, and modify details and content
  • Owner
    Change the owner of the document
  • Status
    Change the status of the document from draft, active or retired
  • Publish
    If in an Active status publish the document to a library
  • Lock
    Check the document out for editing and lock / unlock it
  • Follow
    Choose to follow the document to receive notifications about updates to the document and it’s activity stream on your newsfeed
  • Open
    Open the document
  • Tag
    Add document tags to the document

Document Information Sections

  • Info
    Expand the info section to see information about the document title, owner, file type etc
  • Sharing
    See who the document is shared with, what rights they have to the document, and as the owner edit the rights and access
  • Published
    See which libraries the document is published in
  • Tags
    See which Document Tags the document has attributed to it

Activity stream

View all the posts and comments of the document

  • Change the order the post and comments are sorted by using the *** icon and sort by Recent Comments or Recent Posts
  • Like a Post or Comment
  • Add a Comment to an existing Post
  • More - Copy Text, Link, or Translate the Comment or Post

Document Tags

View and find documents by their Document Tags

  • Use the *** icon to switch the displayed tags by either List or Collection view
  • Clicking on a Document Tag will display a list of all documents with that Tag.
  • Use the Magnifying Glass Icon to search for documents with a specific Document Tag
  • Select the document name to open the document on the mobile
  • Select on the i icon next to a document to view it’s details and options
In This Document