1. Ant Task Support

1.1 Plug-In de.nq4.nqdoc.core.ant

To integrate the creation of your documentation into your Eclipse PDE Build process an Ant Task is available. The Plug-In de.nq4.nqdoc.core.ant defines an extension which plugs into the extension point org.eclipse.ant.core.antTasks. After downloading deploy the Plug-In in your build platform. The Plug-In has the following dependencies:

• org.apache.ant

• org.eclipse.ant.core

• org.eclipse.core.runtime

• de.nq4.nqdoc.core

• de.nq4.nqdoc.extensions

The excerpt from the customTargets.xml we are using to build the nqDoc Help looks as follows:

<project name="Build specific targets and properties"  default="noDefault">
  ...
 <target name="postSetup">
   ...
  <manual
   manualFile="${buildDirectory}/plugins/de.nq4.nqdoc.help/mml/help.mml"
   language="en_US" 
   eclipseHelpBookReferencePrefix="html/"
   exportMethod="eclipse_help" 
   workspaceDir="${buildDirectory}/plugins"
   outputDir="${buildDirectory}/plugins/de.nq4.nqdoc.help/html">

   <exporterOption key="user.header"
    value="${buildDirectory}/plugins/de.nq4.nqdoc.help/mml/header.html" />
   <exporterOption key="user.footer"
    value="${buildDirectory}/plugins/de.nq4.nqdoc.help/mml/footer.html" />
  </manual>
  ...
 </target>
...
</project>

Manual Build Task Example

At the time of writing the ManualBuilderTask can handle the following values for the attribute "exportMethod":

• ascii

• html

• docbook

• feature

• license

• eclipse_help

• mml (to link against resolved resources)

1.2 Plain Ant

To use the manual task within a plain ant file place the nqdoc_ant.jar inside the lib folder of your ant installation. The nqdoc_ant.jar can be found at http://www.nqdoc.com/ant.html. The content of the build.xml file may look as follows:

<project name="nqdoc_ant" default="manual">

 <taskdef resource="nqdoctask.properties" />

 <target name="manual">
  <manual 
     manualFile="test.mml"
     exportMethod="html"
     language="en_US"
     outputDir="${basedir}" />
 </target>

</project>

Note the taskdef element. The content of the nqdoctask.properties file should look as follows:

manual=de.nq4.nqdoc.core.ManualBuilderTask