jvanzyl 2003/12/08 16:57:58
Modified: faq plugin.jelly
faq/xdocs index.xml
Log:
o applying patch for MPFAQ-1
http://jira.codehaus.org/secure/ViewIssue.jspa?key=MPFAQ-1
[process::MPFAQ-1]
Revision Changes Path
1.13 +6 -4 maven-plugins/faq/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/maven-plugins/faq/plugin.jelly,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- plugin.jelly 24 Nov 2003 19:38:46 -0000 1.12
+++ plugin.jelly 9 Dec 2003 00:57:58 -0000 1.13
@@ -69,14 +69,16 @@
<x:set var="root" select="$doc/*"/>
<!-- produce a output xdoc xml file from parsed .fml source -->
- <j:file name="${outFile}" encoding="${outputencoding}" outputMode="xml">
+ <j:file name="${outFile}" encoding="${outputencoding}" outputMode="xml"
escapeText="false">
<document>
<properties>
- <title><x:expr select="$root/title"/></title>
+ <x:element name="title"><x:expr select="$root/@title"/></x:element>
</properties>
<body>
- <section name="Frequently Asked Questions">
+ <x:element name="section">
+ <x:attribute name="name"><x:expr select="$root/@title"/></x:attribute>
+
<x:forEach select="$root/part">
<p>
<strong><x:expr select="title"/></strong>
@@ -92,7 +94,7 @@
</x:forEach>
</ol>
</x:forEach>
- </section>
+ </x:element>
<x:forEach select="$root/part">
<x:element name="section">
1.3 +18 -6 maven-plugins/faq/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/faq/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 7 Mar 2003 08:34:23 -0000 1.2
+++ index.xml 9 Dec 2003 00:57:58 -0000 1.3
@@ -9,13 +9,13 @@
<body>
<section name="Maven FAQ Plug-in">
<p>
- This plugin generates xdoc documentation from an XML
FAQ document.
+ 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 by default a file called <code>xdocs/faq.fml</code>
- to generate the FAQ entry. There is an example of the XML format
+ 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>
@@ -26,9 +26,21 @@
To enable FAQ generation add the following to your maven.xml
</p>
<source>
- <preGoal name="xdoc:jelly-transform">
- <attainGoal name="faq"/>
- </preGoal>
+ <![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>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
