a8609496d9
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113065 13f79535-47bb-0310-9956-ffa450edef68
36 lines
1.0 KiB
XML
36 lines
1.0 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 an XML FAQ document.
|
|
This automates the creation of an index of questions with hypertext
|
|
links to the full question and answers.
|
|
</p>
|
|
<p>
|
|
The plugin uses by default a file called <code>xdocs/faq.fml</code>
|
|
to generate the FAQ entry. 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>
|
|
<preGoal name="xdoc:jelly-transform">
|
|
<attainGoal name="faq"/>
|
|
</preGoal>
|
|
</source>
|
|
</section>
|
|
</body>
|
|
</document>
|