Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

o applying patch for MPFAQ-1

Browse Source 
http://jira.codehaus.org/secure/ViewIssue.jspa?key=MPFAQ-1

[process::MPFAQ-1]


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114463 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
jvanzyl 2003-12-09 00:57:58 +00:00
parent 83d3451892
commit ec5499eba5
2 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
faq/plugin.jelly
View File

@ -69,14 +69,16 @@
<x:set var="root" select="$doc/*"/> <x:set var="root" select="$doc/*"/>
<!-- produce a output xdoc xml file from parsed .fml source --> <!-- 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> <document>
<properties> <properties>
<title><x:expr select="$root/title"/></title> <x:element name="title"><x:expr select="$root/@title"/></x:element>
</properties> </properties>
<body> <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"> <x:forEach select="$root/part">
<p> <p>
<strong><x:expr select="title"/></strong> <strong><x:expr select="title"/></strong>
@ -92,7 +94,7 @@
</x:forEach> </x:forEach>
</ol> </ol>
</x:forEach> </x:forEach>
</section> </x:element>
<x:forEach select="$root/part"> <x:forEach select="$root/part">
<x:element name="section"> <x:element name="section">

24
faq/xdocs/index.xml
View File

@ -9,13 +9,13 @@
<body> <body>
<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 XML FAQ documents.
This automates the creation of an index of questions with hypertext This automates the creation of an index of questions with hypertext
links to the full question and answers. links to the full question and answers.
</p> </p>
<p> <p>
The plugin uses by default a file called <code>xdocs/faq.fml</code> The plugin uses the <code>xdocs</code> directory by default
to generate the FAQ entry. There is an example of the XML format to generate the FAQ files. There is an example of the XML format
<a href="faq.fml">here</a>. <a href="faq.fml">here</a>.
</p> </p>
<p> <p>
@ -26,9 +26,21 @@
To enable FAQ generation add the following to your maven.xml To enable FAQ generation add the following to your maven.xml
</p> </p>
<source> <source>
&lt;preGoal name="xdoc:jelly-transform"&gt; <![CDATA[
&lt;attainGoal name="faq"/&gt; <preGoal name="xdoc:jelly-transform">
&lt;/preGoal&gt; <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> </source>
</section> </section>
</body> </body>