[jboss-svn-commits] JBoss Common SVN: r3754 - in shrinkwrap/trunk: doc and 5 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Nov 17 04:28:15 EST 2009
Author: aslak
Date: 2009-11-17 04:28:15 -0500 (Tue, 17 Nov 2009)
New Revision: 3754
Added:
shrinkwrap/trunk/doc/
shrinkwrap/trunk/doc/reference/
shrinkwrap/trunk/doc/reference/pom.xml
shrinkwrap/trunk/doc/reference/src/
shrinkwrap/trunk/doc/reference/src/main/
shrinkwrap/trunk/doc/reference/src/main/docbook/
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/api.xml
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/author_info.xml
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/book_info.xml
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/examples.xml
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/exporters.xml
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/extensions.xml
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/importers.xml
shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/master.xml
Log:
SHRINKWRAP-82 Added ShrinkWrap Reference Guide docbook project. Not defines as a module in root pom as of now.
Added: shrinkwrap/trunk/doc/reference/pom.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/pom.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/pom.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,82 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+ <!-- Parent -->
+ <parent>
+ <groupId>org.jboss.shrinkwrap</groupId>
+ <artifactId>shrinkwrap-build</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <relativePath>../../build/pom.xml</relativePath>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>shrinkwrap-reference-guide</artifactId>
+ <packaging>jdocbook</packaging>
+ <name>ShrinkWrap Reference Guide</name>
+
+ <properties>
+ <mpjdocbook.version>2.2.0</mpjdocbook.version>
+ <pdf.name>${project.artifactId}.pdf</pdf.name>
+ </properties>
+
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>${mpjdocbook.version}</version>
+ <extensions>true</extensions>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-docbook-xslt</artifactId>
+ <version>1.1.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.1.0</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDocumentName>master.xml</sourceDocumentName>
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath://xslt/org/jboss/pdf.xsl</stylesheetResource>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath://xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ </format>
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath://xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ </format>
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <docbookVersion>1.72.0</docbookVersion>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ </transformerParameters>
+ <localeSeparator>-</localeSeparator>
+ </options>
+ </configuration>
+
+ </plugin>
+ </plugins>
+ </build>
+</project>
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/api.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/api.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/api.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,84 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<chapter id="api">
+ <title>API</title>
+
+ <section id="api.archive">
+ <title>Archive</title>
+ <para></para>
+ </section>
+
+ <section id="api.archives">
+ <title>Archives</title>
+ <para></para>
+ </section>
+
+ <section id="api.path">
+ <title>Path</title>
+ <para></para>
+ </section>
+
+ <section id="api.paths">
+ <title>Paths</title>
+ <para></para>
+ </section>
+
+ <section id="api.asset">
+ <title>Asset</title>
+ <para></para>
+ </section>
+
+ <section id="api.container">
+ <title>Containers</title>
+ <para></para>
+ <section id="api.container.class">
+ <title>ClassContainer</title>
+ <para></para>
+ </section>
+ <section id="api.container.manifest">
+ <title>ManifestContainer</title>
+ <para></para>
+ </section>
+ <section id="api.container.library">
+ <title>LibraryContainer</title>
+ <para></para>
+ </section>
+ <section id="api.container.resource">
+ <title>ResourceContainer</title>
+ <para></para>
+ </section>
+ <section id="api.container.web">
+ <title>WebContainer</title>
+ <para></para>
+ </section>
+ <section id="api.container.enterprise">
+ <title>EnterpriseContainer</title>
+ <para></para>
+ </section>
+ <section id="api.container.resourceadapter">
+ <title>ResoruceAdapterContainer</title>
+ <para></para>
+ </section>
+ </section>
+
+ <section id="api.spec">
+ <title>Archive Specifications</title>
+ <section id="api.spec.jar">
+ <title>JavaArchive</title>
+ <para></para>
+ </section>
+ <section id="api.spec.war">
+ <title>WebArchive</title>
+ <para></para>
+ </section>
+ <section id="api.spec.ear">
+ <title>EnterpriseArchive</title>
+ <para></para>
+ </section>
+ <section id="api.spec.rar">
+ <title>ResourceAdaptorArchive</title>
+ <para></para>
+ </section>
+ </section>
+</chapter>
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/author_info.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/author_info.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/author_info.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<authorgroup>
+ <author>
+ <firstname>Andrew</firstname>
+ <surname>Lee Rubinger</surname>
+ <email>alr at jboss.org</email>
+ </author>
+ <author>
+ <firstname>Aslak</firstname>
+ <surname>Knutsen</surname>
+ <email>aslak at conduct.no</email>
+ </author>
+</authorgroup>
\ No newline at end of file
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/book_info.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/book_info.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/book_info.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,26 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<bookinfo>
+ <title>ShrinkWrap</title>
+ <subtitle>Reference Guide</subtitle>
+
+ <preface>
+ <title>Skip the build!</title>
+ <para>
+ Packaging specifications such as Java Archives (JAR) and Enterprise Archives (EAR) are standard mechanisms for
+ declaring a collection of Classes and resources into one unit. Often these are intended to be run directly or
+ deployed into a web or application server. Archives carry with them implicit metadata regarding their structure,
+ from which concerns like ClassLoading scope and manifest parameters may be inferred.
+ </para>
+ <para>
+ However useful, archives typically require the addition of a build step within the development lifecycle,
+ either via a script or extra tool. The ShrinkWrap project provides a simple API to declaratively assemble
+ archives in code, optionally allowing for export into ZIP or Exploded File formats. This makes is very fast
+ to prototype "virtual" archives from resources scattered about the classpath, the filesystem or remote URLs.
+ </para>
+ </preface>
+
+ <xi:include href="author_info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</bookinfo>
\ No newline at end of file
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/examples.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/examples.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/examples.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<chapter id="examples">
+ <title>Examples</title>
+
+ <section id="examples.createjavaarchive">
+ <title>Create a JavaArchive</title>
+ <para>
+ <programlisting role="JAVA"><![CDATA[JavaArchive jar = Archives.create("test.jar", JavaArchive.class);]]></programlisting>
+ </para>
+ </section>
+
+ <section id="examples.createwebarchive">
+ <title>Create a JavaArchive</title>
+ <para>
+ <programlisting role="JAVA"><![CDATA[WebArchive jar = Archives.create("test.war", WebArchive.class);]]></programlisting>
+ </para>
+ </section>
+
+ <section id="examples.importzip">
+ <title>Import existing zip file</title>
+ <para>
+ <programlisting role="JAVA"><![CDATA[JavaArchive jar = Archives.create("test.jar", ZipImporter.class)
+ .importZip("my.zip")
+ .as(JavaArchive.class);]]></programlisting>
+ </para>
+ </section>
+
+ <section id="examples.exportzip">
+ <title>Export to zip</title>
+ <para>
+ <programlisting role="JAVA"><![CDATA[InputStream zipStream = Archives.create("test.jar", JavaArchive.class)
+ .addClass(MyClass.class)
+ .as(ZipExporter.class)
+ .exportZip();]]></programlisting>
+ </para>
+ </section>
+</chapter>
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/exporters.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/exporters.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/exporters.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<chapter id="exporters">
+ <title>Exporters</title>
+
+ <section id="exporters.zipexporter">
+ <title>ZipExporter</title>
+ <para></para>
+ </section>
+
+ <section id="exporters.explodedexporter">
+ <title>ExplodedExporter</title>
+ <para></para>
+ </section>
+</chapter>
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/extensions.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/extensions.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/extensions.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,31 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<chapter id="extensions">
+ <title>Extending the core</title>
+
+ <section id="extensions.assignable">
+ <title>Assignable</title>
+ <para></para>
+ </section>
+
+ <section id="extensions.howto">
+ <title>Howto write your own</title>
+ <section id="extensions.howto.interface">
+ <title>The interface</title>
+ <para></para>
+ </section>
+ <section id="extensions.howto.impl">
+ <title>The Implementation</title>
+ <para></para>
+ </section>
+ <section id="extensions.howto.wire">
+ <title>The Wiring</title>
+ <para></para>
+ </section>
+ <section id="extensions.howto.test">
+ <title>The Test</title>
+ <para></para>
+ </section>
+ </section>
+</chapter>
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/importers.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/importers.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/importers.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<chapter id="importers">
+ <title>Importers</title>
+
+ <section id="importers.zipimporter">
+ <title>ZipImporter</title>
+ <para></para>
+ </section>
+
+ <section id="importers.explodedimporter">
+ <title>ExplodedImporter</title>
+ <para></para>
+ </section>
+</chapter>
Added: shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/master.xml
===================================================================
--- shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/master.xml (rev 0)
+++ shrinkwrap/trunk/doc/reference/src/main/docbook/en-US/master.xml 2009-11-17 09:28:15 UTC (rev 3754)
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding="iso-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]>
+
+<book lang="en">
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="book_info.xml" />
+
+ <toc />
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="api.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="importers.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="exporters.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="extensions.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="examples.xml" />
+
+</book>
\ No newline at end of file
More information about the jboss-svn-commits
mailing list