diff --git a/faq/xdocs/faq.xsd b/faq/xdocs/faq.xsd new file mode 100644 index 00000000..a07bc43e --- /dev/null +++ b/faq/xdocs/faq.xsd @@ -0,0 +1,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/faq/xdocs/index.xml b/faq/xdocs/index.xml index cc7d1fbd..fa791031 100644 --- a/faq/xdocs/index.xml +++ b/faq/xdocs/index.xml @@ -34,10 +34,10 @@

The plugin uses the xdocs directory by default to generate the FAQ files. There is an example of the XML format - here. - -
- + here. There is an XSD describing the format of the file + here. +

+

Please note that the the FAQ description has to be in a file with a .fml extension.

diff --git a/faq/xdocs/properties.xml b/faq/xdocs/properties.xml index 8ab2e877..0d8ac8ea 100644 --- a/faq/xdocs/properties.xml +++ b/faq/xdocs/properties.xml @@ -30,16 +30,18 @@ PropertyOptional?Description maven.faq.src - Yes (default=${basedir}/xdocs) + Yes - Specifies the source directory for FAQ documents in XML format. + Specifies the source directory for FAQ documents in XML format. + Defaults to the value of maven.docs.src (which is ${basedir}/xdocs). maven.faq.dest - Yes (default=target/generated-xdocs) + Yes Specifies the destination of the generated FAQ documents. + Defaults to the value of maven.gen.docs (which is ${maven.build.dir}/generated-xdocs).