PR: MPFAQ-17, MPFAQ-18

Submitted by: Jeff Jensen
Reviewed by:  Brett Porter
Improve documentation, and add an XSD for the FAQ format.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@170204 13f79535-47bb-0310-9956-ffa450edef68

faq/xdocs/faq.xsd

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    elementFormDefault="qualified">
+
+    <xsd:element name="title" type="xsd:string"/>
+    <xsd:element name="question" type="anything"/>
+    <xsd:element name="answer" type="anything"/>
+
+    <xsd:complexType name="anything">
+        <xsd:sequence>
+            <xsd:any namespace="##any" processContents="lax"
+                minOccurs="0" maxOccurs="unbounded" /> 
+        </xsd:sequence>
+        <xsd:anyAttribute namespace="##other" processContents="lax" /> 
+    </xsd:complexType>    
+
+    <xsd:element name="faq">
+        <xsd:complexType>
+            <xsd:sequence>
+                <xsd:element ref="question"/>
+                <xsd:element ref="answer"/>
+            </xsd:sequence>
+            <xsd:attribute name="id" type="xsd:string" use="required"/>
+        </xsd:complexType>
+    </xsd:element>
+
+    <xsd:element name="part">
+        <xsd:complexType>
+            <xsd:sequence>
+                <xsd:element ref="title"/>
+                <xsd:element ref="faq" minOccurs="1" maxOccurs="unbounded"/>
+            </xsd:sequence>
+            <xsd:attribute name="id" type="xsd:string" use="required"/>
+        </xsd:complexType>
+    </xsd:element>
+
+    <xsd:element name="faqs">
+        <xsd:complexType>
+            <xsd:sequence>
+                <xsd:element ref="part" minOccurs="1" maxOccurs="unbounded"/>
+            </xsd:sequence>
+            <xsd:attribute name="title" type="xsd:string" use="optional"/>
+        </xsd:complexType>
+    </xsd:element>
+
+</xsd:schema>

faq/xdocs/index.xml

@@ -34,10 +34,10 @@
       <p>
         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/>
-        
+        <a href="faq.fml">here</a>. There is an XSD describing the format of the file
+        <a href="faq.xsd">here</a>.
+      </p>  
+      <p>  
         Please note that the the FAQ description has to be in a file with a
         <code>.fml</code> extension.
       </p>

faq/xdocs/properties.xml

@@ -30,16 +30,18 @@
         <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
         <tr>
           <td>maven.faq.src</td>
-          <td>Yes (default=${basedir}/xdocs)</td>
+          <td>Yes</td>
           <td>
-          	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).
           </td>
         </tr>
         <tr>
           <td>maven.faq.dest</td>
-          <td>Yes (default=target/generated-xdocs)</td>
+          <td>Yes</td>
           <td>
             Specifies the destination of the generated FAQ documents.
+            Defaults to the value of maven.gen.docs (which is ${maven.build.dir}/generated-xdocs).
           </td>
         </tr>
       </table>