Page Comparison

DocBook as OLE help - pdf, html, webhelp

1. 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.

2. Needed to change the image file references to ../images/filename.png and reference files to ../html/linkname (for html)links.  <Inlinemediaobject> is for images that occur within text.  <screenshot><mediaobject> is for images that occur on their own line, separated from the text.
   Example:

   Code Block
   <link xlink:href<inlinemediaobject> <alt>Location Level</alt> <imageobject> <imagedata fileref="../htmlimages/releaseNotesDescribeNoTitlePage-178.html">HTML</link> <link xlink:hrefpng"/> </imageobject> </inlinemediaobject> Or <screenshot><mediaobject> <alt>Location Level Document</alt> <imageobject> <imagedata fileref="../pdfimages/releaseNotes.pdf">PDF</link>

   For webhelp, when linking FROM the index page (which follows the html format), links appear the same way

   DescribeNoTitlePage-179.png" width="100%"/> </imageobject> </mediaobject> </screenshot>

3. Set up links to other webhelp space, link to the anchor like this:

   Code Block
   <link xlinklinkend:href="../webhelp/ADMIN/index.html">Webhelp<_searchingOLE">Searching OLE</link>

   However IF you are inserting a link from webhelp back to the index page or to another webhelp space, format isThis assumes that you have an anchor at the space

   Code Block
   <link<anchor xlinkxml:hrefid="../../../html/Index.html"> <link xlink:href="../../../webhelp/BASICS/index.html">OLE Basic Functionality and Key Concepts</link>_searchingOLE"/>

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

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

5. Created an index page

Additional steps for editing and committing documentation

• Needed Need to complete a CLA (on the Subversion the License Agreement Process (CLA/CCLA) 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)

...

• Have editing software - it is xml so you could use a simple text editor but with the images, Oxygen is recommended.
• Fork the project into your own GitHub repository and pull updates (see OLE development using Github)

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

1. 1. Enter your local OLE directory, once per day run
      

      1. svn updatebe sure it is up to date

      2. mvn clean install -DskipTests=true

   2. Each time, to test To test your updates, type "mvn clean pre-site -N". 

   3. To view the changes, open Windows Explorer or Finder and dig into the correct folder: your local OLE directory > target > site > reference > pdf, html or html-multi.webhelp

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.

...