Chapter 6. Documentation

Gentics Portal.Node SDK comes with a small documentation framework you can use to document your work.

It is located in MyPortletapplication/tools/documentation and uses DocBook. DocBook is an XML dialect used to easily write technical documentation which can be converted to various output formats. Gentics Portal.Node SDK comes with a ant build script which converts your documentation into PDF as well as chunked XHTML.

For a complete documentation about DocBook you may want to refer to the (free) Book DocBook: The Definitive Guide for further information about how to write documentations using DocBook.

To build your documentation follow these steps:

Procedure 6.1. Building MyPortletapplication Documentation

  1. Open the directory MyPortletapplication/tools/documentation in the Package Explorer. (By default located to the right in the Java Perspective.

  2. Rightclick on build.xml.

  3. Select Run As+Ant Build (Alt-Shift-X-Q).

  4. Now Refresh (F5) the MyPortletapplication/tools directory.

  5. You can view your documentation in MyPortletapplication/tools/out/manual either manual.pdf for the PDF version or xhtml/index.html for the XHTML version.