Apache Maven 1.x has reached its end of life, and is no longer supported. For more information, see the announcement. Users are encouraged to migrate to the current version of Apache Maven.

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.

Note: 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, either add the following to your maven.xml:

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

or add the faq generation to your project.xml like this:



There are no special requirements for using this plugin. However, there were some font-size and layout bugs in early versions of the maven-xdoc-plugin (versions <= 1.9.1), for best results we recommend to use the FAQ plugin together with maven-xdoc-plugin 1.9.2 (at least).