How to write DocBook sources for UIMA Documentation

This page gathers the hints and tips on how to write Documentation using the DocBook markup, for UIMA.

How To:

• Shorten titles (addressing most common cause of FOP message about text overflowing a static area): follow <title>a loooonnnnnggggg title</title> with <titleabbrev>a short form</titleabbrev>. The styles are set up to use the abbreviated version in the static areas (the headers).

Things to avoid

• Don't write <programlisting> or </programlisting> on separate lines - the new line that follows or preceeds them will cause extra white space in the output.