You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bu...@apache.org on 2012/03/01 19:57:02 UTC
svn commit: r806928 [6/8] - in /websites/staging/maventest-doxia/trunk: ./
content/ content/book/ content/css/ content/developers/
content/doxia-example-book/ content/images/ content/images/logos/
content/issues/ content/macros/ content/modules/ conten...
Added: websites/staging/maventest-doxia/trunk/content/images/icon_error_sml.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/icon_error_sml.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: websites/staging/maventest-doxia/trunk/content/images/icon_info_sml.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/icon_info_sml.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: websites/staging/maventest-doxia/trunk/content/images/icon_success_sml.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/icon_success_sml.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: websites/staging/maventest-doxia/trunk/content/images/icon_warning_sml.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/icon_warning_sml.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: websites/staging/maventest-doxia/trunk/content/images/logo_apache.jpg
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/logo_apache.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: websites/staging/maventest-doxia/trunk/content/images/logo_maven.jpg
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/logo_maven.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: websites/staging/maventest-doxia/trunk/content/images/logos/build-by-maven-black.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/logos/build-by-maven-black.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: websites/staging/maventest-doxia/trunk/content/images/logos/build-by-maven-white.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/logos/build-by-maven-white.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: websites/staging/maventest-doxia/trunk/content/images/logos/maven-feather.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/logos/maven-feather.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: websites/staging/maventest-doxia/trunk/content/images/maven-logo-2.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/maven-logo-2.gif
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: websites/staging/maventest-doxia/trunk/content/images/newwindow.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maventest-doxia/trunk/content/images/newwindow.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: websites/staging/maventest-doxia/trunk/content/index.html
==============================================================================
--- websites/staging/maventest-doxia/trunk/content/index.html (added)
+++ websites/staging/maventest-doxia/trunk/content/index.html Thu Mar 1 18:57:00 2012
@@ -0,0 +1,185 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Mar 1, 2012 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Introduction</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Jason van Zyl
+Vincent Siveton" />
+ <meta name="Date-Creation-yyyymmdd" content="20100528" />
+ <meta name="Date-Revision-yyyymmdd" content="20120301" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+ <img src="images/apache-maven-project-2.png" alt="" />
+ </a>
+ <a href="./" id="bannerRight">
+ <img src="images/maven-logo-2.gif" alt="" />
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../index.html">Maven</a>
+ >
+ <a href="index.html">Doxia</a>
+ >
+ Introduction
+ </div>
+ <div class="xright">
+ Last Published: 2012-03-01
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>About Doxia</h5>
+ <ul>
+ <li class="none">
+ <strong>What is Doxia?</strong>
+ </li>
+ <li class="none">
+ <a href="overview.html">Overview</a>
+ </li>
+ <li class="collapsed">
+ <a href="upgrading.html">Upgrading</a>
+ </li>
+ <li class="none">
+ <a href="downloads.html">Downloads</a>
+ </li>
+ <li class="none">
+ <a href="jira-report.html">Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="references/index.html">Format References</a>
+ </li>
+ <li class="none">
+ <a href="modules/index.html">Doxia Modules Guide</a>
+ </li>
+ <li class="none">
+ <a href="macros/index.html">Doxia Macros Guide</a>
+ </li>
+ <li class="none">
+ <a href="book/index.html">Writing Books</a>
+ </li>
+ <li class="none">
+ <a href="issues/index.html">Issues & Gotchas</a>
+ </li>
+ <li class="none">
+ <a href="resources.html">External Resources</a>
+ </li>
+ </ul>
+ <h5>Developer Docs</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="developers/index.html">Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="doxia/index.html">Doxia 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-sitetools/index.html">Doxia Sitetools 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-1.0.x/index.html">Doxia 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-sitetools-1.0.x/index.html">Doxia Sitetools 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-tools/index.html">Doxia Tools</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <strong>Doxia</strong>
+ </li>
+ <li class="none">
+ <a href="../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../mercury/index.html">Mercury</a>
+ </li>
+ <li class="none">
+ <a href="../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="./images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Maven Doxia<a name="Maven_Doxia"></a></h2><p>Doxia is a content generation framework which aims to provide its users with powerful techniques for generating static and dynamic content: Doxia can be used in web-based publishing context to generate static sites, in addition to being incorporated into dynamic content generation systems like blogs, wikis and content management systems.</p><p>Doxia supports markup languages with simple syntaxes. Lightweight markup languages are used by people who might be expected to read the document source as well as the rendered output.</p><p>Doxia is used extensively by <a class="externalLink" href="http://maven.apache.org">Maven</a> and it powers the entire documentation system of Maven. It gives Maven the ability to take any document that Doxia supports and output it any format.</p><p>The current version of Doxia is 1.2.</p><div class="section"><h3>Maven Doxia Enhancements<a name="Maven_Doxia_
Enhancements"></a></h3><ul><li><a href="./jira-report.html">Release Notes for 1.2</a></li><li><a href="./upgrading.html">Upgrading from earlier versions</a></li></ul></div><div class="section"><h3>Brief History<a name="Brief_History"></a></h3><!-- {{{http://www.xmlmind.com/aptconvert.html}Aptconvert}} --><p>Based on the (now defunct) Aptconvert project developed by <a class="externalLink" href="http://www.xmlmind.com/">Xmlmind</a>, Doxia was initially hosted by <a class="externalLink" href="http://codehaus.org/">Codehaus</a>, to become a sub-project of Maven early in 2006.</p></div><div class="section"><h3>Main Features<a name="Main_Features"></a></h3><ul><li>Developed in Java</li><li>Support of several markup formats: APT (Almost Plain Text), Confluence, Simplified DocBook, FML (FAQ Markup Language), FO, iText, LaTeX, RTF, TWiki, XDoc (popular in Apache land), XHTML</li><li>Easy to learn the syntax of the supported markup formats</li><li>Macro support</li><li>No need to hav
e a corporate infrastructure (like wiki) to host your documentation</li><li>Extensible framework</li><li>Additional Tools like <a href="./doxia-tools/doxia-converter/index.html">Doxia Converter</a></li></ul></div><div class="section"><h3>Doxia Reference Pages<a name="Doxia_Reference_Pages"></a></h3><p>References pages listing all supported markups for each format.</p><ul><li><a href="./references/doxia-apt.html">Apt Format</a></li><li><a href="./references/fml-format.html">FML Format</a></li><li><a href="./references/xdoc-format.html">Xdoc Format</a></li></ul></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maventest-doxia/trunk/content/issues/index.html
==============================================================================
--- websites/staging/maventest-doxia/trunk/content/issues/index.html (added)
+++ websites/staging/maventest-doxia/trunk/content/issues/index.html Thu Mar 1 18:57:00 2012
@@ -0,0 +1,195 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Mar 1, 2012 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Doxia Issues</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Lukas Theussl" />
+ <meta name="Date-Creation-yyyymmdd" content="20090302" />
+ <meta name="Date-Revision-yyyymmdd" content="20120301" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../" id="bannerLeft">
+ <img src="../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <a href=".././" id="bannerRight">
+ <img src="../images/maven-logo-2.gif" alt="" />
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ <a href="../index.html">Doxia</a>
+ >
+ Doxia Issues
+ </div>
+ <div class="xright">
+ Last Published: 2012-03-01
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>About Doxia</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">What is Doxia?</a>
+ </li>
+ <li class="none">
+ <a href="../overview.html">Overview</a>
+ </li>
+ <li class="collapsed">
+ <a href="../upgrading.html">Upgrading</a>
+ </li>
+ <li class="none">
+ <a href="../downloads.html">Downloads</a>
+ </li>
+ <li class="none">
+ <a href="../jira-report.html">Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../references/index.html">Format References</a>
+ </li>
+ <li class="none">
+ <a href="../modules/index.html">Doxia Modules Guide</a>
+ </li>
+ <li class="none">
+ <a href="../macros/index.html">Doxia Macros Guide</a>
+ </li>
+ <li class="none">
+ <a href="../book/index.html">Writing Books</a>
+ </li>
+ <li class="none">
+ <strong>Issues & Gotchas</strong>
+ </li>
+ <li class="none">
+ <a href="../resources.html">External Resources</a>
+ </li>
+ </ul>
+ <h5>Developer Docs</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../developers/index.html">Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../doxia/index.html">Doxia 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools/index.html">Doxia Sitetools 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-1.0.x/index.html">Doxia 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools-1.0.x/index.html">Doxia Sitetools 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-tools/index.html">Doxia Tools</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../mercury/index.html">Mercury</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Doxia Issues & Gotchas<a name="Doxia_Issues__Gotchas"></a></h2><p>This document collects some infos about specific issues and 'gotchas' when working with Doxia. Please check also the <a href="../faq.apt">Frequently Asked Questions</a>.</p><ul><li><a href="#Apt_anchors_and_links">Apt anchors and links</a></li><li><a href="#TOC_macro_issues">TOC macro issues</a></li><li><a href="#Verbatim_blocks_not_boxed">Verbatim blocks not boxed</a></li><li><a href="#Figure_sink_events">Figure sink events</a></li><li><a href="#Empty_Generated_Page">Empty Generated Page</a></li></ul><div class="section"><h3><a name="Apt_anchors_and_links">Apt anchors and links</a></h3><p>Using <b>Doxia 1.1</b> you may see a lot of warnings when processing old Apt source files:</p><div class="source"><pre>[WARNING] [Apt Parser] Ambiguous link: 'doxia-apt.html'. If this is a local link, prepend "./"!</pre></div><p>and</p><div class="source"><pre>[WA
RNING] [Apt Parser] Modified invalid link: references/doxia-apt.html</pre></div><p>The reason is that in Apt, links to other source documents have to start with either <tt>./</tt> or <tt>../</tt> to distinguish them from internal links. Please read the sections on <a href="../references/doxia-apt.html#Anchors">anchors</a> and <a href="../references/doxia-apt.html#Links">links</a> in our Apt guide. Note in particular that internal links in Apt do <b>not</b> start with '#'.</p><p><b>You should pay attention to these warnings since your links will most likely be broken.</b> Unfortunately, the warning message cannot indicate the source file with the broken link (see eg <a class="externalLink" href="http://jira.codehaus.org/browse/MPDF-11">MPDF-11</a>), however, if you run in <tt>DEBUG</tt> mode, eg invoke maven with the <tt>-X</tt> switch, you can see which source document is being parsed when the warning is emitted.</p></div><div class="section"><h3><a name="TOC_macro_issues">T
OC macro issues</a></h3><p>There was a particular <a class="externalLink" href="http://jira.codehaus.org/browse/DOXIA-316">bug</a> in the TOC macro in version 1.0 that has been fixed but leads to a backward incompatibility in some cases. If you have specified the <tt>section</tt> parameter in your TOC, as for instance:</p><div class="source"><pre>%{toc|section=1|fromDepth=1|toDepth=1}</pre></div><p>then the generated TOC is probably different from the result with Doxia 1.0. In <b>Doxia 1.1</b>, depth=1 is section, depth=2 is sub-section, etc, as documented in the <a href="../macros/index.html#TOC_Macro">macro guide</a>.</p></div><div class="section"><h3><a name="Verbatim_blocks_not_boxed">Verbatim blocks not boxed</a></h3><p>There was a particular <a class="externalLink" href="http://jira.codehaus.org/browse/DOXIA-297">bug</a> in Doxia 1.0 that verbatim blocks were always boxed. If after an upgrade to <b>Doxia 1.1</b> you find that your blocks are not boxed anymore, check th
at you actually start your verbatim block with <tt>+--</tt> (and not <tt>---</tt>).</p></div><div class="section"><h3><a name="Figure_sink_events">Figure sink events</a></h3><p>Doxia distinguishes between figures, which are block-level elements, and images (or icons), which are in-line elements. For instance, the following sequence of sink events</p><div class="source"><pre>sink.figure( null );
+
+sink.figureGraphics( "figure.png", null );
+
+sink.figureCaption( null );
+sink.text( "Figure caption", null );
+sink.figureCaption_();
+
+sink.figure_();</pre></div><p>should output the equivalent of this html snippet:</p><div class="source"><pre><div class="figure">
+ <p><img src="figure.png"/></p>
+ <p>Figure caption</p>
+</div></pre></div><p>while the <tt>figureGraphics( ... );</tt> event alone can be used to generate an in-line image, i.e. just the <tt><img></tt> tag in case of html.</p><p><b>Note</b> that we are using the forms that take a <tt>SinkEventAttributeSet</tt> above, even though we are just passing in null values. The reason is that the alternative forms (without <tt>SinkEventAttributeSet</tt>) have a different behavior, which is kept for backward compatibility (but the methods have been deprecated). Using the same sequence of sink events as above, but omitting the <tt>null</tt> method parameters, will generate</p><div class="source"><pre><img src="figure.png" alt="Figure caption"/></pre></div></div><div class="section"><h3><a name="Empty_Generated_Page">Empty Generated Page</a></h3><p>After running <tt>mvn site</tt> using your Maven reporting plugin, you see that the generated page is empty. Be sure that the the code calls <tt>sink.close()</
tt>.</p></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maventest-doxia/trunk/content/macros/index.html
==============================================================================
--- websites/staging/maventest-doxia/trunk/content/macros/index.html (added)
+++ websites/staging/maventest-doxia/trunk/content/macros/index.html Thu Mar 1 18:57:00 2012
@@ -0,0 +1,223 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Mar 1, 2012 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Doxia Macros Guide</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Vincent Siveton" />
+ <meta name="Date-Creation-yyyymmdd" content="20090302" />
+ <meta name="Date-Revision-yyyymmdd" content="20120301" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../" id="bannerLeft">
+ <img src="../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <a href=".././" id="bannerRight">
+ <img src="../images/maven-logo-2.gif" alt="" />
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ <a href="../index.html">Doxia</a>
+ >
+ Doxia Macros Guide
+ </div>
+ <div class="xright">
+ Last Published: 2012-03-01
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>About Doxia</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">What is Doxia?</a>
+ </li>
+ <li class="none">
+ <a href="../overview.html">Overview</a>
+ </li>
+ <li class="collapsed">
+ <a href="../upgrading.html">Upgrading</a>
+ </li>
+ <li class="none">
+ <a href="../downloads.html">Downloads</a>
+ </li>
+ <li class="none">
+ <a href="../jira-report.html">Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../references/index.html">Format References</a>
+ </li>
+ <li class="none">
+ <a href="../modules/index.html">Doxia Modules Guide</a>
+ </li>
+ <li class="none">
+ <strong>Doxia Macros Guide</strong>
+ </li>
+ <li class="none">
+ <a href="../book/index.html">Writing Books</a>
+ </li>
+ <li class="none">
+ <a href="../issues/index.html">Issues & Gotchas</a>
+ </li>
+ <li class="none">
+ <a href="../resources.html">External Resources</a>
+ </li>
+ </ul>
+ <h5>Developer Docs</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../developers/index.html">Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../doxia/index.html">Doxia 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools/index.html">Doxia Sitetools 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-1.0.x/index.html">Doxia 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools-1.0.x/index.html">Doxia Sitetools 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-tools/index.html">Doxia Tools</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../mercury/index.html">Mercury</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Doxia Macros Guide<a name="Doxia_Macros_Guide"></a></h2><p>The Doxia <i>Core</i> includes macro mechanisms to facilitate the documentation writing.</p><p>Macros are currently only supported for the standard Maven input formats APT and Xdoc. Support in FML files will be added in a <a class="externalLink" href="http://jira.codehaus.org/browse/DOXIA-281">future version</a> of Doxia. Macros are not (and probably will never be) supported by Confluence, Docbook, Twiki and XHTML modules.</p><p>A macro in an APT source file is a <b>non-indented</b> line that looks like this:</p><div class="source"><pre>%{macro_name|param1=value1|param2=value2|...}</pre></div><p>An Xdoc macro has the following syntax:</p><div class="source"><pre><macro name="macro_name">
+ <param name="param1" value="value1"/>
+ <param name="param2" value="value2"/>
+ ...
+</macro></pre></div><p>As of Doxia 1.1, the following macros are available:</p><ul><li><a href="#Echo_Macro">Echo Macro</a></li><li><a href="#Snippet_Macro">Snippet Macro</a></li><li><a href="#TOC_Macro">TOC Macro</a></li><li><a href="#SWF_Macro">SWF Macro</a></li></ul><div class="section"><h3><a name="Echo_Macro">Echo Macro</a></h3><p>The <i>Echo</i> macro is a very simple macro: it prints out the key and value of any supplied parameters. For instance, in an APT file, you could write:</p><div class="source"><pre>%{echo|param1=value1|param2=value2}</pre></div><p>Similarly, it will be for xdoc file:</p><div class="source"><pre><macro name="echo">
+ <param name="param1" value="value1"/>
+ <param name="param2" value="value2"/>
+</macro></pre></div><p>and it will output</p><div class="source"><pre> param1 ---> value1
+ param2 ---> value2</pre></div></div><div class="section"><h3><a name="Snippet_Macro">Snippet Macro</a></h3><p>The <i>Snippet</i> macro is a very useful macro: it prints out the content of a file or a URL. For instance, in an APT file, you could write:</p><div class="source"><pre>%{snippet|id=myid|url=http://myserver/path/to/file.txt}</pre></div><p>In a xdoc file, it will be:</p><div class="source"><pre><macro name="snippet">
+ <param name="id" value="myid"/>
+ <param name="url" value="http://myserver/path/to/file.txt"/>
+</macro></pre></div><p>The <tt>id</tt> parameter is not required if you want to include the entire file. If you want to include only a part of a file, you should add start and end demarcators: any line (typically a comment) that contains the strings "<tt>START</tt>", "<tt>SNIPPET</tt>" and "<tt>myid</tt>" (where <tt>myid</tt> is the <tt>id</tt> of the snippet) is a start demarcator, and similarly "<tt>END SNIPPET myid</tt>" denotes the end of the snippet to include. For example:</p><ul><li>Start and end snippets in a Java file<div class="source"><pre>public class MyClass
+{
+ // START SNIPPET: myid
+ public static void main( String[] args ) throws Exception
+ {
+ ...
+ }
+ // END SNIPPET: myid
+}</pre></div></li><li>Start and end snippets in a XML file<div class="source"><pre><project>
+...
+ <build>
+ <plugins>
+<!-- START SNIPPET: myid -->
+ <plugin>
+ ...
+ </plugin>
+<!-- END SNIPPET: myid -->
+ </plugins>
+ </build>
+</project></pre></div></li></ul><table border="1" class="bodyTable"><tr class="a"><th align="left">Parameter</th><th align="left">Description</th></tr><tr class="b"><td align="left">id</td><td align="left">The id of the snippet to include. If omitted the whole file/url will be included (since Doxia 1.1).</td></tr><tr class="a"><td align="left">url</td><td align="left">The path of the URL to include.</td></tr><tr class="b"><td align="left">file</td><td align="left">The path of the file to include (since doxia-1.0-alpha-9).</td></tr><tr class="a"><td align="left">verbatim</td><td align="left">If the content should be output as verbatim escaped text. If this is set to <tt>false</tt> then the content of the snippet will not be escaped. This means that you can use it like Server-Side Includes on a webserver. Default value is <tt>true</tt>.</td></tr></table></div><div class="section"><h3><a name="TOC_Macro">TOC Macro</a></h3><p>The <i>TOC</i> macro prints a Table Of Content
of a document. It is useful if you have several sections and subsections in your document. For instance, in an APT file, you could write:</p><div class="source"><pre>%{toc|section=2|fromDepth=2|toDepth=3}</pre></div><p>This displays a TOC for the second section in the document, including all subsections (depth 2) and sub-subsections (depth 3).</p><p><b>Note</b> that in Doxia, apt section titles are not implicit anchors (see <a href="../references/doxia-apt.html">Enhancements to the APT format</a>), so you need to insert explicit anchors for links to work!</p><p>In a xdoc file, it will be:</p><div class="source"><pre><macro name="toc">
+ <param name="section" value="2"/>
+ <param name="fromDepth" value="0"/>
+ <param name="toDepth" value="4"/>
+</macro></pre></div><table border="1" class="bodyTable"><tr class="a"><th align="left">Parameter</th><th align="left">Description</th></tr><tr class="b"><td align="left">section</td><td align="left">Display a TOC for the specified section only, or all sections if 0. Positive int, not mandatory, 0 by default.</td></tr><tr class="a"><td align="left">fromDepth</td><td align="left">Minimum section depth to include in the TOC (sections are depth 1, sub-sections depth 2, etc.). Positive int, not mandatory, 0 by default.</td></tr><tr class="b"><td align="left">toDepth</td><td align="left">Maximum section depth to include in the TOC. Positive int, not mandatory, 5 by default.</td></tr></table><p>From <b>Doxia 1.1.1</b> on you may also specify any of the html base attributes (<i>i.e.</i> any of <tt>id</tt>, <tt>class</tt>, <tt>style</tt>, <tt>lang</tt>, <tt>title</tt>) as parameters, e.g.:</p><div class="source"><pre>%{toc|class=myTOC}</pre></div><p>This can be used for styling
the TOC via css.</p></div><div class="section"><h3><a name="SWF_Macro">SWF Macro</a></h3><p>The <i>Swf</i> macro prints Shockwave Flash assets in the documentation. For instance, in an APT file, you could write:</p><div class="source"><pre>%{swf|src=swf/myfile.swf|id=MyMovie|width=600|height=200}</pre></div><p>In a xdoc file, it will be:</p><div class="source"><pre><macro name="swf">
+ <param name="src" value="swf/myfile.swf"/>
+ <param name="id" value="MyMovie"/>
+ <param name="width" value="600"/>
+ <param name="height" value="200"/>
+</macro></pre></div><table border="1" class="bodyTable"><tr class="a"><th align="left">Parameter</th><th align="left">Description</th></tr><tr class="b"><td align="left">src</td><td align="left">Specifies the location (URL) of the movie to be loaded.</td></tr><tr class="a"><td align="left">id</td><td align="left">Identifies the Flash movie to the host environment (a web browser, for example) so that it can be referenced using a scripting language.</td></tr><tr class="b"><td align="left">width</td><td align="left">Specifies the width of the movie in either pixels or percentage of browser window.</td></tr><tr class="a"><td align="left">height</td><td align="left">Specifies the height of the movie in either pixels or percentage of browser window.</td></tr><tr class="b"><td align="left">quality</td><td align="left">Possible values: low, high, autolow, autohigh, best.</td></tr><tr class="a"><td align="left">menu</td><td align="left">True displays the full menu, allowing the
user a variety of options to enhance or control playback. False displays a menu that contains only the Settings option and the About Flash option.</td></tr><tr class="b"><td align="left">loop</td><td align="left">Possible values: true, false. Specifies whether the movie repeats indefinitely or stops when it reaches the last frame. The default value is true if this attribute is omitted.</td></tr><tr class="a"><td align="left">play</td><td align="left">Possible values: true, false. Specifies whether the movie begins playing immediately on loading in the browser. The default value is true if this attribute is omitted.</td></tr><tr class="b"><td align="left">version</td><td align="left">Specifies the width of the movie in either pixels or percentage of browser window.</td></tr><tr class="a"><td align="left">allowScript</td><td align="left">Specifies the width of the movie in either pixels or percentage of browser window.</td></tr></table><p>For more information, see the <a href
="./swf-macro.html">SWF Macro</a> page.</p></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maventest-doxia/trunk/content/macros/swf-macro.html
==============================================================================
--- websites/staging/maventest-doxia/trunk/content/macros/swf-macro.html (added)
+++ websites/staging/maventest-doxia/trunk/content/macros/swf-macro.html Thu Mar 1 18:57:00 2012
@@ -0,0 +1,193 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Mar 1, 2012 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Doxia - SWF Macro</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="The Maven Team" />
+ <meta name="Date-Revision-yyyymmdd" content="20120301" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../" id="bannerLeft">
+ <img src="../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <a href=".././" id="bannerRight">
+ <img src="../images/maven-logo-2.gif" alt="" />
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ <a href="../index.html">Doxia</a>
+ >
+ Doxia - SWF Macro
+ </div>
+ <div class="xright">
+ Last Published: 2012-03-01
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>About Doxia</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">What is Doxia?</a>
+ </li>
+ <li class="none">
+ <a href="../overview.html">Overview</a>
+ </li>
+ <li class="collapsed">
+ <a href="../upgrading.html">Upgrading</a>
+ </li>
+ <li class="none">
+ <a href="../downloads.html">Downloads</a>
+ </li>
+ <li class="none">
+ <a href="../jira-report.html">Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../references/index.html">Format References</a>
+ </li>
+ <li class="none">
+ <a href="../modules/index.html">Doxia Modules Guide</a>
+ </li>
+ <li class="none">
+ <a href="../macros/index.html">Doxia Macros Guide</a>
+ </li>
+ <li class="none">
+ <a href="../book/index.html">Writing Books</a>
+ </li>
+ <li class="none">
+ <a href="../issues/index.html">Issues & Gotchas</a>
+ </li>
+ <li class="none">
+ <a href="../resources.html">External Resources</a>
+ </li>
+ </ul>
+ <h5>Developer Docs</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../developers/index.html">Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../doxia/index.html">Doxia 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools/index.html">Doxia Sitetools 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-1.0.x/index.html">Doxia 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools-1.0.x/index.html">Doxia Sitetools 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-tools/index.html">Doxia Tools</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../mercury/index.html">Mercury</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><div class="section"><h2>SWF Macro<a name="SWF_Macro"></a></h2><p>The SWF macro enables users of APT
to put SWF (Flash) assets in their documentation.</p><p>Flash assets typically need to be wrappered in <tt>object</tt> and <tt>embed</tt> tags and can have a variety of parameters. Below is a typical example:</p><div class="source"><pre><object classid='clsid:D27CDB6E-AE6D-11cf-96B8-444553540000'
+ codebase='http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,29,0'
+ width='400' height='400' id='MyMovie'>
+ <param name='movie' value='myfile.swf'>
+ <param name='quality' value='high'>
+ <param name='menu' value='false'>
+ <param name='loop' value='0'>
+ <embed src='myfile.swf' width='400' height='400' loop='0' quality='high'
+ pluginspage='http://www.macromedia.com/go/getflashplayer'
+ type='application/x-shockwave-flash' menu='false'></embed>
+</object></pre></div><p>In order to use a *.swf in your APT file, use the basic syntax:</p><div class="source"><pre>%{swf|src=swf/myfile.swf|id=MyMovie|width=600|height=200}</pre></div><p>For which <tt>src</tt> is the required parameter. Make sure to put your *.swf file into the <b>/resources</b> folder so that it will get copied to /target when running the <tt>mvn site</tt> task.</p><p>You can use more advanced parameters to control the output, as per below:</p><div class="source"><pre>%{swf|src=swf/myfile.swf|id=MyMovie|width=600|height=200|version=9|allowScript=always}</pre></div><p>For a full listing of parameters and their values see the Adobe knowledge base:</p><p><a class="externalLink" href="http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701">http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701</a></p><div class="section"><h3>Parameters and Defaults<a name="Parameters_and_Defaults"></a></h3><p>Currently the following parameters are ava
ilable through the macro. If no value is placed within a parameter, the value will default to the following:</p><ul><li>id = "swf"</li><li>width = "400"</li><li>height = "400"</li><li>quality = "high"</li><li>menu = "false"</li><li>loop = "0"</li><li>play = "true"</li><li>version = "9,0,45,0"</li><li>allowScript = "sameDomain"</li></ul><p>Note: There is some provided shorthand for versions, i.e. - version=6 - becomes version=6,0,29,0.</p><p><i>TODO:</i> only shorthand for 6 and 9 are functional. Need to find standard long version for other types.</p></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maventest-doxia/trunk/content/modules/index.html
==============================================================================
--- websites/staging/maventest-doxia/trunk/content/modules/index.html (added)
+++ websites/staging/maventest-doxia/trunk/content/modules/index.html Thu Mar 1 18:57:00 2012
@@ -0,0 +1,184 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Mar 1, 2012 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Doxia Modules Guide</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Vincent Siveton" />
+ <meta name="Date-Creation-yyyymmdd" content="20090615" />
+ <meta name="Date-Revision-yyyymmdd" content="20120301" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../" id="bannerLeft">
+ <img src="../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <a href=".././" id="bannerRight">
+ <img src="../images/maven-logo-2.gif" alt="" />
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ <a href="../index.html">Doxia</a>
+ >
+ Doxia Modules Guide
+ </div>
+ <div class="xright">
+ Last Published: 2012-03-01
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>About Doxia</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">What is Doxia?</a>
+ </li>
+ <li class="none">
+ <a href="../overview.html">Overview</a>
+ </li>
+ <li class="collapsed">
+ <a href="../upgrading.html">Upgrading</a>
+ </li>
+ <li class="none">
+ <a href="../downloads.html">Downloads</a>
+ </li>
+ <li class="none">
+ <a href="../jira-report.html">Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../references/index.html">Format References</a>
+ </li>
+ <li class="none">
+ <strong>Doxia Modules Guide</strong>
+ </li>
+ <li class="none">
+ <a href="../macros/index.html">Doxia Macros Guide</a>
+ </li>
+ <li class="none">
+ <a href="../book/index.html">Writing Books</a>
+ </li>
+ <li class="none">
+ <a href="../issues/index.html">Issues & Gotchas</a>
+ </li>
+ <li class="none">
+ <a href="../resources.html">External Resources</a>
+ </li>
+ </ul>
+ <h5>Developer Docs</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../developers/index.html">Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../doxia/index.html">Doxia 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools/index.html">Doxia Sitetools 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-1.0.x/index.html">Doxia 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-sitetools-1.0.x/index.html">Doxia Sitetools 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="../doxia-tools/index.html">Doxia Tools</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../mercury/index.html">Mercury</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Doxia Modules Guide<a name="Doxia_Modules_Guide"></a></h2><p>Doxia has several built-in modules that support some standard markup languages, see the <a href="../references/index.html">References</a> page for an overview. The following is just a collection of reference links for the individual formats.</p><ul><li><a href="#APT">APT</a></li><li><a href="#Confluence">Confluence</a></li><li><a href="#Simplified_DocBook">Simplified DocBook</a></li><li><a href="#FML">FML</a></li><li><a href="#iText">iText</a></li><li><a href="#FO_since_Doxia_1.1">FO (since Doxia 1.1)</a></li><li><a href="#LaTeX">LaTeX</a></li><li><a href="#Markdown">Markdown</a></li><li><a href="#RTF">RTF</a></li><li><a href="#TWiki">TWiki</a></li><li><a href="#XDoc">XDoc</a></li><li><a href="#XHTML">XHTML</a></li></ul><div class="section"><h3><a name="APT">APT</a></h3><p>APT (Almost Plain Text) is a simple text format.</p><p><b>References</b>:</p><ul><li><a href="..
/references/apt-format.html">Apt Reference</a></li></ul></div><div class="section"><h3><a name="Confluence">Confluence</a></h3><p><a class="externalLink" href="http://confluence.atlassian.com">Confluence</a> is an Enterprise wiki from <a class="externalLink" href="http://www.atlassian.com">Atlassian</a>. It uses <a class="externalLink" href="http://textism.com/tools/textile/">Textile</a> inside as an APT language.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview">Confluence Notation Guide Overview</a></li><li><a class="externalLink" href="http://confluence.atlassian.com/renderer/notationhelp.action?section=all">Confluence Element Reference</a></li></ul><!-- Textile in Java {{{https://sourceforge.net/projects/jtextile/}JTextile}}. --><!-- http://hobix.com/textile/ --></div><div class="section"><h3><a name="Simplified_DocBook">Simplified DocBook</a></h3><p><a class="externalLink"
href="http://docbook.org/">DocBook</a> is a markup language for technical documentation. <a class="externalLink" href="http://www.docbook.org/schemas/simplified">Simplified DocBook</a> is a simpler subset.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://www.docbook.org/schemas/simplified">Simplified DocBook Introduction</a></li><li><a class="externalLink" href="http://www.docbook.org/xml/simple/sdocbook/elements.html">Simplified DocBook Element Reference</a></li></ul></div><div class="section"><h3><a name="FML">FML</a></h3><p>FML (FAQ Markup Language) is a FAQ markup language.</p><p><b>References</b>:</p><ul><li><a href="../references/fml-format.html">FML Reference</a></li></ul></div><div class="section"><h3><a name="iText">iText</a></h3><p><a class="externalLink" href="http://www.lowagie.com/iText/">iText</a> is a free Java/PDF library.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://itextdocs.lowagie.com/tutorial/">iText t
utorial</a></li></ul><!-- * {{{http://www.lowagie.com/iText/tutorial/ch07.html}(out-dated) chapter on XML support}} --></div><div class="section"><h3><a name="FO">FO</a> (since Doxia 1.1)<a name="FO_since_Doxia_1.1"></a></h3><p>XSL formatting objects (XSL-FO)</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://www.w3.org/TR/xsl11/">XSL-FO Recommendation (05 December 2006)</a></li><li><a class="externalLink" href="http://zvon.org/xxl/xslfoReference/Output/index.html">XSL FO reference</a></li><li><a class="externalLink" href="http://xmlgraphics.apache.org/fop/">Apache FOP</a></li></ul></div><div class="section"><h3><a name="LaTeX">LaTeX</a></h3><p><a class="externalLink" href="http://www.latex-project.org/">LaTeX</a> is a popular document markup language.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://www.latex-project.org/guides/usrguide.pdf">LaTeX2e for authors</a></li><li><a class="externalLink" href="http://www.stdout.org/~win
ston/latex/latexsheet.pdf">Latex reference sheet</a></li></ul></div><div class="section"><h3><a name="Markdown">Markdown</a></h3><p><a class="externalLink" href="http://en.wikipedia.org/wiki/Markdown">Markdown</a> is a widespread Markup language.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://daringfireball.net/projects/markdown/">Official Markdown project at Daring Fireball</a></li></ul></div><div class="section"><h3><a name="RTF">RTF</a></h3><p><a class="externalLink" href="http://www.microsoft.com/downloads/details.aspx?FamilyId=DD422B8D-FF06-4207-B476-6B5396A18A2B&displaylang=en">RTF</a> is a proprietary document file format.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://www.microsoft.com/downloads/info.aspx?na=46&p=1&SrcDisplayLang=en&SrcCategoryId=&SrcFamilyId=dd422b8d-ff06-4207-b476-6b5396a18a2b&u=http%3a%2f%2fdownload.microsoft.com%2fdownload%2f2%2ff%2f5%2f2f599e18-07ee-4ec5-a1e7-f4e6a942359
2%2fWord2007RTFSpec9.doc&oRef=http%3a%2f%2fmsdn2.microsoft.com%2fen-us%2foffice%2faa905482.aspx">Microsoft Office Word 2007 Rich Text Format (RTF) Specification</a></li><li><a class="externalLink" href="http://search.cpan.org/~sburke/RTF-Writer/lib/RTF/Cookbook.pod">RTF Cookbook</a></li></ul></div><div class="section"><h3><a name="TWiki">TWiki</a></h3><p><a class="externalLink" href="http://twiki.org/">TWiki</a> is a structured wiki.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://twiki.org/cgi-bin/view/TWiki04x01/TextFormattingRules"> TWiki Text Formatting</a></li></ul></div><div class="section"><h3><a name="XDoc">XDoc</a></h3><p>XDoc is a generic format for document into a styled HTML document.</p><p><b>References</b>:</p><ul><li><a href="../references/xdoc-format.html">XDoc Reference</a></li></ul></div><div class="section"><h3><a name="XHTML">XHTML</a></h3><p><a class="externalLink" href="http://www.w3.org/MarkUp/">XHTML</a> is a markup langua
ge with the same expressions as HTML, but also conforms to XML syntax.</p><p><b>References</b>:</p><ul><li><a class="externalLink" href="http://www.iangraham.org/books/xhtml1/extras/html-7nov2000.pdf">HTML and XHTML Quick Reference Charts: Head and Body Markup</a></li><li><a class="externalLink" href="http://www.w3.org/TR/xhtml1/">XHTML 1.0 Specification</a></li></ul></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maventest-doxia/trunk/content/overview.html
==============================================================================
--- websites/staging/maventest-doxia/trunk/content/overview.html (added)
+++ websites/staging/maventest-doxia/trunk/content/overview.html Thu Mar 1 18:57:00 2012
@@ -0,0 +1,318 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Mar 1, 2012 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>
+ Overview Of The Doxia Framework</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Vincent Siveton" />
+ <meta name="Date-Creation-yyyymmdd" content="20090302" />
+ <meta name="Date-Revision-yyyymmdd" content="20120301" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+ <img src="images/apache-maven-project-2.png" alt="" />
+ </a>
+ <a href="./" id="bannerRight">
+ <img src="images/maven-logo-2.gif" alt="" />
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../index.html">Maven</a>
+ >
+ <a href="index.html">Doxia</a>
+ >
+
+ Overview Of The Doxia Framework
+ </div>
+ <div class="xright">
+ Last Published: 2012-03-01
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>About Doxia</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html">What is Doxia?</a>
+ </li>
+ <li class="none">
+ <strong>Overview</strong>
+ </li>
+ <li class="collapsed">
+ <a href="upgrading.html">Upgrading</a>
+ </li>
+ <li class="none">
+ <a href="downloads.html">Downloads</a>
+ </li>
+ <li class="none">
+ <a href="jira-report.html">Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="references/index.html">Format References</a>
+ </li>
+ <li class="none">
+ <a href="modules/index.html">Doxia Modules Guide</a>
+ </li>
+ <li class="none">
+ <a href="macros/index.html">Doxia Macros Guide</a>
+ </li>
+ <li class="none">
+ <a href="book/index.html">Writing Books</a>
+ </li>
+ <li class="none">
+ <a href="issues/index.html">Issues & Gotchas</a>
+ </li>
+ <li class="none">
+ <a href="resources.html">External Resources</a>
+ </li>
+ </ul>
+ <h5>Developer Docs</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="developers/index.html">Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="doxia/index.html">Doxia 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-sitetools/index.html">Doxia Sitetools 1.1.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-1.0.x/index.html">Doxia 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-sitetools-1.0.x/index.html">Doxia Sitetools 1.0.x</a>
+ </li>
+ <li class="none">
+ <a href="doxia-tools/index.html">Doxia Tools</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../mercury/index.html">Mercury</a>
+ </li>
+ <li class="none">
+ <a href="../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="./images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+
+ <div class="section"><h2>Overview Of The Doxia Framework<a name="Overview_Of_The_Doxia_Framework"></a></h2>
+ <p>
+ The following figure represents the main components of the Doxia Framework.
+ </p>
+ <p>
+ <img src="images/architecture.png" width="574" height="439" border="0" usemap="#Doxia_Framework" alt="Doxia Framework" />
+ <map id="Doxia_Framework" name="Doxia_Framework">
+ <area shape="rect" coords="87,45,172,99" alt="Sink API" href="http://maven.apache.org/doxia/doxia/doxia-sink-api/" />
+ <area shape="rect" coords="66,170,193,232" alt="Core" href="http://maven.apache.org/doxia/doxia/doxia-core/" />
+ <area shape="rect" coords="26,361,69,403" alt="APT Module" href="http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-apt/" />
+ <area shape="rect" coords="78,361,119,403" alt="XDoc Module" href="http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-xdoc/" />
+ <area shape="rect" coords="130,361,172,404" alt="FML Module" href="http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fml/" />
+ <area shape="rect" coords="14,311,235,428" alt="Modules" href="http://maven.apache.org/doxia/doxia/doxia-modules/" />
+ <area shape="rect" coords="0,0,260,438" alt="Doxia" href="http://maven.apache.org/doxia/doxia/" />
+ <area shape="rect" coords="297,157,422,200" alt="Site Renderer" href="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/" />
+ <area shape="rect" coords="455,157,557,200" alt="Decoration Model" href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/" />
+ <area shape="rect" coords="298,209,421,251" alt="Doc Renderer" href="http://maven.apache.org/doxia/doxia-sitetools/doxia-doc-renderer/" />
+ <area shape="rect" coords="286,114,575,262" alt="Site Tools" href="http://maven.apache.org/doxia/doxia-sitetools/" />
+ <area shape="rect" coords="304,362,403,404" alt="Converter" href="http://maven.apache.org/doxia/doxia-tools/doxia-converter/" />
+ <area shape="rect" coords="424,362,517,404" alt="Linkcheck" href="http://maven.apache.org/doxia/doxia-tools/doxia-linkcheck/" />
+ <area shape="rect" coords="285,310,537,426" alt="Tools" href="http://maven.apache.org/doxia/doxia-tools/" />
+ </map>
+ </p>
+ <p>
+ <b>Note</b>: Just like Maven, Doxia uses
+ <a class="externalLink" href="http://plexus.codehaus.org/">Plexus</a> extensively.
+ </p>
+
+ <div class="section"><h3>Sink API<a name="Sink_API"></a></h3>
+ <p>
+ The <i>Sink</i> interface is a generic markup language interface. It contains
+ several methods that encapsulate common text syntax. A start tag is denoted by
+ <i>xxxx()</i> method and a end of tag by <i>xxxx_()</i> method.
+ </p>
+ <p>
+ For instance, you could do things like:
+ </p>
+ <div class="source"><pre>
+sink.paragraph();
+sink.text( "my text" );
+sink.paragraph_(); </pre></div>
+ <p>
+ similar to this HTML markup:
+ </p>
+ <div class="source"><pre>
+<p>my text</p></pre></div>
+ <p>To find out more about the Sink API, you could read the Javadoc
+ <a class="externalLink" href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html">here</a>.
+ </p>
+ </div>
+
+ <div class="section"><h3>Doxia Core<a name="Doxia_Core"></a></h3>
+ <p>
+ The <i>Core</i> is the API to parse a source and populate it in a <i>Sink</i>
+ object. The <i>Parser</i> interface contains only one method:
+ </p>
+ <div class="source"><pre>
+void parse( Reader source, Sink sink )
+ throws ParseException; </pre></div>
+ <p>
+ The <i>ParseException</i> class has the responsibility to catch all parsing
+ exceptions. It provides an helper method, <i>getLineNumber()</i>, which helps to
+ find where an error occurred.
+ </p>
+ <p>
+ The <i>AbstractParser</i> class is an abstract implementation of the
+ <i>Parser</i>. It provides a macro mechanism to give dynamic functionalities for
+ the parsing. For more information on macros, read the <a href="./macros/index.html">Doxia Macro Guide</a>.
+ </p>
+ <p>
+ Finally, the <i>SiteModule</i> interface is the last part of the puzzle. It
+ provides main definitions of a given Doxia module and it is used by the
+ <i>doxia-site-renderer</i> site tools.
+ </p>
+ </div>
+
+ <div class="section"><h3>Doxia Modules<a name="Doxia_Modules"></a></h3>
+ <p>
+ A Doxia module is an implementation of a given markup language like APT or Xdoc.
+ Each module should implement these interfaces:
+ </p>
+ <ul>
+ <li><i>Parser</i> interface, more specifically the <i>AbstractParser</i> class</li>
+ <li><i>SiteModule</i> interface</li>
+ </ul>
+ <p>
+ Several modules provide also a <i>Sink</i> implementation to handle a specific
+ output markup language.
+ </p>
+ <p>
+ For more information on modules, read the <a href="./modules/index.html">Doxia
+ Module Guide</a>.
+ </p>
+ </div>
+
+ <div class="section"><h3>Doxia Site Tools<a name="Doxia_Site_Tools"></a></h3>
+ <p>
+ The <i>Site Tools</i> are a collection of tools to renderer an output. The main
+ tool used by Maven, specifically the
+ <a class="externalLink" href="http://maven.apache.org/plugins/maven-site-plugin/">Maven Site Plugin</a>,
+ is the <i>doxia-site-renderer</i> which renders in HTML any
+ documents written with supported markup syntax. It uses
+ <a class="externalLink" href="http://velocity.apache.org/">Velocity templates</a>
+ to customize the renderer and the <i>site-decoration-model</i> tool to decorate the
+ renderer.
+ This component describes the layout of the site defined in the <i>site.xml</i>
+ file.
+ </p>
+ <p>
+ The <i>doxia-doc-renderer</i> tool is used to renderer any document in another
+ document.
+ </p>
+ </div>
+ </div>
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>