From a1b1046729c91159c265a9f349fa09d2d7a85e9f Mon Sep 17 00:00:00 2001 From: dion Date: Sat, 10 Jul 2004 00:06:59 +0000 Subject: [PATCH] MPFAQ-14. Document fml extension git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115758 13f79535-47bb-0310-9956-ffa450edef68 --- faq/project.xml | 2 +- faq/xdocs/changes.xml | 3 +++ faq/xdocs/index.xml | 7 ++++++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/faq/project.xml b/faq/project.xml index ed1c8a8c..726e9119 100644 --- a/faq/project.xml +++ b/faq/project.xml @@ -23,7 +23,7 @@ 3 maven-faq-plugin Maven FAQ Plug-in - 1.4 + 1.4.1-SNAPSHOT jakarta Creates XDoc documentation from an FAQ XML document. FAQ Plugin diff --git a/faq/xdocs/changes.xml b/faq/xdocs/changes.xml index 78bced2f..cba2823c 100644 --- a/faq/xdocs/changes.xml +++ b/faq/xdocs/changes.xml @@ -24,6 +24,9 @@ dIon Gillard + + Document .fml extension requirement + Correctly pass through CDATA content Make sure maven.faq.src exists to avoid exceptions diff --git a/faq/xdocs/index.xml b/faq/xdocs/index.xml index 617f21a6..462056cd 100644 --- a/faq/xdocs/index.xml +++ b/faq/xdocs/index.xml @@ -35,6 +35,11 @@ The plugin uses the xdocs directory by default to generate the FAQ files. There is an example of the XML format here. + +
+ + Please note that the the FAQ description has to be in a file with a + .fml extension.

The properties that allow you to customize the execution @@ -51,7 +56,7 @@ ]]>

- 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 :