How to: Get the searchable offline Bonita Javadoc with Mac OS

This article will explain how to get the searchable offline Bonitasoft javadoc with Mac OS X.

First, install Dash, available from the Mac AppStore. This software allows you to get offline documentation for a number of things like Android, C++, Drupal, and Java.

Then, download the javadoc jar available on source.maven.org, and select the version you want.

You will need javadocset to compile the HTML files into a docset file importable into Dash. Download the binary file via the link in the readme.

Now, you have everything you need to get the offline javadoc.

Rename bonita-common-VERSION-javadoc.jar to bonita-common-VERSION-javadoc.zip and unzip it. Unzip javadocset too and open a Terminal. All downloaded and extracted files should be in your download folder :

Note that "BonitaBPM" is arbitrary. This is the name that will be displayed on Dash.

Now, from your finder, go to the download folder (~/Downloads) and double-click on BonitaBPM.docset. It will open Dash and add the docset to your library. You are able now to search through the Bonita Javadoc.

For example, search for "flownode" on the search bar. The result set is instant, and you can scroll the results.

Some explanations about the interface and icons:

• Section 1 is the main view, where you can read the documentation.
• Section 2 is the search results with some indications:
  • is for Classes
  • is for Methods
  • is for Constructors
  • is for Fields
  • is for Enum constants
  • is for Packages
  • is for Interfaces
  • is for Exceptions
  • is for results found in different sections

This list may not be exhaustive.

• Section 3 is the methods and fields list, for easier browsing through the classes
• Section 4 is the tab section. You can open multiple tabs to have many documentation pages open.

To learn more about Dash, see here: http://kapeli.com/dash