Added an example FML document to the documentation

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113065 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
jstrachan 2003-03-07 08:34:23 +00:00
parent ed64542a6d
commit a8609496d9
3 changed files with 59 additions and 0 deletions

10
faq/maven.xml Normal file
View File

@ -0,0 +1,10 @@
<project default="plugin:install">
<postGoal name="xdoc:copy-resources">
<copy todir="${basedir}/target/docs">
<fileset dir="${basedir}/xdocs">
<include name="**/*.fml"/>
</fileset>
</copy>
</postGoal>
</project>

42
faq/xdocs/faq.fml Normal file
View File

@ -0,0 +1,42 @@
<?xml version="1.0" encoding="UTF-8"?>
<faqs title="Frequently Asked Questions">
<part id="general">
<title>General</title>
<faq id="whats-foo">
<question>
What is Foo?
</question>
<answer>
<p>some markup goes here</p>
<source>some source code</source>
<p>some markup goes here</p>
</answer>
</faq>
<faq id="whats-bar">
<question>
What is Bar?
</question>
<answer>
<p>some markup goes here</p>
</answer>
</faq>
</part>
<part id="install">
<title>Installation</title>
<faq id="how-install">
<question>
How do I install Foo?
</question>
<answer>
<p>some markup goes here</p>
</answer>
</faq>
</part>
</faqs>

View File

@ -10,6 +10,13 @@
<section name="Maven FAQ Plug-in"> <section name="Maven FAQ Plug-in">
<p> <p>
This plugin generates xdoc documentation from an XML FAQ document. 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>
<p> <p>
The properties that allow you to customize the execution The properties that allow you to customize the execution