Author: brett
Date: Sun May 15 00:36:59 2005
New Revision: 170204
URL: http://svn.apache.org/viewcvs?rev=170204&view=rev
Log:
PR: MPFAQ-17, MPFAQ-18
Submitted by: Jeff Jensen
Reviewed by: Brett Porter
Improve documentation, and add an XSD for the FAQ format.
Added:
maven/maven-1/plugins/trunk/faq/xdocs/faq.xsd
Modified:
maven/maven-1/plugins/trunk/faq/xdocs/index.xml
maven/maven-1/plugins/trunk/faq/xdocs/properties.xml
Added: maven/maven-1/plugins/trunk/faq/xdocs/faq.xsd
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/faq/xdocs/faq.xsd?rev=170204&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/faq/xdocs/faq.xsd (added)
+++ maven/maven-1/plugins/trunk/faq/xdocs/faq.xsd Sun May 15 00:36:59 2005
@@ -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>
Modified: maven/maven-1/plugins/trunk/faq/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/faq/xdocs/index.xml?rev=170204&r1=170203&r2=170204&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/faq/xdocs/index.xml (original)
+++ maven/maven-1/plugins/trunk/faq/xdocs/index.xml Sun May 15 00:36:59 2005
@@ -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>
Modified: maven/maven-1/plugins/trunk/faq/xdocs/properties.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/faq/xdocs/properties.xml?rev=170204&r1=170203&r2=170204&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/faq/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/faq/xdocs/properties.xml Sun May 15 00:36:59
2005
@@ -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>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
