[jboss-svn-commits] JBL Code SVN: r13247 - labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt.

[jboss-svn-commits at lists.jboss.org]

Author: steve.ebersole at jboss.com
Date: 2007-07-08 18:24:09 -0400 (Sun, 08 Jul 2007)
New Revision: 13247

Modified:
   labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/formats.apt
   labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/staging.apt
   labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt
   labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt
Log:
prep for 2.0.0 release

Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/formats.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/formats.apt	2007-07-08 22:06:16 UTC (rev 13246)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/formats.apt	2007-07-08 22:24:09 UTC (rev 13247)
@@ -121,4 +121,24 @@
         </formats>
     </configuration>
 </plugin>
-+----+
\ No newline at end of file
++----+
+
+    Sometimes (especially with chunked html formatting) it is desired to have the main chunk
+    produce a file named 'index.html' instead of '<artifactId>.html':
+
++----+
+<plugin>
+    <groupId>org.jboss.maven.plugins</groupId>
+    <artifacId>maven-jdocbook-plugin</artifactId>
+    <extensions>true</extensions>
+    <configuration>
+        <sourceDocumentName>source.xml</sourceDocumentName>
+        <formats>
+            <format>
+                <formatName>html</formatName>
+                <finalName>index.html</finalN ame>
+            </format>
+        </formats>
+    </configuration>
+</plugin>
++----+

Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/staging.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/staging.apt	2007-07-08 22:06:16 UTC (rev 13246)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/staging.apt	2007-07-08 22:24:09 UTC (rev 13247)
@@ -32,7 +32,6 @@
     In general there is not much to configure here, although you can point at alternate
     source directories for css, fonts and images:
 
-
     Or to an alternate location to use for staging:
 
 +----+

Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt	2007-07-08 22:06:16 UTC (rev 13246)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt	2007-07-08 22:24:09 UTC (rev 13247)
@@ -33,23 +33,21 @@
         type=jdocbook-style).
 
     [project local] - These are style elements defined as part of the local
-        jdocbook project.  Typically, these would either indicated either:
+        jdocbook project.  Typically, these would indicated either:
 
         [[1]] overrides of some shared (ala, jdocbook-style) style element
 
-        [[2]] specific style elements of the local project (e.g. images
+        [[2]] style elements specific to the local project (e.g. images
             referred to from the project DocBook sources.
 
         []
 
-        project local elements are generally limited to images, css, and fonts.
+        project local elements are generally limited to images and css.
 
     []
 
 * jdocbook-style integration
 
-    <todo : this section needs improving...>
-
     <jdocbook-style> is another maven packaging type, defined by the
     org.jboss.maven.plugins:maven-jdocbook-style-plugin plugin.  The goal
     of the <jdocbook-style> is to define a common, resuable packaging bundle
@@ -73,22 +71,13 @@
         stages any css, font or image resources found inside a dependency of
         type <jdocbook-style>.  See {{{examples/resource-staging.html}example}}.
 
+    []
+
+    See the {{{examples/jdocbook-style.html}example}} illustrating complete jdocbook-style
+    usage.
+
 * Project local elements
 
     <todo : this section need writing... ;)>
 
     See {{staging.html}staging}}.
-
-+----+
-<plugin>
-    <groupId>org.jboss.maven.plugins</groupId>
-    <artifacId>maven-jdocbook-plugin</artifactId>
-    <extensions>true</extensions>
-    <configuration>
-        ...
-        <imagesDirectory>path/to/alternate/image/dir</imagesDirectory>
-        <cssDirectory>path/to/alternate/css/dir</cssDirectory>
-        <fontsDirectory>path/to/alternate/fonts/dir</fontsDirectory>
-    </configuration>
-</plugin>
-+----+
\ No newline at end of file

Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt	2007-07-08 22:06:16 UTC (rev 13246)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt	2007-07-08 22:24:09 UTC (rev 13247)
@@ -31,8 +31,8 @@
 
     []
 
-    If you want to use local style element staging, it is also a good idea to
-    understand {{staging.html}staging}} as well.
+    If you want to use local style elements, it is also a good idea to understand
+    {{staging.html}staging}} as well.
 
 * Minimal configuration