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 2013/11/20 00:44:58 UTC
svn commit: r887284 [1/6] - in /websites/staging/maven-doxia/trunk/content:
./ book/ developers/ doxia-example-book/ issues/ macros/ modules/ references/
Author: buildbot
Date: Tue Nov 19 23:44:57 2013
New Revision: 887284
Log:
Staging update by buildbot for maven-doxia
Modified:
websites/staging/maven-doxia/trunk/content/ (props changed)
websites/staging/maven-doxia/trunk/content/book/index.html
websites/staging/maven-doxia/trunk/content/dependencies.html
websites/staging/maven-doxia/trunk/content/dependency-info.html
websites/staging/maven-doxia/trunk/content/dependency-management.html
websites/staging/maven-doxia/trunk/content/developers/index.html
websites/staging/maven-doxia/trunk/content/developers/macros.html
websites/staging/maven-doxia/trunk/content/developers/maven-integration.html
websites/staging/maven-doxia/trunk/content/developers/modules.html
websites/staging/maven-doxia/trunk/content/developers/sink.html
websites/staging/maven-doxia/trunk/content/distribution-management.html
websites/staging/maven-doxia/trunk/content/downloads.html
websites/staging/maven-doxia/trunk/content/doxia-1.4.pdf
websites/staging/maven-doxia/trunk/content/doxia-example-book/aegis-binding.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/bind.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/bindings.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/castor.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/doxia-example-book.pdf
websites/staging/maven-doxia/trunk/content/doxia-example-book/doxia-example-book.rtf
websites/staging/maven-doxia/trunk/content/doxia-example-book/http-transport.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/index.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/jms-transport.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/local-transport.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/transport-and-channel-api.html
websites/staging/maven-doxia/trunk/content/doxia-example-book/transports.html
websites/staging/maven-doxia/trunk/content/doxia-ide.html
websites/staging/maven-doxia/trunk/content/faq.html
websites/staging/maven-doxia/trunk/content/index.html
websites/staging/maven-doxia/trunk/content/integration.html
websites/staging/maven-doxia/trunk/content/issue-tracking.html
websites/staging/maven-doxia/trunk/content/issues/index.html
websites/staging/maven-doxia/trunk/content/license.html
websites/staging/maven-doxia/trunk/content/macros/index.html
websites/staging/maven-doxia/trunk/content/macros/swf-macro.html
websites/staging/maven-doxia/trunk/content/mail-lists.html
websites/staging/maven-doxia/trunk/content/modules/index.html
websites/staging/maven-doxia/trunk/content/overview.html
websites/staging/maven-doxia/trunk/content/plugin-management.html
websites/staging/maven-doxia/trunk/content/plugins.html
websites/staging/maven-doxia/trunk/content/project-info.html
websites/staging/maven-doxia/trunk/content/project-summary.html
websites/staging/maven-doxia/trunk/content/references/apt-format.html
websites/staging/maven-doxia/trunk/content/references/doxia-apt.html
websites/staging/maven-doxia/trunk/content/references/fml-format.html
websites/staging/maven-doxia/trunk/content/references/index.html
websites/staging/maven-doxia/trunk/content/references/xdoc-format.html
websites/staging/maven-doxia/trunk/content/resources.html
websites/staging/maven-doxia/trunk/content/source-repository.html
websites/staging/maven-doxia/trunk/content/team-list.html
websites/staging/maven-doxia/trunk/content/upgrading.html
websites/staging/maven-doxia/trunk/content/whatsnew-1.1.html
Propchange: websites/staging/maven-doxia/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Nov 19 23:44:57 2013
@@ -1 +1 @@
-1543586
+1543649
Modified: websites/staging/maven-doxia/trunk/content/book/index.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/book/index.html (original)
+++ websites/staging/maven-doxia/trunk/content/book/index.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -214,7 +214,21 @@ Vincent Siveton" />
</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/references/apt-
format.html --><div class="section"><h2>Introduction<a name="Introduction"></a></h2><p>Doxia allows you to write books like user manuals and guides in any format supported by Doxia. Combined with the Doxia Book Maven you are able to include the manuals directly in your generated site with links to the off-line friendly formats like XDoc, PDF, RTF and LaTeX.</p><p>The Xdoc output which has been rendered into this site can be viewed <a href="../doxia-example-book/index.html">here</a>.</p><p>The generated PDF is <a href="../doxia-example-book/doxia-example-book.pdf">here</a> and the generated RTF <a href="../doxia-example-book/doxia-example-book.rtf">here</a>.</p><div class="section"><h3>How It Works<a name="How_It_Works"></a></h3><p>The only thing you need in addition to the content files itself is a simple book descriptor which is used to specify the ordering of the sections and the names for the chapters.</p><p>See <a href="../doxia-tools/doxia-book-renderer/book.html">The Book Desc
riptor Reference</a> for a reference to the descriptor.</p></div><div class="section"><h3>Creating a Book Descriptor<a name="Creating_a_Book_Descriptor"></a></h3><p>An XML file is used to describe the layout of the book.</p><p>A sample is given below:</p><div class="source"><pre><book xmlns="http://maven.apache.org/BOOK/1.0.0"
+ <!-- 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/references/apt-
format.html --><div class="section">
+<h2>Introduction<a name="Introduction"></a></h2>
+<p>Doxia allows you to write books like user manuals and guides in any format supported by Doxia. Combined with the Doxia Book Maven you are able to include the manuals directly in your generated site with links to the off-line friendly formats like XDoc, PDF, RTF and LaTeX.</p>
+<p>The Xdoc output which has been rendered into this site can be viewed <a href="../doxia-example-book/index.html">here</a>.</p>
+<p>The generated PDF is <a href="../doxia-example-book/doxia-example-book.pdf">here</a> and the generated RTF <a href="../doxia-example-book/doxia-example-book.rtf">here</a>.</p>
+<div class="section">
+<h3>How It Works<a name="How_It_Works"></a></h3>
+<p>The only thing you need in addition to the content files itself is a simple book descriptor which is used to specify the ordering of the sections and the names for the chapters.</p>
+<p>See <a href="../doxia-tools/doxia-book-renderer/book.html">The Book Descriptor Reference</a> for a reference to the descriptor.</p></div>
+<div class="section">
+<h3>Creating a Book Descriptor<a name="Creating_a_Book_Descriptor"></a></h3>
+<p>An XML file is used to describe the layout of the book.</p>
+<p>A sample is given below:</p>
+<div class="source">
+<pre><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">
<id>doxia-example-book</id>
@@ -255,7 +269,14 @@ Vincent Siveton" />
</chapter>
</chapters>
</book>
-</pre></div></div><div class="section"><h3>Configuring Doxia Book Maven Plugin<a name="Configuring_Doxia_Book_Maven_Plugin"></a></h3><p>This example illustrates how to configure the Doxia Book Maven Plugin. It will render the book in three different formats. By default the output will be under <tt>target/generated-site/<format>/<book id> </tt>.</p><p>The currently supported format ids are: <tt>xdoc</tt>, <tt>pdf</tt>, <tt>latex</tt>, <tt>rtf</tt>, <tt>xhtml</tt>, <tt>doc-book</tt></p><p>A sample <tt>pom.xml</tt> is given below:</p><div class="source"><pre><plugin>
+</pre></div></div>
+<div class="section">
+<h3>Configuring Doxia Book Maven Plugin<a name="Configuring_Doxia_Book_Maven_Plugin"></a></h3>
+<p>This example illustrates how to configure the Doxia Book Maven Plugin. It will render the book in three different formats. By default the output will be under <tt>target/generated-site/<format>/<book id> </tt>.</p>
+<p>The currently supported format ids are: <tt>xdoc</tt>, <tt>pdf</tt>, <tt>latex</tt>, <tt>rtf</tt>, <tt>xhtml</tt>, <tt>doc-book</tt></p>
+<p>A sample <tt>pom.xml</tt> is given below:</p>
+<div class="source">
+<pre><plugin>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-book-maven-plugin</artifactId>
<version>1.3-SNAPSHOT</version>
Modified: websites/staging/maven-doxia/trunk/content/dependencies.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/dependencies.html (original)
+++ websites/staging/maven-doxia/trunk/content/dependencies.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -255,7 +255,10 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <a name="Project_Dependencies"></a><div class="section"><h2>Project Dependencies<a name="Project_Dependencies"></a></h2><p>There are no dependencies for this project. It is a standalone application that does not depend on any other project.</p></div>
+ <a name="Project_Dependencies"></a>
+<div class="section">
+<h2>Project Dependencies<a name="Project_Dependencies"></a></h2>
+<p>There are no dependencies for this project. It is a standalone application that does not depend on any other project.</p></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/dependency-info.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/dependency-info.html (original)
+++ websites/staging/maven-doxia/trunk/content/dependency-info.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -255,16 +255,45 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Dependency Information<a name="Dependency_Information"></a></h2><a name="Dependency_Information"></a><div class="section"><h3>Apache Maven<a name="Apache_Maven"></a></h3><a name="Apache_Maven"></a><div class="source"><pre><dependency>
+ <div class="section">
+<h2>Dependency Information<a name="Dependency_Information"></a></h2><a name="Dependency_Information"></a>
+<div class="section">
+<h3>Apache Maven<a name="Apache_Maven"></a></h3><a name="Apache_Maven"></a>
+<div class="source">
+<pre><dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-site</artifactId>
<version>1.0-SNAPSHOT</version>
<type>pom</type>
-</dependency></pre></div></div><div class="section"><h3>Apache Buildr<a name="Apache_Buildr"></a></h3><a name="Apache_Buildr"></a><div class="source"><pre>'org.apache.maven.doxia:doxia-site:pom:1.0-SNAPSHOT'</pre></div></div><div class="section"><h3>Apache Ant<a name="Apache_Ant"></a></h3><a name="Apache_Ant"></a><div class="source"><pre><dependency org="org.apache.maven.doxia" name="doxia-site" rev="1.0-SNAPSHOT">
+</dependency></pre></div></div>
+<div class="section">
+<h3>Apache Buildr<a name="Apache_Buildr"></a></h3><a name="Apache_Buildr"></a>
+<div class="source">
+<pre>'org.apache.maven.doxia:doxia-site:pom:1.0-SNAPSHOT'</pre></div></div>
+<div class="section">
+<h3>Apache Ant<a name="Apache_Ant"></a></h3><a name="Apache_Ant"></a>
+<div class="source">
+<pre><dependency org="org.apache.maven.doxia" name="doxia-site" rev="1.0-SNAPSHOT">
<artifact name="doxia-site" type="pom" />
-</dependency></pre></div></div><div class="section"><h3>Groovy Grape<a name="Groovy_Grape"></a></h3><a name="Groovy_Grape"></a><div class="source"><pre>@Grapes(
+</dependency></pre></div></div>
+<div class="section">
+<h3>Groovy Grape<a name="Groovy_Grape"></a></h3><a name="Groovy_Grape"></a>
+<div class="source">
+<pre>@Grapes(
@Grab(group='org.apache.maven.doxia', module='doxia-site', version='1.0-SNAPSHOT')
-)</pre></div></div><div class="section"><h3>Grails<a name="Grails"></a></h3><a name="Grails"></a><div class="source"><pre>compile 'org.apache.maven.doxia:doxia-site:1.0-SNAPSHOT'</pre></div></div><div class="section"><h3>Leiningen<a name="Leiningen"></a></h3><a name="Leiningen"></a><div class="source"><pre>[org.apache.maven.doxia/doxia-site "1.0-SNAPSHOT"]</pre></div></div><div class="section"><h3>SBT<a name="SBT"></a></h3><a name="SBT"></a><div class="source"><pre>libraryDependencies += "org.apache.maven.doxia" %% "doxia-site" % "1.0-SNAPSHOT"</pre></div></div></div>
+)</pre></div></div>
+<div class="section">
+<h3>Grails<a name="Grails"></a></h3><a name="Grails"></a>
+<div class="source">
+<pre>compile 'org.apache.maven.doxia:doxia-site:1.0-SNAPSHOT'</pre></div></div>
+<div class="section">
+<h3>Leiningen<a name="Leiningen"></a></h3><a name="Leiningen"></a>
+<div class="source">
+<pre>[org.apache.maven.doxia/doxia-site "1.0-SNAPSHOT"]</pre></div></div>
+<div class="section">
+<h3>SBT<a name="SBT"></a></h3><a name="SBT"></a>
+<div class="source">
+<pre>libraryDependencies += "org.apache.maven.doxia" %% "doxia-site" % "1.0-SNAPSHOT"</pre></div></div></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/dependency-management.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/dependency-management.html (original)
+++ websites/staging/maven-doxia/trunk/content/dependency-management.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -255,7 +255,40 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Project Dependency Management<a name="Project_Dependency_Management"></a></h2><a name="Project_Dependency_Management"></a><div class="section"><h3>compile<a name="compile"></a></h3><a name="compile"></a><p>The following is a list of compile dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile and run the submodule:</p><table border="0" class="bodyTable"><tr class="a"><th>GroupId</th><th>ArtifactId</th><th>Version</th><th>Type</th><th>License</th></tr><tr class="b"><td>org.codehaus.plexus</td><td><a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/">plexus-component-annotations</a></td><td>1.5.5</td><td>jar</td><td><a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.txt">The Apache Software License, Version 2.0</a></td></tr></table></div><div class="section"><h3>provided<a name="provided"></a></h3><a name="provi
ded"></a><p>The following is a list of provided dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile the submodule, but should be provided by default when using the library:</p><table border="0" class="bodyTable"><tr class="a"><th>GroupId</th><th>ArtifactId</th><th>Version</th><th>Type</th><th>License</th></tr><tr class="b"><td>org.apache.maven.plugin-tools</td><td><a class="externalLink" href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/">maven-plugin-annotations</a></td><td>3.2</td><td>jar</td><td><a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.txt">The Apache Software License, Version 2.0</a></td></tr></table></div></div>
+ <div class="section">
+<h2>Project Dependency Management<a name="Project_Dependency_Management"></a></h2><a name="Project_Dependency_Management"></a>
+<div class="section">
+<h3>compile<a name="compile"></a></h3><a name="compile"></a>
+<p>The following is a list of compile dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile and run the submodule:</p>
+<table border="0" class="bodyTable">
+<tr class="a">
+<th>GroupId</th>
+<th>ArtifactId</th>
+<th>Version</th>
+<th>Type</th>
+<th>License</th></tr>
+<tr class="b">
+<td>org.codehaus.plexus</td>
+<td><a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/">plexus-component-annotations</a></td>
+<td>1.5.5</td>
+<td>jar</td>
+<td><a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.txt">The Apache Software License, Version 2.0</a></td></tr></table></div>
+<div class="section">
+<h3>provided<a name="provided"></a></h3><a name="provided"></a>
+<p>The following is a list of provided dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile the submodule, but should be provided by default when using the library:</p>
+<table border="0" class="bodyTable">
+<tr class="a">
+<th>GroupId</th>
+<th>ArtifactId</th>
+<th>Version</th>
+<th>Type</th>
+<th>License</th></tr>
+<tr class="b">
+<td>org.apache.maven.plugin-tools</td>
+<td><a class="externalLink" href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/">maven-plugin-annotations</a></td>
+<td>3.2</td>
+<td>jar</td>
+<td><a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.txt">The Apache Software License, Version 2.0</a></td></tr></table></div></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/developers/index.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/developers/index.html (original)
+++ websites/staging/maven-doxia/trunk/content/developers/index.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -224,7 +224,14 @@
</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/references/apt-
format.html --><div class="section"><h2>Doxia Developers Centre<a name="Doxia_Developers_Centre"></a></h2><p>This documentation centre is for those that are developing Doxia modules or macro.</p><p>Currently you can find information on the following topics:</p><ul><li><a href="./modules.html">Creating Doxia Modules</a></li><li><a href="./macros.html">Creating Doxia Macros</a></li><li><a href="./sink.html">Using the Doxia Sink API</a></li></ul></div>
+ <!-- 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/references/apt-
format.html --><div class="section">
+<h2>Doxia Developers Centre<a name="Doxia_Developers_Centre"></a></h2>
+<p>This documentation centre is for those that are developing Doxia modules or macro.</p>
+<p>Currently you can find information on the following topics:</p>
+<ul>
+<li><a href="./modules.html">Creating Doxia Modules</a></li>
+<li><a href="./macros.html">Creating Doxia Macros</a></li>
+<li><a href="./sink.html">Using the Doxia Sink API</a></li></ul></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/developers/macros.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/developers/macros.html (original)
+++ websites/staging/maven-doxia/trunk/content/developers/macros.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -224,7 +224,11 @@
</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/references/apt-
format.html --><div class="section"><h2>Create a New Doxia Macro<a name="Create_a_New_Doxia_Macro"></a></h2><p>You need to add the following plugin configuration to generate the correct Plexus <i>component.xml</i> file for the project containing your macro:</p><div class="source"><pre><project>
+ <!-- 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/references/apt-
format.html --><div class="section">
+<h2>Create a New Doxia Macro<a name="Create_a_New_Doxia_Macro"></a></h2>
+<p>You need to add the following plugin configuration to generate the correct Plexus <i>component.xml</i> file for the project containing your macro:</p>
+<div class="source">
+<pre><project>
...
<build>
...
@@ -245,7 +249,10 @@
...
</build>
...
-</project></pre></div><p>You should implement the <i>AbstractMacro</i> class:</p><div class="source"><pre>import org.apache.maven.doxia.macro.AbstractMacro;
+</project></pre></div>
+<p>You should implement the <i>AbstractMacro</i> class:</p>
+<div class="source">
+<pre>import org.apache.maven.doxia.macro.AbstractMacro;
/**
* @plexus.component role="org.apache.maven.doxia.macro.Macro" role-hint="my"
@@ -261,9 +268,24 @@ public class MyMacro
...
}
...
-}</pre></div><p>To use it, you need to write the following markups:</p><ul><li>APT<div class="source"><pre>%{my|myParam=myValue} <!-- my is the macro name defined by role-hint --></pre></div></li><li>XDoc<div class="source"><pre><macro name="my"> <!-- my is the required macro name defined by role-hint -->
+}</pre></div>
+<p>To use it, you need to write the following markups:</p>
+<ul>
+<li>APT
+<div class="source">
+<pre>%{my|myParam=myValue} <!-- my is the macro name defined by role-hint --></pre></div></li>
+<li>XDoc
+<div class="source">
+<pre><macro name="my"> <!-- my is the required macro name defined by role-hint -->
<param name="myParam" value="myValue"/>
-</macro></pre></div></li></ul><div class="section"><h3><a name="References">References</a></h3><ul><li><a href="../modules/index.html">Doxia Modules Guide</a></li><li><a href="../macros/index.html">Doxia Macros Guide</a></li><li><a href="../doxia/apidocs/index.html">Doxia API Reference</a></li><li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></div></div>
+</macro></pre></div></li></ul>
+<div class="section">
+<h3><a name="References">References</a></h3>
+<ul>
+<li><a href="../modules/index.html">Doxia Modules Guide</a></li>
+<li><a href="../macros/index.html">Doxia Macros Guide</a></li>
+<li><a href="../doxia/apidocs/index.html">Doxia API Reference</a></li>
+<li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></div></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/developers/maven-integration.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/developers/maven-integration.html (original)
+++ websites/staging/maven-doxia/trunk/content/developers/maven-integration.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -221,7 +221,14 @@
</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/references/apt-
format.html --><div class="section"><h2>Integration With Maven<a name="Integration_With_Maven"></a></h2><p>This page presents how to use Doxia 1.1 under Maven 2.0.x and 2.1.x with a Maven reporting plugin. Its goal is to help the Maven reporting plugin developer to integrate it.</p><div class="section"><h3>Maven 2.0.x<a name="Maven_2.0.x"></a></h3><p>Doxia 1.0 API is embedded in Maven 2.0.x (see <a class="externalLink" href="http://jira.codehaus.org/browse/MNG-3402">MNG-3402</a>), so your Maven reporting plugin needs to shade Doxia 1.1 API and Logging to be backward compatible with Maven 2.0.x.</p><div class="source"><pre><project>
+ <!-- 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/references/apt-
format.html --><div class="section">
+<h2>Integration With Maven<a name="Integration_With_Maven"></a></h2>
+<p>This page presents how to use Doxia 1.1 under Maven 2.0.x and 2.1.x with a Maven reporting plugin. Its goal is to help the Maven reporting plugin developer to integrate it.</p>
+<div class="section">
+<h3>Maven 2.0.x<a name="Maven_2.0.x"></a></h3>
+<p>Doxia 1.0 API is embedded in Maven 2.0.x (see <a class="externalLink" href="http://jira.codehaus.org/browse/MNG-3402">MNG-3402</a>), so your Maven reporting plugin needs to shade Doxia 1.1 API and Logging to be backward compatible with Maven 2.0.x.</p>
+<div class="source">
+<pre><project>
...
<build>
...
@@ -256,7 +263,13 @@
</plugins>
</build>
...
-</project></pre></div></div><div class="section"><h3>Maven 2.1.x<a name="Maven_2.1.x"></a></h3><p>Doxia 1.1 API and Logging are embedded in Maven 2.1.x, your Maven reporting plugin is directly compatible with 2.1.x.</p></div></div><div class="section"><h2>Common Bugs and Pitfalls<a name="Common_Bugs_and_Pitfalls"></a></h2><p>Please read the <a href="../issues/index.html">Doxia Issues</a> page.</p></div>
+</project></pre></div></div>
+<div class="section">
+<h3>Maven 2.1.x<a name="Maven_2.1.x"></a></h3>
+<p>Doxia 1.1 API and Logging are embedded in Maven 2.1.x, your Maven reporting plugin is directly compatible with 2.1.x.</p></div></div>
+<div class="section">
+<h2>Common Bugs and Pitfalls<a name="Common_Bugs_and_Pitfalls"></a></h2>
+<p>Please read the <a href="../issues/index.html">Doxia Issues</a> page.</p></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/developers/modules.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/developers/modules.html (original)
+++ websites/staging/maven-doxia/trunk/content/developers/modules.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -224,7 +224,11 @@
</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/references/apt-
format.html --><div class="section"><h2>Create a New Doxia Module<a name="Create_a_New_Doxia_Module"></a></h2><p>First, you need to create a POM with <i>doxia-modules</i> as parent:</p><div class="source"><pre><project>
+ <!-- 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/references/apt-
format.html --><div class="section">
+<h2>Create a New Doxia Module<a name="Create_a_New_Doxia_Module"></a></h2>
+<p>First, you need to create a POM with <i>doxia-modules</i> as parent:</p>
+<div class="source">
+<pre><project>
<parent>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-modules</artifactId>
@@ -235,7 +239,12 @@
<name>Doxia :: MY Module</name>
...
-</project></pre></div><p>Secondly, you should implement some Doxia classes:</p><ul><li><i>MyParser</i> class<div class="source"><pre>import org.apache.maven.doxia.parser.AbstractParser;
+</project></pre></div>
+<p>Secondly, you should implement some Doxia classes:</p>
+<ul>
+<li><i>MyParser</i> class
+<div class="source">
+<pre>import org.apache.maven.doxia.parser.AbstractParser;
/**
* @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="my"
@@ -244,13 +253,19 @@ public class MyParser
extends AbstractParser
{
...
-}</pre></div></li><li><i>MyParseException</i> class (optional)<div class="source"><pre>import org.apache.maven.doxia.parser.ParseException;
+}</pre></div></li>
+<li><i>MyParseException</i> class (optional)
+<div class="source">
+<pre>import org.apache.maven.doxia.parser.ParseException;
public class MyParseException
extends ParseException
{
...
-}</pre></div></li><li><i>MySiteModule</i> class (optional, will be used by doxia-sitetools)<div class="source"><pre>import org.apache.maven.doxia.module.site.AbstractSiteModule;
+}</pre></div></li>
+<li><i>MySiteModule</i> class (optional, will be used by doxia-sitetools)
+<div class="source">
+<pre>import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
* @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="my"
@@ -259,13 +274,19 @@ public class MySiteModule
extends AbstractSiteModule
{
...
-}</pre></div></li><li><i>MySink</i> class<div class="source"><pre>import org.apache.maven.doxia.sink.SinkAdapter;
+}</pre></div></li>
+<li><i>MySink</i> class
+<div class="source">
+<pre>import org.apache.maven.doxia.sink.SinkAdapter;
public class MySink
extends SinkAdapter
{
...
-}</pre></div></li><li><i>MySinkFactory</i> class<div class="source"><pre>import org.apache.maven.doxia.sink.SinkFactory;
+}</pre></div></li>
+<li><i>MySinkFactory</i> class
+<div class="source">
+<pre>import org.apache.maven.doxia.sink.SinkFactory;
/**
* @plexus.component role="org.apache.maven.doxia.sink.SinkFactory" role-hint="my"
@@ -274,7 +295,14 @@ public class MySinkFactory
extends SinkFactory
{
...
-}</pre></div></li></ul><div class="section"><h3><a name="References">References</a></h3><ul><li><a href="../modules/index.html">Doxia Modules Guide</a></li><li><a href="../macros/index.html">Doxia Macros Guide</a></li><li><a href="../doxia/apidocs/index.html">Doxia API Reference</a></li><li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></div></div>
+}</pre></div></li></ul>
+<div class="section">
+<h3><a name="References">References</a></h3>
+<ul>
+<li><a href="../modules/index.html">Doxia Modules Guide</a></li>
+<li><a href="../macros/index.html">Doxia Macros Guide</a></li>
+<li><a href="../doxia/apidocs/index.html">Doxia API Reference</a></li>
+<li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></div></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/developers/sink.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/developers/sink.html (original)
+++ websites/staging/maven-doxia/trunk/content/developers/sink.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -224,7 +224,20 @@
</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/references/apt-
format.html --><div class="section"><h2>Using the Doxia Sink API<a name="Using_the_Doxia_Sink_API"></a></h2><ul><li><a href="#Transforming_documents">Transforming documents</a></li><li><a href="#Generating_documents">Generating documents</a></li><li><a href="#Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></li><li><a href="#Avoid_sink.rawText">Avoid sink.rawText!</a></li><li><a href="#How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></li><li><a href="#References">References</a></li></ul><div class="section"><h3><a name="Transforming_documents">Transforming documents</a></h3><p>Doxia can be used to transform an arbitrary input document to any supported output format. The following snippet shows how to use a Doxia <i>Parser</i> to transform an apt file to html:</p><div class="source"><pre> File userDir = new File( System.getProperty ( "user.dir" ) );
+ <!-- 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/references/apt-
format.html --><div class="section">
+<h2>Using the Doxia Sink API<a name="Using_the_Doxia_Sink_API"></a></h2>
+<ul>
+<li><a href="#Transforming_documents">Transforming documents</a></li>
+<li><a href="#Generating_documents">Generating documents</a></li>
+<li><a href="#Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></li>
+<li><a href="#Avoid_sink.rawText">Avoid sink.rawText!</a></li>
+<li><a href="#How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></li>
+<li><a href="#References">References</a></li></ul>
+<div class="section">
+<h3><a name="Transforming_documents">Transforming documents</a></h3>
+<p>Doxia can be used to transform an arbitrary input document to any supported output format. The following snippet shows how to use a Doxia <i>Parser</i> to transform an apt file to html:</p>
+<div class="source">
+<pre> File userDir = new File( System.getProperty ( "user.dir" ) );
File inputFile = new File( userDir, "test.apt" );
File outputFile = new File( userDir, "test.html" );
@@ -236,7 +249,14 @@
Reader reader = ReaderFactory.newReader( inputFile, "UTF-8" );
- parser.parse( reader, sink );</pre></div><p>It is recommended that you use <a class="externalLink" href="http://plexus.codehaus.org/">Plexus</a> to look up the parser. In principle you could instantiate the parser directly ( <tt>Parser parser = new AptParser();</tt> ) but then some special features like macros will not be available.</p><p>You could also use the <a class="externalLink" href="http://maven.apache.org/doxia/doxia-tools/doxia-converter/index.html">Doxia Converter Tool</a> to parse a given file/dir to another file/dir.</p></div><div class="section"><h3><a name="Generating_documents">Generating documents</a></h3><p>The snippet below gives a simple example of how to generate a document using the Doxia Sink API.</p><div class="source"><pre> /**
+ parser.parse( reader, sink );</pre></div>
+<p>It is recommended that you use <a class="externalLink" href="http://plexus.codehaus.org/">Plexus</a> to look up the parser. In principle you could instantiate the parser directly ( <tt>Parser parser = new AptParser();</tt> ) but then some special features like macros will not be available.</p>
+<p>You could also use the <a class="externalLink" href="http://maven.apache.org/doxia/doxia-tools/doxia-converter/index.html">Doxia Converter Tool</a> to parse a given file/dir to another file/dir.</p></div>
+<div class="section">
+<h3><a name="Generating_documents">Generating documents</a></h3>
+<p>The snippet below gives a simple example of how to generate a document using the Doxia Sink API.</p>
+<div class="source">
+<pre> /**
* Generate a simple document and emit it
* into the specified sink. The sink is flushed but not closed.
*
@@ -281,17 +301,41 @@
sink.body_();
sink.flush();
- }</pre></div><p>A more complete example that also shows the 'canonical' order of events to use when generating a document, can be found in the Doxia <a href="./doxia/doxia-core/xref-test/org/apache/maven/doxia/sink/SinkTestDocument.html">SinkTestDocument</a> class.</p></div><div class="section"><h3><a name="Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></h3><p>With Doxia 1.1 a number of methods have been added to the Sink API that allow to pass a set of attributes to many sink events. A typical use case would be:</p><div class="source"><pre>SinkEventAttributeSet atts = new SinkEventAttributeSet();
+ }</pre></div>
+<p>A more complete example that also shows the 'canonical' order of events to use when generating a document, can be found in the Doxia <a href="./doxia/doxia-core/xref-test/org/apache/maven/doxia/sink/SinkTestDocument.html">SinkTestDocument</a> class.</p></div>
+<div class="section">
+<h3><a name="Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></h3>
+<p>With Doxia 1.1 a number of methods have been added to the Sink API that allow to pass a set of attributes to many sink events. A typical use case would be:</p>
+<div class="source">
+<pre>SinkEventAttributeSet atts = new SinkEventAttributeSet();
atts.addAttribute( SinkEventAttributes.ALIGN, "center" );
-sink.paragraph( atts );</pre></div><p>What kind of attributes are supported depends on the event and the sink implementation. The sink API specifies a list of suggested attribute names that sinks are expected to recognize, and parsers are expected to use preferably when emitting events.</p></div><div class="section"><h3><a name="Avoid_sink.rawText">Avoid sink.rawText!</a></h3><p>In <b>Doxia 1.0</b> it was a common practice to use sink.rawText() to generate elements that were not supported by the Sink API. For example, the following snippet could be used to generate a styled HTML <div> block:</p><div class="source"><pre>sink.RawText( "<div style=\"cool\">" );
+sink.paragraph( atts );</pre></div>
+<p>What kind of attributes are supported depends on the event and the sink implementation. The sink API specifies a list of suggested attribute names that sinks are expected to recognize, and parsers are expected to use preferably when emitting events.</p></div>
+<div class="section">
+<h3><a name="Avoid_sink.rawText">Avoid sink.rawText!</a></h3>
+<p>In <b>Doxia 1.0</b> it was a common practice to use sink.rawText() to generate elements that were not supported by the Sink API. For example, the following snippet could be used to generate a styled HTML <div> block:</p>
+<div class="source">
+<pre>sink.RawText( "<div style=\"cool\">" );
sink.text( "A text with a cool style." );
-sink.rawText( "</div>" );</pre></div><p>This has a major drawback however: it only works if the receiving Sink is a HTML Sink. In other words, the above method will not work for target documents in any other format than HTML (think of the FO Sink to generate a pdf, or a LaTeX sink,...).</p><p>In <b>Doxia 1.1</b> a new method unknown() was added to the Sink API that can be used to emit an arbitrary event without making special assumptions about the receiving Sink. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc.</p><p>The correct way to generate the above <div> block is now:</p><div class="source"><pre>SinkEventAttributeSet atts = new SinkEventAttributeSet();
+sink.rawText( "</div>" );</pre></div>
+<p>This has a major drawback however: it only works if the receiving Sink is a HTML Sink. In other words, the above method will not work for target documents in any other format than HTML (think of the FO Sink to generate a pdf, or a LaTeX sink,...).</p>
+<p>In <b>Doxia 1.1</b> a new method unknown() was added to the Sink API that can be used to emit an arbitrary event without making special assumptions about the receiving Sink. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc.</p>
+<p>The correct way to generate the above <div> block is now:</p>
+<div class="source">
+<pre>SinkEventAttributeSet atts = new SinkEventAttributeSet();
atts.addAttribute( SinkEventAttributes.STYLE, "cool" );
sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_START )}, atts );
sink.text( "A text with a cool style." );
-sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</pre></div><p>Read the javadocs of the unknown() method in the <a href="./doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html">Sink</a> interface and the <a href="./doxia/doxia-core/apidocs/org/apache/maven/doxia/sink/XhtmlBaseSink.html">XhtmlbaseSink</a> for information on the method parameters. Note that an arbitrary sink may be expected to ignore the unknown event completely!</p><p><b>In general, the rawText method should be avoided alltogether when emitting events into an arbitrary Sink.</b></p></div><div class="section"><h3><a name="How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></h3><p>Related to the above, here is the correct way of injecting a javascript snippet into a Sink:</p><div class="source"><pre>// the javascript code is emitted within a commented CDATA section
+sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</pre></div>
+<p>Read the javadocs of the unknown() method in the <a href="./doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html">Sink</a> interface and the <a href="./doxia/doxia-core/apidocs/org/apache/maven/doxia/sink/XhtmlBaseSink.html">XhtmlbaseSink</a> for information on the method parameters. Note that an arbitrary sink may be expected to ignore the unknown event completely!</p>
+<p><b>In general, the rawText method should be avoided alltogether when emitting events into an arbitrary Sink.</b></p></div>
+<div class="section">
+<h3><a name="How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></h3>
+<p>Related to the above, here is the correct way of injecting a javascript snippet into a Sink:</p>
+<div class="source">
+<pre>// the javascript code is emitted within a commented CDATA section
// so we have to start with a newline and comment the CDATA closing in the end
// note that the sink will replace the newline by the system EOL
String javascriptCode = "\n function javascriptFunction() {...} \n //";
@@ -301,7 +345,14 @@ atts.addAttribute( SinkEventAttributes.T
sink.unknown( "script", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_START )}, atts );
sink.unknown( "cdata", new Object[]{new Integer( HtmlMarkup.CDATA_TYPE ), javascriptCode }, null );
-sink.unknown( "script", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</pre></div></div><div class="section"><h3><a name="References">References</a></h3><ul><li><a href="../modules/index.html">Doxia Modules Guide</a></li><li><a href="../macros/index.html">Doxia Macros Guide</a></li><li><a href="../doxia/apidocs/index.html">Doxia API Reference</a></li><li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></div></div>
+sink.unknown( "script", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</pre></div></div>
+<div class="section">
+<h3><a name="References">References</a></h3>
+<ul>
+<li><a href="../modules/index.html">Doxia Modules Guide</a></li>
+<li><a href="../macros/index.html">Doxia Macros Guide</a></li>
+<li><a href="../doxia/apidocs/index.html">Doxia API Reference</a></li>
+<li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></div></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/distribution-management.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/distribution-management.html (original)
+++ websites/staging/maven-doxia/trunk/content/distribution-management.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -255,7 +255,16 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Overview<a name="Overview"></a></h2><a name="Overview"></a><p>The following is the distribution management information used by this project.</p><div class="section"><h3>Repository - apache.releases.https<a name="Repository_-_apache.releases.https"></a></h3><a name="Repository_-_apache.releases.https"></a><a class="externalLink" href="https://repository.apache.org/service/local/staging/deploy/maven2">https://repository.apache.org/service/local/staging/deploy/maven2</a></div><div class="section"><h3>Snapshot Repository - apache.snapshots.https<a name="Snapshot_Repository_-_apache.snapshots.https"></a></h3><a name="Snapshot_Repository_-_apache.snapshots.https"></a><a class="externalLink" href="https://repository.apache.org/content/repositories/snapshots">https://repository.apache.org/content/repositories/snapshots</a></div><div class="section"><h3>Site - apache.website<a name="Site_-_apache.website"></a></h3><a name="Site_-_apache.website"></a><p>scp://
people.apache.org/www/maven.apache.org/doxia/</p></div></div>
+ <div class="section">
+<h2>Overview<a name="Overview"></a></h2><a name="Overview"></a>
+<p>The following is the distribution management information used by this project.</p>
+<div class="section">
+<h3>Repository - apache.releases.https<a name="Repository_-_apache.releases.https"></a></h3><a name="Repository_-_apache.releases.https"></a><a class="externalLink" href="https://repository.apache.org/service/local/staging/deploy/maven2">https://repository.apache.org/service/local/staging/deploy/maven2</a></div>
+<div class="section">
+<h3>Snapshot Repository - apache.snapshots.https<a name="Snapshot_Repository_-_apache.snapshots.https"></a></h3><a name="Snapshot_Repository_-_apache.snapshots.https"></a><a class="externalLink" href="https://repository.apache.org/content/repositories/snapshots">https://repository.apache.org/content/repositories/snapshots</a></div>
+<div class="section">
+<h3>Site - apache.website<a name="Site_-_apache.website"></a></h3><a name="Site_-_apache.website"></a>
+<p>scp://people.apache.org/www/maven.apache.org/doxia/</p></div></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/downloads.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/downloads.html (original)
+++ websites/staging/maven-doxia/trunk/content/downloads.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -213,7 +213,12 @@
</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/references/apt-
format.html --><div class="section"><h2>Maven Doxia Releases<a name="Maven_Doxia_Releases"></a></h2><p>Releases of Maven Doxia are made available in both binary and source distributions. Individual JARs are also made available through Apache Maven repositories.</p><p>Releases of all Doxia sub-projects (currently Doxia, Doxia Sitetools and Doxia Tools) may be downloaded from Maven's central repository:</p><ul><li><a class="externalLink" href="http://repo.maven.apache.org/maven2/org/apache/maven/doxia/">http://repo.maven.apache.org/maven2/org/apache/maven/doxia/</a></li></ul></div>
+ <!-- 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/references/apt-
format.html --><div class="section">
+<h2>Maven Doxia Releases<a name="Maven_Doxia_Releases"></a></h2>
+<p>Releases of Maven Doxia are made available in both binary and source distributions. Individual JARs are also made available through Apache Maven repositories.</p>
+<p>Releases of all Doxia sub-projects (currently Doxia, Doxia Sitetools and Doxia Tools) may be downloaded from Maven's central repository:</p>
+<ul>
+<li><a class="externalLink" href="http://repo.maven.apache.org/maven2/org/apache/maven/doxia/">http://repo.maven.apache.org/maven2/org/apache/maven/doxia/</a></li></ul></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/doxia-1.4.pdf
==============================================================================
Binary files - no diff available.
Modified: websites/staging/maven-doxia/trunk/content/doxia-example-book/aegis-binding.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/doxia-example-book/aegis-binding.html (original)
+++ websites/staging/maven-doxia/trunk/content/doxia-example-book/aegis-binding.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -212,7 +212,22 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2></h2><!-- Navigation Panel --><table class="bodyTable" width="100%" align="center" border="0"><tr class="a"><td align="left">Previous: <a href="bindings.html">Bindings Overview</a></td><td align="center">Up: <a href="bind.html">Bindings</a></td><td align="right">Next: <a href="castor.html">Castor</a></td></tr></table><!-- End of Navigation Panel --><hr /></div><div class="section"><h2>Aegis Binding<a name="Aegis_Binding"></a></h2><p>Aegis is the default XFire binding which maps XML to POJOs. It supports code first development only at this point - i.e. you write your service in POJOs and it will generate the XML schema/wsdl for you.</p></div><div class="section"><h2>XML and Annotation Mapping Overview<a name="XML_and_Annotation_Mapping_Overview"></a></h2><p>Aegis has a flexible mapping system so you can control how your beans are controlled. By default your POJOs are serialized based on their name and namespaces. If you have a class in the "org.c
odehaus.xfire" package named "Employee" it would be serialized in namespace "http://xfire.codehaus.org" with the local name "YourBean."</p><p>Fore example, the java class:</p><div class="source"><pre>public class Employee
+ <div class="section">
+<h2></h2><!-- Navigation Panel -->
+<table class="bodyTable" width="100%" align="center" border="0">
+<tr class="a">
+<td align="left">Previous: <a href="bindings.html">Bindings Overview</a></td>
+<td align="center">Up: <a href="bind.html">Bindings</a></td>
+<td align="right">Next: <a href="castor.html">Castor</a></td></tr></table><!-- End of Navigation Panel --><hr /></div>
+<div class="section">
+<h2>Aegis Binding<a name="Aegis_Binding"></a></h2>
+<p>Aegis is the default XFire binding which maps XML to POJOs. It supports code first development only at this point - i.e. you write your service in POJOs and it will generate the XML schema/wsdl for you.</p></div>
+<div class="section">
+<h2>XML and Annotation Mapping Overview<a name="XML_and_Annotation_Mapping_Overview"></a></h2>
+<p>Aegis has a flexible mapping system so you can control how your beans are controlled. By default your POJOs are serialized based on their name and namespaces. If you have a class in the "org.codehaus.xfire" package named "Employee" it would be serialized in namespace "http://xfire.codehaus.org" with the local name "YourBean."</p>
+<p>Fore example, the java class:</p>
+<div class="source">
+<pre>public class Employee
{
private String name;
private String title;
@@ -222,15 +237,36 @@
public String getTitle() { return title; }
public void setTitle(String title) { this.title = title; }
-}</pre></div><p>In XML this translates to:</p><div class="source"><pre><Employee xmlns="http://xfire.codehaus.org">
+}</pre></div>
+<p>In XML this translates to:</p>
+<div class="source">
+<pre><Employee xmlns="http://xfire.codehaus.org">
<name>Santa Claus</name>
<title>Chief Present Officer (CPO)</title>
-</Employee></pre></div><p>In XML Schema this would become a complex type:</p><div class="source"><pre><xsd:complexType name="Employee">
+</Employee></pre></div>
+<p>In XML Schema this would become a complex type:</p>
+<div class="source">
+<pre><xsd:complexType name="Employee">
<xsd:sequence>
<xsd:element name="name" type="xsd:string" minOccurs="0" maxOccurs="1/>
<xsd:element name="title" type="xsd:string" minOccurs="0" maxOccurs="1/>
</xsd:sequence>
-</xsd:complexType></pre></div><p><i>Validate your mapping!</i> You can find an XML Schema for Aegis mapping files <a class="externalLink" href="http://xfire.codehaus.org/schemas/1.0/mapping.xsd">here</a>.</p><div class="section"><h3>Supported Types<a name="Supported_Types"></a></h3><ul><li>Basic types: int, double, float, long, byte[], short, String, BigDecimal</li><li>Arrays</li><li>Collections</li><li>Dates: java.util.Date, java.util.Calendar, java.sql.Timestamp, java.sql.Date, java.sql.Time</li><li>XML: org.w3c.dom.Docmument, org.jdom.Element, XMLStreamReader, Source</li><li>Complex types which are aggregations of the above</li></ul><p>If you have constructors defined in your Java beans, make sure a default constructor (i.e. no arguments) is also declared. (Aegis needs a no-argument contstructor to instantiate client Java classes.) Controlling Mappings with XML</p><p>Its easy to control how your service and its beans are mapped to xml. If you are using Java 5.0 skip straigh
t down to that section otherwise read on to learn how to configure serialization via mapping files.</p><p>Mapping files must exist in the same package as your bean or service class on the class path. In the above example the mapping file would be named "/org/codehaus/xfire/YourBean.aegis.xml", with the following format:</p><div class="source"><pre><mappings>
+</xsd:complexType></pre></div>
+<p><i>Validate your mapping!</i> You can find an XML Schema for Aegis mapping files <a class="externalLink" href="http://xfire.codehaus.org/schemas/1.0/mapping.xsd">here</a>.</p>
+<div class="section">
+<h3>Supported Types<a name="Supported_Types"></a></h3>
+<ul>
+<li>Basic types: int, double, float, long, byte[], short, String, BigDecimal</li>
+<li>Arrays</li>
+<li>Collections</li>
+<li>Dates: java.util.Date, java.util.Calendar, java.sql.Timestamp, java.sql.Date, java.sql.Time</li>
+<li>XML: org.w3c.dom.Docmument, org.jdom.Element, XMLStreamReader, Source</li>
+<li>Complex types which are aggregations of the above</li></ul>
+<p>If you have constructors defined in your Java beans, make sure a default constructor (i.e. no arguments) is also declared. (Aegis needs a no-argument contstructor to instantiate client Java classes.) Controlling Mappings with XML</p>
+<p>Its easy to control how your service and its beans are mapped to xml. If you are using Java 5.0 skip straight down to that section otherwise read on to learn how to configure serialization via mapping files.</p>
+<p>Mapping files must exist in the same package as your bean or service class on the class path. In the above example the mapping file would be named "/org/codehaus/xfire/YourBean.aegis.xml", with the following format:</p>
+<div class="source">
+<pre><mappings>
<mapping uri="" name="">
<method name="methodName">
<return-type mappedName="" componentType=""/>
@@ -238,37 +274,72 @@
</method>
<property name="" mappedName="" style="attribute|element" componentType=""/>
</mapping>
-</mappings></pre></div><p>Note that <tt> <method> </tt> is used to configure methods on your service and <i>property</i> is used to configure properties on your javabeans.</p><p>The above example highlights many of the possible elements, most are optional and the format encourages minimally specified mappings.</p></div></div><div class="section"><h2>Controlling Naming<a name="Controlling_Naming"></a></h2><p>Lets pretend that in the above example you would like the elements names to be capatilized and in the namespace "urn:north-pole:operations". You could achieve this through a mapping file like so:</p><div class="source"><pre><mappings xmlns:np="urn:north-pole:operations">
+</mappings></pre></div>
+<p>Note that <tt> <method> </tt> is used to configure methods on your service and <i>property</i> is used to configure properties on your javabeans.</p>
+<p>The above example highlights many of the possible elements, most are optional and the format encourages minimally specified mappings.</p></div></div>
+<div class="section">
+<h2>Controlling Naming<a name="Controlling_Naming"></a></h2>
+<p>Lets pretend that in the above example you would like the elements names to be capatilized and in the namespace "urn:north-pole:operations". You could achieve this through a mapping file like so:</p>
+<div class="source">
+<pre><mappings xmlns:np="urn:north-pole:operations">
<mapping name="np:Employee">
<property name="name" mappedName="Name"/>
<property name="title" mappedName="Title"/>
</mapping>
-</mappings></pre></div><p>Notice that the namespace was declared on the mappings element and then the prefix was used to specify the element QNames for the name/title properties.</p><p>This will result in a mapping like so:</p><div class="source"><pre><np:Employee xmlns:np="urn:north-pole:operations">
+</mappings></pre></div>
+<p>Notice that the namespace was declared on the mappings element and then the prefix was used to specify the element QNames for the name/title properties.</p>
+<p>This will result in a mapping like so:</p>
+<div class="source">
+<pre><np:Employee xmlns:np="urn:north-pole:operations">
<np:Name>Santa Claus</np:Name>
<np:Title>Chief Present Officer (CPO)</np:Title>
-</np:Employee></pre></div><div class="section"><h3>Ignoring properties<a name="Ignoring_properties"></a></h3><p>If you don't want to serialize a certain property it is easy to ignore it:</p><div class="source"><pre><mappings>
+</np:Employee></pre></div>
+<div class="section">
+<h3>Ignoring properties<a name="Ignoring_properties"></a></h3>
+<p>If you don't want to serialize a certain property it is easy to ignore it:</p>
+<div class="source">
+<pre><mappings>
<mapping>
<property name="propertyName" ignore="true"/>
</mapping>
-</mappings></pre></div></div><div class="section"><h3>Handling Collections<a name="Handling_Collections"></a></h3><p>You undoubtedly use Collections in your code. Pre Java 5 it is impossible to determine the "component type" of a Collection by introspection. So you need to give Aegis some hints. For a service which returned a Collection of employees like so:</p><div class="source"><pre>public class EmployeeService
+</mappings></pre></div></div>
+<div class="section">
+<h3>Handling Collections<a name="Handling_Collections"></a></h3>
+<p>You undoubtedly use Collections in your code. Pre Java 5 it is impossible to determine the "component type" of a Collection by introspection. So you need to give Aegis some hints. For a service which returned a Collection of employees like so:</p>
+<div class="source">
+<pre>public class EmployeeService
{
Collection getEmployees(String id) { ... }
-}</pre></div><p>You would need to supply metadata which gave the component type in a mapping file like this one:</p><div class="source"><pre><mappings>
+}</pre></div>
+<p>You would need to supply metadata which gave the component type in a mapping file like this one:</p>
+<div class="source">
+<pre><mappings>
<mapping>
<method name="getEmployees">
<return-type componentType="org.codehaus.xfire.Employee" />
</method>
</mapping>
-</mappings></pre></div></div><div class="section"><h3>Handling Maps<a name="Handling_Maps"></a></h3><p>Java Maps don't map well to XML Schema (no pun intended) because there is no Map concept in XML Schema so your clients. Maps are transformed to a collection of <a name="key_value">key, value</a> tuples instead. In addition to providing the type of the value, you must also provide Aegis with the type of the key:</p><div class="source"><pre>public class GiftService
+</mappings></pre></div></div>
+<div class="section">
+<h3>Handling Maps<a name="Handling_Maps"></a></h3>
+<p>Java Maps don't map well to XML Schema (no pun intended) because there is no Map concept in XML Schema so your clients. Maps are transformed to a collection of <a name="key_value">key, value</a> tuples instead. In addition to providing the type of the value, you must also provide Aegis with the type of the key:</p>
+<div class="source">
+<pre>public class GiftService
{
Map getGiftList() { /* returns a map of NiceChild => Present */ }
-}</pre></div><p>The mapping file should look like this:</p><div class="source"><pre><mappings>
+}</pre></div>
+<p>The mapping file should look like this:</p>
+<div class="source">
+<pre><mappings>
<mapping>
<method name="getGiftList">
<return-type keyType="org.codehaus.xfire.NiceChild" componentType="org.codehaus.xfire.Present">
</method>
</mapping>
-</mappings></pre></div><p>This will generate the following type:</p><div class="source"><pre><xsd:complexType name="NiceChild2PresentMap">
+</mappings></pre></div>
+<p>This will generate the following type:</p>
+<div class="source">
+<pre><xsd:complexType name="NiceChild2PresentMap">
<xsd:sequence>
<xsd:element name="entry" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
@@ -279,11 +350,26 @@
</xsd:complexType>
</xsd:element>
</xsd:sequence>
-</xsd:complexType></pre></div></div></div><div class="section"><h2>Interfaces and Aegis<a name="Interfaces_and_Aegis"></a></h2><p>The Aegis binding will automatically create proxies for your interfaces when reading XML. So if you have an interface like this:</p><div class="source"><pre>public interface User {
+</xsd:complexType></pre></div></div></div>
+<div class="section">
+<h2>Interfaces and Aegis<a name="Interfaces_and_Aegis"></a></h2>
+<p>The Aegis binding will automatically create proxies for your interfaces when reading XML. So if you have an interface like this:</p>
+<div class="source">
+<pre>public interface User {
public String getUsername();
public String getPasswrod();
-}</pre></div><p>It will then create its own implementation of User and provide a username and password from the XML. You can specify your implementation class (in 1.1+) by setting a property on your service:</p><div class="source"><pre>Service service = ...;
-service.setProperty("com.acme.User.implementation", "com.acme.UserImpl");</pre></div></div><div class="section"><h2></h2><hr /><!-- Navigation Panel --><table class="bodyTable" width="100%" align="center" border="0"><tr class="a"><td align="left">Previous: <a href="bindings.html">Bindings Overview</a></td><td align="center">Up: <a href="bind.html">Bindings</a></td><td align="right">Next: <a href="castor.html">Castor</a></td></tr></table><!-- End of Navigation Panel --></div>
+}</pre></div>
+<p>It will then create its own implementation of User and provide a username and password from the XML. You can specify your implementation class (in 1.1+) by setting a property on your service:</p>
+<div class="source">
+<pre>Service service = ...;
+service.setProperty("com.acme.User.implementation", "com.acme.UserImpl");</pre></div></div>
+<div class="section">
+<h2></h2><hr /><!-- Navigation Panel -->
+<table class="bodyTable" width="100%" align="center" border="0">
+<tr class="a">
+<td align="left">Previous: <a href="bindings.html">Bindings Overview</a></td>
+<td align="center">Up: <a href="bind.html">Bindings</a></td>
+<td align="right">Next: <a href="castor.html">Castor</a></td></tr></table><!-- End of Navigation Panel --></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven-doxia/trunk/content/doxia-example-book/bind.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/doxia-example-book/bind.html (original)
+++ websites/staging/maven-doxia/trunk/content/doxia-example-book/bind.html Tue Nov 19 23:44:57 2013
@@ -1,6 +1,6 @@
<!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 Nov 19, 2013
+ | Generated by Apache Maven Doxia at 2013-11-19
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -211,7 +211,46 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2></h2><!-- Navigation Panel --><table border="0" class="bodyTable" width="100%" align="center"><tr class="a"><td><div align="left">Previous:<a href="index.html">Table Of Content</a></div></td><td><div align="center">Up: <a href="index.html">Table Of Content</a></div></td><td><div align="right">Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table><!-- End of Navigation Panel --><hr /></div><div class="section"><h2>Bindings<a name="Bindings"></a></h2><ul><li><a href="bindings.html">Bindings Overview</a><ul><li><a href="bindings.html#Bindings_Overview">Bindings Overview</a></li><li><a href="bindings.html#Using_another_binding">Using another binding</a></li><li><a href="bindings.html#Convenience_ServiceFactorys">Convenience ServiceFactorys</a></li><li><a href="bindings.html#The_MessageBinding">The MessageBinding</a></li></ul></li><li><a href="aegis-binding.html">Aegis Binding</a><ul><li><a href="aegis-binding.html#Aegis_Binding">Aegi
s Binding</a></li><li><a href="aegis-binding.html#XML_and_Annotation_Mapping_Overview">XML and Annotation Mapping Overview</a></li><li><a href="aegis-binding.html#Controlling_Naming">Controlling Naming</a></li><li><a href="aegis-binding.html#Interfaces_and_Aegis">Interfaces and Aegis</a></li></ul></li><li><a href="castor.html">Castor</a><ul><li><a href="castor.html#Castor">Castor</a></li><li><a href="castor.html#Top-down_Approach_starting_with_XML_schema:">Top-down Approach (starting with XML schema):</a></li><li><a href="castor.html#Bottom-up_Approach_starting_with_Java_classes:">Bottom-up Approach (starting with Java classes):</a></li></ul></li></ul></div><div class="section"><h2></h2><hr /><!-- Navigation Panel --><table border="0" class="bodyTable" width="100%" align="center"><tr class="a"><td><div align="left">Previous:<a href="index.html">Table Of Content</a></div></td><td><div align="center">Up: <a href="index.html">Table Of Content</a></div></td><td><div align="right">Next:
<a href="bindings.html">Bindings Overview</a></div></td></tr></table><!-- End of Navigation Panel --></div>
+ <div class="section">
+<h2></h2><!-- Navigation Panel -->
+<table border="0" class="bodyTable" width="100%" align="center">
+<tr class="a">
+<td>
+<div align="left">Previous:<a href="index.html">Table Of Content</a></div></td>
+<td>
+<div align="center">Up: <a href="index.html">Table Of Content</a></div></td>
+<td>
+<div align="right">Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table><!-- End of Navigation Panel --><hr /></div>
+<div class="section">
+<h2>Bindings<a name="Bindings"></a></h2>
+<ul>
+<li><a href="bindings.html">Bindings Overview</a>
+<ul>
+<li><a href="bindings.html#Bindings_Overview">Bindings Overview</a></li>
+<li><a href="bindings.html#Using_another_binding">Using another binding</a></li>
+<li><a href="bindings.html#Convenience_ServiceFactorys">Convenience ServiceFactorys</a></li>
+<li><a href="bindings.html#The_MessageBinding">The MessageBinding</a></li></ul></li>
+<li><a href="aegis-binding.html">Aegis Binding</a>
+<ul>
+<li><a href="aegis-binding.html#Aegis_Binding">Aegis Binding</a></li>
+<li><a href="aegis-binding.html#XML_and_Annotation_Mapping_Overview">XML and Annotation Mapping Overview</a></li>
+<li><a href="aegis-binding.html#Controlling_Naming">Controlling Naming</a></li>
+<li><a href="aegis-binding.html#Interfaces_and_Aegis">Interfaces and Aegis</a></li></ul></li>
+<li><a href="castor.html">Castor</a>
+<ul>
+<li><a href="castor.html#Castor">Castor</a></li>
+<li><a href="castor.html#Top-down_Approach_starting_with_XML_schema:">Top-down Approach (starting with XML schema):</a></li>
+<li><a href="castor.html#Bottom-up_Approach_starting_with_Java_classes:">Bottom-up Approach (starting with Java classes):</a></li></ul></li></ul></div>
+<div class="section">
+<h2></h2><hr /><!-- Navigation Panel -->
+<table border="0" class="bodyTable" width="100%" align="center">
+<tr class="a">
+<td>
+<div align="left">Previous:<a href="index.html">Table Of Content</a></div></td>
+<td>
+<div align="center">Up: <a href="index.html">Table Of Content</a></div></td>
+<td>
+<div align="right">Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table><!-- End of Navigation Panel --></div>
</div>
</div>
<div class="clear">