[jira] Closed: (MPFAQ-14) Specify in the documentation to use .fml extension files

[ji...@codehaus.org]

Message:

   The following issue has been closed.

---------------------------------------------------------------------
View the issue:
  http://jira.codehaus.org/browse/MPFAQ-14

Here is an overview of the issue:
---------------------------------------------------------------------
        Key: MPFAQ-14
    Summary: Specify in the documentation to use .fml extension files
       Type: Improvement

     Status: Closed
   Priority: Minor
 Resolution: FIXED

 Original Estimate: 1 hour
 Time Spent: Unknown
  Remaining: 1 hour

    Project: maven-faq-plugin

   Assignee: dion gillard
   Reporter: florent ramiere

    Created: Fri, 9 Jul 2004 12:03 PM
    Updated: Fri, 9 Jul 2004 8:07 PM
Environment: N/A

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[

  


---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.

If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa

If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org