OpenDJ: WebHelp format for docs?

Docbkx-tools logoThis past Saturday morning I started having a look at DocBook WebHelp format, the main advantages of which are twofold:

  1. The left menu, a tree layout of the titles, is always available.
  2. Search is built in.

The initial experiment is easy to do with docbkx-tools, just <goal>generate-webhelp</goal>. (That did not automatically pick up the images and styles, of course.) With the current setup of OpenDJ docs something is wrong in the XInclude resolution for a doc <set>. So instead of having the <set> as the home that contains all docs, I added a simple cover page to my experiment, posted at http://mcraig.org/webhelp/.

The draft Admin Guide has the most content, and so is perhaps the best example.

Having each book in its own WebHelp container leaves something to be desired, but I like the navigation and search. In terms of design, http://docs.redhat.com/ seems like an improvement on the whole idea.

Advertisements

Leave a comment

Filed under Docs, Tools

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s