You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commons-dev@ws.apache.org by ve...@apache.org on 2009/07/26 11:40:33 UTC
svn commit: r797885 - in /webservices/commons/trunk/modules/axiom: pom.xml
src/docbkx/devguide.xml src/site/site.xml
Author: veithen
Date: Sun Jul 26 09:40:33 2009
New Revision: 797885
URL: http://svn.apache.org/viewvc?rev=797885&view=rev
Log:
Added a Developer Guide document.
Added:
webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml (with props)
Modified:
webservices/commons/trunk/modules/axiom/pom.xml
webservices/commons/trunk/modules/axiom/src/site/site.xml
Modified: webservices/commons/trunk/modules/axiom/pom.xml
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/pom.xml?rev=797885&r1=797884&r2=797885&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/pom.xml (original)
+++ webservices/commons/trunk/modules/axiom/pom.xml Sun Jul 26 09:40:33 2009
@@ -389,6 +389,14 @@
<name>java.awt.headless</name>
<value>true</value>
</property>
+ <!-- property>
+ <name>javax.xml.stream.XMLInputFactory</name>
+ <value>com.bea.xml.stream.MXParserFactory</value>
+ </property>
+ <property>
+ <name>javax.xml.stream.XMLOutputFactory</name>
+ <value>com.bea.xml.stream.XMLOutputFactoryBase</value>
+ </property -->
</systemProperties>
</configuration>
</plugin>
@@ -445,6 +453,7 @@
</goals>
<phase>pre-site</phase>
<configuration>
+ <includes>tutorial.xml</includes>
<chunkedOutput>true</chunkedOutput>
<targetDirectory>target/site/tutorial</targetDirectory>
<htmlCustomization>src/docbkx/xsl/html.xsl</htmlCustomization>
@@ -459,12 +468,34 @@
</configuration>
</execution>
<execution>
+ <id>devguide-html</id>
+ <goals>
+ <goal>generate-html</goal>
+ </goals>
+ <phase>pre-site</phase>
+ <configuration>
+ <includes>devguide.xml</includes>
+ <chunkedOutput>true</chunkedOutput>
+ <targetDirectory>target/site/devguide</targetDirectory>
+ <htmlCustomization>src/docbkx/xsl/html.xsl</htmlCustomization>
+ <postProcess>
+ <copy todir="target/site/devguide/images">
+ <fileset dir="src/docbkx/images">
+ <include name="**/*.jpg"/>
+ <include name="**/*.png"/>
+ </fileset>
+ </copy>
+ </postProcess>
+ </configuration>
+ </execution>
+ <execution>
<id>tutorial-pdf</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>pre-site</phase>
<configuration>
+ <includes>tutorial.xml</includes>
<foCustomization>src/docbkx/xsl/fo.xsl</foCustomization>
<postProcess>
<copy file="target/docbkx/pdf/tutorial.pdf"
@@ -472,6 +503,21 @@
</postProcess>
</configuration>
</execution>
+ <execution>
+ <id>devguide-pdf</id>
+ <goals>
+ <goal>generate-pdf</goal>
+ </goals>
+ <phase>pre-site</phase>
+ <configuration>
+ <includes>devguide.xml</includes>
+ <foCustomization>src/docbkx/xsl/fo.xsl</foCustomization>
+ <postProcess>
+ <copy file="target/docbkx/pdf/devguide.pdf"
+ tofile="target/site/devguide.pdf"/>
+ </postProcess>
+ </configuration>
+ </execution>
</executions>
<dependencies>
<dependency>
@@ -681,5 +727,10 @@
<stax.impl.artifact>sjsxp</stax.impl.artifact>
<stax.impl.version>1.0.1</stax.impl.version>
-->
+ <!--
+ <stax.impl.groupid>stax</stax.impl.groupid>
+ <stax.impl.artifact>stax</stax.impl.artifact>
+ <stax.impl.version>1.2.0</stax.impl.version>
+ -->
</properties>
</project>
Added: webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml?rev=797885&view=auto
==============================================================================
--- webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml (added)
+++ webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml Sun Jul 26 09:40:33 2009
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<!--
+ ~ 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.
+ -->
+<book>
+ <bookinfo>
+ <title>Axiom Developer Guide</title>
+ <releaseinfo>&version;</releaseinfo>
+
+ <legalnotice>
+ <para>
+ 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
+ </para>
+ <para>
+ <ulink url="http://www.apache.org/licenses/LICENSE-2.0"/>
+ </para>
+ <para>
+ 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.
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+ <toc/>
+
+ <chapter>
+ <title>Testing</title>
+ <section>
+ <title>Testing Axiom with different StAX implementations</title>
+ <para>
+ The following StAX implementations are available to test compatibility with Axiom:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Woodstox</term>
+ <listitem>
+ <para>
+ This is the StAX implementation that Axiom uses by default.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Sun Java Streaming XML Parser (SJSXP)</term>
+ <listitem>
+ <para>
+ This implementation is available as Maven artifact <literal>com.sun.xml.stream:sjsxp:1.0.1</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>StAX Reference Implementation</term>
+ <listitem>
+ <para>
+ The reference implementation was written by BEA and is available as Maven artifact
+ <literal>stax:stax:1.2.0</literal>. The homepage is <ulink url="http://stax.codehaus.org/Home"/>.
+ Note that the JAR doesn't contain the necessary files to enable service discovery.
+ Geronimo's implementation of the StAX API library will not be able to locate
+ the reference implementation unless the following system properties are set:
+ </para>
+<programlisting>javax.xml.stream.XMLInputFactory=com.bea.xml.stream.MXParserFactory
+javax.xml.stream.XMLOutputFactory=com.bea.xml.stream.XMLOutputFactoryBase</programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+ </chapter>
+</book>
\ No newline at end of file
Propchange: webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: webservices/commons/trunk/modules/axiom/src/site/site.xml
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/src/site/site.xml?rev=797885&r1=797884&r2=797885&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/src/site/site.xml (original)
+++ webservices/commons/trunk/modules/axiom/src/site/site.xml Sun Jul 26 09:40:33 2009
@@ -39,6 +39,8 @@
<item name="Documentation">
<item name="Tutorial" href="tutorial/tutorial.html"/>
<item name="Tutorial (PDF)" href="tutorial.pdf"/>
+ <item name="Dev guide" href="devguide/devguide.html"/>
+ <item name="Dev guide (PDF)" href="devguide.pdf"/>
<item name="Javadocs" href="/apidocs/index.html"/>
<item name="FAQ" href="faq.html"/>
<item name="View Source" href="http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/?root=Apache-SVN"/>