Publishing DocBook

Contents

DocBook as OLE help - pdf, html, webhelp

Peri worked with Jeff to add the documents to SVN. See Developing Rice DocBook Documentation
(Kuali OLE followed Rice and is currently using the DocBook 5 format for documentation and the docbkx-maven plugin to generate the documentation as part of our maven build.)
The difference between OLE and Rice documentation is that OLE has decided to use Webhelp output for our documentation whereas Rice uses only HTML. See the plugin documentation here: http://docbkx-tools.sourceforge.net/docbkx-maven-plugin/plugin-info.html.
Needed to change the image file references to ../images/filename.png and reference files to ../html/linkname (for html)
Example:
```
<link xlink:href="../html/releaseNotes.html">HTML</link>
<link xlink:href="../pdf/releaseNotes.pdf">PDF</link>
```
For webhelp, when linking FROM the index page (which follows the html format), links appear the same way
```
<link xlink:href="../webhelp/ADMIN/index.html">Webhelp</link>
```
However IF you are inserting a link from webhelp back to the index page or to another webhelp space, format is
```
<link xlink:href="../../../html/Index.html">
<link xlink:href="../../../webhelp/BASICS/index.html">OLE Basic Functionality and Key Concepts</link>
```

Separated out the chapters into individual xml files and pasted the docbook document type declaration in the chapter element:

<chapter xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" version="5.0"
    xml:lang="en-US">

Created an index page

Additional steps for editing and committing documentation

Needed to complete a CLA (on the Subversion wiki page)
Needed to complete OWASP training
Checked out the project via Oxygen (Oxygen is available from iuware for those at IU, may be available through other universities also)

1. Tools > SVN client > Repository > host: https://svn.kuali.org/repos/ole > currently, the project is in branches/kole-{current release}-Docbook/src/site/docbook
2. Checked out to local computer
3. Modify
4. Check back in through Tools > SVN client > working copy > Refresh, then right click copy and "commit"

Once saved but before committing, you can view changes locally through the command line.

1. Enter your local OLE directory, once per day run
  1. svn update
  2. mvn clean install -DskipTests=true
2. Each time, to test type "mvn clean pre-site -N".
3. To view the changes, open Windows Explorer and dig into the correct folder: your local OLE directory > target > site > reference > pdf, html or html-multi.

DocBook as built-in help (webhelp)

Peri had to do some modifications to get the webhelp to display correctly. We had to modify images and tables to get them to display correctly. Webhelp pages are now linked with OLE.

See the plugin documentation: http://docbkx-tools.sourceforge.net/docbkx-maven-plugin/plugin-info.html