Maven 1.x FAQ Plugin

Specify in the documentation to use .fml extension files

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.5
  • Component/s: None
  • Labels:
    None
  • Environment:
    N/A
  • Number of attachments :
    1

Description

Hello,

It took me some time to realize that the FAQ files should use a .fml extesion, I has to look for an existing project to get the information.
In fact now that I downloaded the source code, I know that the info was in the changes

Here is the patch to help you include this little documentation update.

? maven-faq-plugin-doc-patch.diff
Index: faq/xdocs/index.xml
===================================================================
RCS file: /home/cvspublic/maven-plugins/faq/xdocs/index.xml,v
retrieving revision 1.4
diff -u -r1.4 index.xml
— faq/xdocs/index.xml 4 Mar 2004 18:05:31 -0000 1.4
+++ faq/xdocs/index.xml 9 Jul 2004 15:54:27 -0000
@@ -35,6 +35,11 @@
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>.
+
+ <br/>
+
+ Please note that the 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
@@ -51,7 +56,7 @@
]]>
</source>
<p>

  • You can also add the faq generation to your project.xml likt this :
    + You can also add the faq generation to your project.xml like this :
    </p>
    <source>
    <![CDATA[

Activity

Hide
Florent Ramiere added a comment -

I guesss this is better as a file attach...

Show
Florent Ramiere added a comment - I guesss this is better as a file attach...

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved:

Time Tracking

Estimated:
1h
Original Estimate - 1 hour
Remaining:
1h
Remaining Estimate - 1 hour
Logged:
Not Specified
Time Spent - Not Specified