9439c06e51
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@355240 13f79535-47bb-0310-9956-ffa450edef68
80 lines
2.4 KiB
XML
80 lines
2.4 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2005 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
|
|
<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>. There is an XSD describing the format of the file
|
|
<a href="faq.xsd">here</a>.
|
|
</p>
|
|
<p>
|
|
<strong>Note</strong>: the FAQ description has to be in a file with a
|
|
<code>.fml</code> extension.
|
|
</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, either add the following to your maven.xml:
|
|
</p>
|
|
<source>
|
|
<![CDATA[
|
|
<preGoal name="xdoc:jelly-transform">
|
|
<attainGoal name="faq"/>
|
|
</preGoal>
|
|
]]>
|
|
</source>
|
|
<p>
|
|
or add the faq generation to your project.xml like this:
|
|
</p>
|
|
<source>
|
|
<![CDATA[
|
|
<reports>
|
|
<report>maven-faq-plugin</report>
|
|
<reports>
|
|
]]>
|
|
</source>
|
|
</section>
|
|
<section name="Requirements">
|
|
<p>
|
|
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).
|
|
</p>
|
|
</section>
|
|
</body>
|
|
</document>
|