[dna-commits] DNA SVN: r1026 - in trunk/docs: gettingstarted/src/main/docbook/en-US and 4 other directories.

Author: rhauch Date: 2009-06-10 00:16:55 -0400 (Wed, 10 Jun 2009) New Revision: 1026 Modified: trunk/docs/gettingstarted/pom.xml trunk/docs/gettingstarted/src/main/docbook/en-US/content/repository_example.xml trunk/docs/gettingstarted/src/main/docbook/en-US/content/sequencer_example.xml trunk/docs/gettingstarted/src/main/docbook/en-US/master.xml trunk/docs/reference/pom.xml trunk/docs/reference/src/main/docbook/en-US/content/author_group.xml trunk/docs/reference/src/main/docbook/en-US/master.xml Log: Minor tweaks to upgrade to the latest version of the JBoss.org docbook style, and to generate the single HTML forms of the docs. Modified: trunk/docs/gettingstarted/pom.xml =================================================================== --- trunk/docs/gettingstarted/pom.xml 2009-06-10 00:18:54 UTC (rev 1025) +++ trunk/docs/gettingstarted/pom.xml 2009-06-10 04:16:55 UTC (rev 1026) @@ -17,28 +17,30 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> - <version>1.1.0.Beta1</version> + <version>1.1.0</version> </dependency> <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.0.Beta1</version> + <version>1.1.0</version> <type>jdocbook-style</type> </dependency> </dependencies> <configuration> <sourceDocumentName>master.xml</sourceDocumentName> - <imageResource> - <directory>${basedir}/src/main/docbook/en-US/images</directory> - <includes> - <include>*.png</include> - </includes> - </imageResource> - <!-- cssResource> - <directory>${basedir}/src/main/docbook/css</directory> - </cssResource--> + <imageResource> + <directory>${basedir}/src/main/docbook/en-US/images</directory> + <includes> + <include>*.png</include> + </includes> + </imageResource> <targetDirectory>${basedir}/target/docbook/en-US</targetDirectory> <formats> <format> @@ -46,18 +48,16 @@ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> <finalName>index.html</finalName> </format> - <!-- <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> + <finalName>${pom.artifactId}.html</finalName> </format> <format> <formatName>pdf</formatName> <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>userguide_en.pdf</finalName> + <finalName>${pom.artifactId}.pdf</finalName> </format> - --> </formats> <options> <xincludeSupported>true</xincludeSupported> Modified: trunk/docs/gettingstarted/src/main/docbook/en-US/content/repository_example.xml =================================================================== --- trunk/docs/gettingstarted/src/main/docbook/en-US/content/repository_example.xml 2009-06-10 00:18:54 UTC (rev 1025) +++ trunk/docs/gettingstarted/src/main/docbook/en-US/content/repository_example.xml 2009-06-10 04:16:55 UTC (rev 1026) @@ -45,13 +45,13 @@ <para>This collection of repositories is shown in the following figure: <figure id="example-repositories"> <title>Repositories used in the example client</title> - <graphic align="center" scale="100" fileref="example-repositories.png"/> + <graphic align="center" scale="60" fileref="example-repositories.png"/> </figure> Most of the repositories are in-memory repositories (using the In-Memory repository connector), but the federated "Vehicles" repository content is federated from the other repositories and cached into the "Cache" repository. This is shown in the following figure: <figure id="example-federated-repository"> <title>Vehicles repository content is federated from the Cars, Airplanes and Configuration repositories</title> - <graphic align="center" scale="100" fileref="example-federated-repository.png"/> + <graphic align="center" scale="60" fileref="example-federated-repository.png"/> </figure> </para> <para> @@ -59,7 +59,7 @@ directory and type <code>./run.sh</code>. You should see the command-line client and its menus in your terminal: <figure id="example-repositories-client"> <title>Example Client</title> - <graphic align="center" scale="100" fileref="example-repositories-client.png"/> + <graphic align="center" scale="60" fileref="example-repositories-client.png"/> </figure> From this menu, you can see the list of repositories, select one, and navigate through that repository in a manner similar to a *nix command-line shell (although the client itself uses the JCR API to interact with the repositories). @@ -88,7 +88,7 @@ <para>If you were to select the "Cars" repository and use some of the commands, you should see something similar to: <figure id="example-repositories-navigating"> <title>Navigating the Cars repository</title> - <graphic align="center" scale="100" fileref="example-repositories-navigating.png"/> + <graphic align="center" scale="60" fileref="example-repositories-navigating.png"/> </figure> </para> <para>You can also choose to navigate the "Vehicles" repository, which projects the "Cars" repository content under the Modified: trunk/docs/gettingstarted/src/main/docbook/en-US/content/sequencer_example.xml =================================================================== --- trunk/docs/gettingstarted/src/main/docbook/en-US/content/sequencer_example.xml 2009-06-10 00:18:54 UTC (rev 1025) +++ trunk/docs/gettingstarted/src/main/docbook/en-US/content/sequencer_example.xml 2009-06-10 04:16:55 UTC (rev 1026) @@ -48,7 +48,7 @@ directory and type <code>./run.sh</code>. You should see the command-line client and its menus in your terminal: <figure id="xample-sequencer-cli-client"> <title>Example client</title> - <graphic align="center" scale="100" fileref="example-sequencer-client.png"/> + <graphic align="center" scale="60" fileref="example-sequencer-client.png"/> </figure> From this menu, you can upload a file into the repository, search for media in the repository, print sequencing statistics, or quit the application.</para> @@ -59,7 +59,7 @@ in that directory without specifying the path: <figure id="example-sequencer-upload"> <title>Uploading an image using the example client</title> - <graphic align="center" scale="100" fileref="example-sequencer-upload.png"/> + <graphic align="center" scale="60" fileref="example-sequencer-upload.png"/> </figure> You can specify any fully-qualified or relative path. The application will notify you if it cannot find the file you specified. The example client configures JBoss DNA to sequence MP3 audio files, Java source files, or image files with one of @@ -98,17 +98,17 @@ <para>So, after the file is uploaded, you can search the repository for the image metadata using the "s" menu option: <figure id="example-sequencer-search"> <title>Searching for media using the example client</title> - <graphic align="center" scale="100" fileref="example-sequencer-search.png"/> + <graphic align="center" scale="60" fileref="example-sequencer-search.png"/> </figure> Here are the search results after the <code>sample1.mp3</code> audio file has been uploaded (to the <code>/a/b/sample1.mp3</code> location): <figure id="example-sequencer-search-with-mp3"> <title>Searching for media using the example client</title> - <graphic align="center" scale="100" fileref="example-sequencer-search-with-mp3.png"/> + <graphic align="center" scale="60" fileref="example-sequencer-search-with-mp3.png"/> </figure> You can also display the sequencing statistics using the "d" menu option: <figure id="example-sequencer-statistics"> <title>Sequencing statistics using the example client</title> - <graphic align="center" scale="100" fileref="example-sequencer-statistics.png"/> + <graphic align="center" scale="60" fileref="example-sequencer-statistics.png"/> </figure> These stats show how many nodes were sequenced, and how many nodes were skipped because they didn't apply to the sequencer's criteria. @@ -341,7 +341,7 @@ <para>At this point, we've reviewed all of the interesting code in the example application related to JBoss DNA. However, feel free to play with the application, trying different things.</para> </sect1> - <sect1 id="using_dna_whats_next"> + <sect1> <title>What's next</title> <para> This chapter walked through running the sequencer example and looked at the example code. With the sequencer client, you could upload files into a Modified: trunk/docs/gettingstarted/src/main/docbook/en-US/master.xml =================================================================== --- trunk/docs/gettingstarted/src/main/docbook/en-US/master.xml 2009-06-10 00:18:54 UTC (rev 1025) +++ trunk/docs/gettingstarted/src/main/docbook/en-US/master.xml 2009-06-10 04:16:55 UTC (rev 1026) @@ -34,7 +34,6 @@ <subtitle>Getting Started Guide</subtitle> <releaseinfo>&versionNumber;</releaseinfo> <productnumber>&versionNumber;</productnumber> - <issuenum>5</issuenum> <mediaobject> <imageobject role="fo"> <imagedata fileref="dna-logo.png" align="center"/> @@ -48,7 +47,6 @@ <holder>&copyrightHolder;</holder> </copyright> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/author_group.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/legal_notice.xml"/> </bookinfo> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/preface.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/introduction.xml"/> Modified: trunk/docs/reference/pom.xml =================================================================== --- trunk/docs/reference/pom.xml 2009-06-10 00:18:54 UTC (rev 1025) +++ trunk/docs/reference/pom.xml 2009-06-10 04:16:55 UTC (rev 1026) @@ -17,28 +17,30 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> - <version>1.1.0.Beta1</version> + <version>1.1.0</version> </dependency> <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.0.Beta1</version> + <version>1.1.0</version> <type>jdocbook-style</type> </dependency> </dependencies> <configuration> <sourceDocumentName>master.xml</sourceDocumentName> - <imageResource> - <directory>${basedir}/src/main/docbook/en-US/images</directory> - <includes> - <include>*.png</include> - </includes> - </imageResource> - <!-- cssResource> - <directory>${basedir}/src/main/docbook/css</directory> - </cssResource--> + <imageResource> + <directory>${basedir}/src/main/docbook/en-US/images/</directory> + <includes> + <include>*.png</include> + </includes> + </imageResource> <targetDirectory>${basedir}/target/docbook/en-US</targetDirectory> <formats> <format> @@ -46,17 +48,15 @@ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> <finalName>index.html</finalName> </format> - <!-- <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> + <finalName>${pom.artifactId}.html</finalName> </format> - --> <format> <formatName>pdf</formatName> <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>userguide_en.pdf</finalName> + <finalName>${pom.artifactId}.pdf</finalName> </format> </formats> <options> Modified: trunk/docs/reference/src/main/docbook/en-US/content/author_group.xml =================================================================== --- trunk/docs/reference/src/main/docbook/en-US/content/author_group.xml 2009-06-10 00:18:54 UTC (rev 1025) +++ trunk/docs/reference/src/main/docbook/en-US/content/author_group.xml 2009-06-10 04:16:55 UTC (rev 1026) @@ -30,4 +30,5 @@ ]> <authorgroup> <corpauthor>Randall M. Hauch</corpauthor> + <corpauthor>Brian Carothers</corpauthor> </authorgroup> \ No newline at end of file Modified: trunk/docs/reference/src/main/docbook/en-US/master.xml =================================================================== --- trunk/docs/reference/src/main/docbook/en-US/master.xml 2009-06-10 00:18:54 UTC (rev 1025) +++ trunk/docs/reference/src/main/docbook/en-US/master.xml 2009-06-10 04:16:55 UTC (rev 1026) @@ -34,7 +34,6 @@ <subtitle>Reference Guide</subtitle> <releaseinfo>&versionNumber;</releaseinfo> <productnumber>&versionNumber;</productnumber> - <issuenum>4</issuenum> <mediaobject> <imageobject role="fo"> <imagedata fileref="dna-logo.png" align="center"/> @@ -48,7 +47,6 @@ <holder>&copyrightHolder;</holder> </copyright> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/author_group.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/legal_notice.xml"/> </bookinfo> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/preface.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="content/introduction.xml"/>