You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-commits@maven.apache.org by vs...@apache.org on 2009/01/28 15:10:12 UTC
svn commit: r738491 - in /maven/doxia/site/src/site: fml/faq.fml
xdoc/references/fml-format.xml xdoc/references/xdoc-format.xml
Author: vsiveton
Date: Wed Jan 28 14:10:12 2009
New Revision: 738491
URL: http://svn.apache.org/viewvc?rev=738491&view=rev
Log:
o update documentation
Modified:
maven/doxia/site/src/site/fml/faq.fml
maven/doxia/site/src/site/xdoc/references/fml-format.xml
maven/doxia/site/src/site/xdoc/references/xdoc-format.xml
Modified: maven/doxia/site/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/fml/faq.fml?rev=738491&r1=738490&r2=738491&view=diff
==============================================================================
--- maven/doxia/site/src/site/fml/faq.fml (original)
+++ maven/doxia/site/src/site/fml/faq.fml Wed Jan 28 14:10:12 2009
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -19,7 +19,10 @@
under the License.
-->
-<faqs title="Frequently Asked Questions">
+<faqs xmlns="http://maven.apache.org/FML/1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/FML/1.0 file:../../../../doxia/doxia-modules/doxia-module-fml/src/main/resources/fml-1.0.xsd"
+ title="Frequently Asked Questions">
<part id="General">
<faq id="How_to_handle_style_in_the_APT_markup_language">
<question>How to handle style in the APT markup language?</question>
@@ -75,12 +78,25 @@
</faq>
<!-- TODO need to publish XSD files -->
<faq id="doxia-xsd">
- <question>Where are the Maven Doxia XSD schemas for Xdoc and FML files?</question>
+ <question>Where are the Maven Doxia XSD schemas files?</question>
<answer>
<p>
- The Xdoc XSD is located <a href="http://maven.apache.org/xsd/xdoc-2.0.xsd">here</a> and
- the FML XSD is located <a href="http://maven.apache.org/xsd/fml-1.0.xsd">here</a>.
+ The Doxia XSD files are located here:
</p>
+
+ <dl>
+ <dt>Xdoc XSD 2.0</dt>
+ <dd><a href="http://maven.apache.org/xsd/xdoc-2.0.xsd">http://maven.apache.org/xsd/xdoc-2.0.xsd</a></dd>
+ <dt>FML XSD 1.0</dt>
+ <dd><a href="http://maven.apache.org/xsd/fml-1.0.xsd">http://maven.apache.org/xsd/fml-1.0.xsd</a></dd>
+ <dt>Book XSD 1.0</dt>
+ <dd><a href="http://maven.apache.org/xsd/book-1.0.0.xsd">http://maven.apache.org/xsd/book-1.0.0.xsd</a></dd>
+ <dt>Document XSD 1.0</dt>
+ <dd><a href="http://maven.apache.org/xsd/document-1.0.0.xsd">http://maven.apache.org/xsd/document-1.0.0.xsd</a></dd>
+ <dt>Decoration XSD 1.0</dt>
+ <dd><a href="http://maven.apache.org/xsd/decoration-1.0.0.xsd">http://maven.apache.org/xsd/decoration-1.0.0.xsd</a></dd>
+ </dl>
+
<p>
Your favorite IDE probably supports XSD schema's for Xdoc and FML files. You need to
specify the following:
@@ -96,6 +112,25 @@
xsi:schemaLocation="http://maven.apache.org/FML/1.0 http://maven.apache.org/xsd/fml-1.0.xsd">
...
</faqs></source>
+ <source>
+<book xmlns="http://maven.apache.org/BOOK/1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/BOOK/1.0.0 http://maven.apache.org/xsd/book-1.0.0.xsd">
+ ...
+</book></source>
+ <source>
+<document xmlns="http://maven.apache.org/DOCUMENT/1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DOCUMENT/1.0.0 http://maven.apache.org/xsd/document-1.0.0.xsd"
+ outputName="...">
+ ...
+</document></source>
+ <source>
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+ ...
+</project></source>
</p>
</answer>
</faq>
Modified: maven/doxia/site/src/site/xdoc/references/fml-format.xml
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/xdoc/references/fml-format.xml?rev=738491&r1=738490&r2=738491&view=diff
==============================================================================
--- maven/doxia/site/src/site/xdoc/references/fml-format.xml (original)
+++ maven/doxia/site/src/site/xdoc/references/fml-format.xml Wed Jan 28 14:10:12 2009
@@ -1,4 +1,5 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
+
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
@@ -16,8 +17,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
- -->
-<document>
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 file:../../../../../doxia/doxia-modules/doxia-module-xdoc/src/main/resources/xdoc-2.0.xsd">
<properties>
<title>The FML (FAQ Markup Language) format</title>
@@ -25,27 +29,31 @@
</properties>
<body>
-
<section name="The FML format">
-
<subsection name="Overview">
-
<p>
- An 'fml' is an XML document conforming to a small and simple set of tags.
+ An 'fml' (FAQ Markup Language) is an XML document conforming to a small and simple set of tags.
The format was first used in the <a href="http://maven.apache.org/maven-1.x/">Maven 1</a>,
version of the <a href="http://maven.apache.org/maven-1.x/plugins/faq/">FAQ plugin</a>.
</p>
-
</subsection>
<subsection name="The FML format">
+ <p>
+ The full documentation is available at <a href="doxia/doxia-modules/doxia-module-fml/xsddoc/index.html">here</a>.
+ </p>
+ </subsection>
+ <subsection name="FML Sample">
<p>
The following is a sample FML document:
</p>
<source><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
-
-<faqs title="Frequently Asked Questions" toplink="false">
+<faqs xmlns="http://maven.apache.org/FML/1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/FML/1.0 http://maven.apache.org/xsd/fml-1.0.xsd"
+ title="Frequently Asked Questions"
+ toplink="false">
<part id="general">
<title>General</title>
@@ -92,9 +100,14 @@
]]></source>
</subsection>
+ </section>
+ <section name="Validation">
+ <p>
+ Doxia is able to validate your fml files as described
+ <a href="doxia/doxia-modules/doxia-module-fml/using-fml-xsd.html">here</a>.
+ </p>
</section>
</body>
-
</document>
Modified: maven/doxia/site/src/site/xdoc/references/xdoc-format.xml
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/xdoc/references/xdoc-format.xml?rev=738491&r1=738490&r2=738491&view=diff
==============================================================================
--- maven/doxia/site/src/site/xdoc/references/xdoc-format.xml (original)
+++ maven/doxia/site/src/site/xdoc/references/xdoc-format.xml Wed Jan 28 14:10:12 2009
@@ -1,4 +1,5 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
+
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
@@ -16,8 +17,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
- -->
-<document>
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 file:../../../../../doxia/doxia-modules/doxia-module-xdoc/src/main/resources/xdoc-2.0.xsd">
<properties>
<title>The Xdoc format</title>
@@ -25,11 +29,8 @@
</properties>
<body>
-
<section name="The XDoc format">
-
<subsection name="Overview">
-
<p>
An 'xdoc' is an XML document conforming to a small and simple set of tags.
Xdoc was the primary documentation format in <a href="http://maven.apache.org/maven-1.x/">Maven 1</a>,
@@ -46,16 +47,22 @@
The Maven 1 Xdoc plugin introduced a few additions to the Anakia format, they are highlighted in the
<a href="http://maven.apache.org/maven-1.x/plugins/xdoc/reference/xdocs.html">plugin</a> documentation.
</p>
-
</subsection>
- <subsection name="The XDoc format">
+ <subsection name="The XDOC format">
+ <p>
+ The full documentation is available at <a href="doxia/doxia-modules/doxia-module-xdoc/xsddoc/index.html">here</a>.
+ </p>
+ </subsection>
+ <subsection name="XDoc Sample">
<p>
The following is a sample XDoc document:
</p>
- <source><![CDATA[
-<document>
+ <source><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Page Title</title>
@@ -99,7 +106,6 @@
</subsection>
<subsection name="Additional sectioning">
-
<p>
Doxia will produce <code><h2></code> and
<code><h3></code> headings for <code><section></code>
@@ -116,11 +122,9 @@
</p>
<h4>A subsubsection</h4>
-
</subsection>
<subsection name="Referencing sections and subsections">
-
<p>
The core doxia modules do <b>not</b> construct anchors from
section/subsection names. If you want to reference a section,
@@ -177,17 +181,12 @@
</p>
</subsection>
-
</section>
<section name="Validation">
-
<p>
- Doxia is currently not able to validate your xdoc files as no schema or DTD
- exists yet (however this is planned before the 1.0 release).
- It is therefore necessary to check manually whether your source files are valid xdocs,
- this should ensure that the generated html files are valid
- <a href="http://www.w3.org/TR/xhtml1/">XHTML1-transitional</a>.
+ Doxia is able to validate your xdoc files as described
+ <a href="doxia/doxia-modules/doxia-module-xdoc/using-xdoc-xsd.html">here</a>.
</p>
<p>