# Maven FAQ Plug-in

James Strachan

# Maven FAQ Plug-in

This plugin generates xdoc documentation from XML FAQ documents. This automates the creation of an index of questions with hypertext links to the full question and answers.

The plugin uses the `xdocs` directory by default to generate the FAQ files. There is an example of the XML format here.

The properties that allow you to customize the execution are documented here.

To enable FAQ generation add the following to your maven.xml

      <preGoal name="xdoc:jelly-transform">
        <attainGoal name="faq"/>
      </preGoal>

You can also add the faq generation to your project.xml likt this :

      <reports>
        <report>maven-faq-plugin</report>
      <reports>