# 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. There is an XSD describing the format of the file here.

Please note that the the FAQ description has to be in a file with a `.fml` extension.

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 like this :

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

# Requirements

Be careful, the following plugins must be installed to use the FAQ plugin :

- maven-plugin-plugin 1.7 (at least)
- maven-xdoc-plugin 1.9.2 (at least)