ec5499eba5
http://jira.codehaus.org/secure/ViewIssue.jspa?key=MPFAQ-1 [process::MPFAQ-1] git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114463 13f79535-47bb-0310-9956-ffa450edef68
48 lines
1.2 KiB
XML
48 lines
1.2 KiB
XML
<?xml version="1.0"?>
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven FAQ Plug-in</title>
|
|
<author email="jstrachan@apache.org">James Strachan</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Maven FAQ Plug-in">
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
The plugin uses the <code>xdocs</code> directory by default
|
|
to generate the FAQ files. There is an example of the XML format
|
|
<a href="faq.fml">here</a>.
|
|
</p>
|
|
<p>
|
|
The properties that allow you to customize the execution
|
|
are documented <a href="properties.html">here</a>.
|
|
</p>
|
|
<p>
|
|
To enable FAQ generation add the following to your maven.xml
|
|
</p>
|
|
<source>
|
|
<![CDATA[
|
|
<preGoal name="xdoc:jelly-transform">
|
|
<attainGoal name="faq"/>
|
|
</preGoal>
|
|
]]>
|
|
</source>
|
|
<p>
|
|
You can also add the faq generation to your project.xml likt this :
|
|
</p>
|
|
<source>
|
|
<![CDATA[
|
|
<reports>
|
|
<report>maven-faq-plugin</report>
|
|
<reports>
|
|
]]>
|
|
</source>
|
|
</section>
|
|
</body>
|
|
</document>
|