jstrachan 2003/03/07 00:34:23
Modified: src/plugins-build/faq/xdocs index.xml
Added: src/plugins-build/faq/xdocs faq.fml
src/plugins-build/faq maven.xml
Log:
Added an example FML document to the documentation
Revision Changes Path
1.2 +7 -0 jakarta-turbine-maven/src/plugins-build/faq/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/faq/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 6 Mar 2003 19:59:47 -0000 1.1
+++ index.xml 7 Mar 2003 08:34:23 -0000 1.2
@@ -10,6 +10,13 @@
<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
1.1 jakarta-turbine-maven/src/plugins-build/faq/xdocs/faq.fml
Index: faq.fml
===================================================================
<?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>
1.1 jakarta-turbine-maven/src/plugins-build/faq/maven.xml
Index: maven.xml
===================================================================
<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>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
