You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Gabriel Sjoberg <xa...@cox.net> on 2003/05/31 18:29:38 UTC
Docbook plugin major update
Here's a partial diff of the work I've been doing with the docbook
plugin. It doesn't include many of the files I've added. I've merged
the two docbook plugins (the one currently in the repo and the sdocbook
plugin) and added the ability to use full DocBook and chunked DocBook.
The plugin can now generate xdocs, PDF, FO, and HTML. Also, with the
docbook:javadoc command, you can create an entity list to help link your
docs to javadocs (similar to the Tapestry docbook). I plan to add rtf
and a few others formats in the near future. This is my first patch, so
let me know what you think!
BTW, I've very tentatively versioned this 2.0 (it IS a large-scale change).
--Gabriel Sjoberg
Index: plugin.jelly
===================================================================
RCS file: /home/cvspublic/maven/src/plugins-build/docbook/plugin.jelly,v
retrieving revision 1.5
diff -u -r1.5 plugin.jelly
--- plugin.jelly 27 May 2003 23:25:55 -0000 1.5
+++ plugin.jelly 31 May 2003 16:14:46 -0000
@@ -1,12 +1,287 @@
<?xml version="1.0"?>
-
<project xmlns:j="jelly:core"
- xmlns:ant="jelly:ant">
+ xmlns:ant="jelly:ant"
+ xmlns:util="jelly:util">
+
+
+ <goal name="docbook"
+ description="Create HTML and PDF generated from Docbook"
+
prereqs="docbook:generate-html,docbook:generate-fo,docbook:generate-pdf,docbook:move">
+ </goal>
+
+ <goal
+ name="docbook:prepare-filesystem"
+ description="Prepares the proper directory structure">
+ <mkdir dir="${maven.docbook.target.doc}"/>
+ <mkdir dir="${maven.docbook.target.html}"/>
+ <mkdir dir="${maven.docbook.target.fo}"/>
+ <mkdir dir="${maven.docbook.target.pdf}"/>
+ </goal>
+
+ <goal
+ name="docbook:init-simple"
+ description="Init for processing sdocbooks">
+ <!-- get all *.xml and *.sgml -->
+ <fileScanner var="scanner">
+ <fileset dir="${maven.docbook.src.dir}" includes="**/*.xml,
**/*.sgml"/>
+ </fileScanner>
+ </goal>
+
+ <goal name="docbook:init-full"
+ description="Init for processing full docbooks">
+ <fileScanner var="scanner">
+ <fileset dir="${maven.docbook.src.dir}" includes="**/*.xml"/>
+ </fileScanner>
+ </goal>
+
+ <goal name="docbook:init-chunk"
+ description="Init for processing chunked docbooks">
+ <j:if test="${context.getVariable('maven.docbook.chunk.base') ==
null}">
+ <echo message="You need to set maven.docbook.chunk.base in your
project.properties file."/>
+ </j:if>
+ <j:if test="${context.getVariable('maven.docbook.chunk.base') !=
null}">
+ <fileScanner var="scanner">
+ <fileset dir="${maven.docbook.src.dir}"
includes="**/${maven.docbook.chunk.base}"/>
+ </fileScanner>
+ </j:if>
+ </goal>
+
+ <!--
================================================================== -->
+ <!-- G E N E R A T E H T M
L -->
+ <!--
================================================================== -->
+
+ <goal
+ name="docbook:generate-html"
+ description="DEPRECATED: Generate HTML for all sdocbooks in
${maven.docbook.src.dir}">
+ <attainGoal name="docbook:generate-html-simple"/>
+ </goal>
+
+ <goal
+ name="docbook:generate-html-simple"
+ prereqs="docbook:init-simple"
+ description="Generate HTML for all sdocbooks in
${maven.docbook.src.dir}">
+ <j:set var="stylesheet"
value="${plugin.dir}/plugin-resources/sdocbook/html/docbook.xsl"/>
+ <attainGoal name="docbook:prepare-filesystem"/>
+ <attainGoal name="docbook:do-generate-html"/>
+ <attainGoal name="docbook:move"/>
+ </goal>
+
+ <goal
+ name="docbook:generate-html-chunk"
+ prereqs="docbook:init-chunk"
+ description="Generate chunked HTML for docbook at
${maven.docbook.chunk.base}">
+ <j:set var="stylesheet"
value="${plugin.dir}/plugin-resources/docbook/html/chunk.xsl"/>
+ <attainGoal name="docbook:prepare-filesystem"/>
+ <attainGoal name="docbook:do-generate-html"/>
+ <attainGoal name="docbook:move"/>
+ </goal>
+ <goal
+ name="docbook:generate-html-full"
+ prereqs="docbook:init-full"
+ description="Generate HTML for all full docbooks in
${maven.docbook.src.dir}">
+ <j:set var="stylesheet"
value="${plugin.dir}/plugin-resources/docbook/html/docbook.xsl"/>
+ <attainGoal name="docbook:prepare-filesystem"/>
+ <attainGoal name="docbook:do-generate-html"/>
+ <attainGoal name="docbook:move"/>
+ </goal>
+
+ <goal
+ name="docbook:do-generate-html"
+ description="This actually calls the processor. CAUTION: Do not
assert this goal directly.">
+
+ <!-- create target directory for generated HTML -->
+ <mkdir dir="${maven.docbook.target.html}"/>
+
+ <j:forEach var="file" items="${scanner.iterator()}">
+ <echo>Processing ${file.absolutePath}</echo>
+
+ <!-- strip the extension from the file name -->
+ <j:set var="index" value="${file.name.lastIndexOf('.')}"/>
+ <j:set var="basename" value="${file.name.substring(0,index)}"/>
+
+ <!-- Use XSLT processor to transform DOCBOOK into HTML -->
+ <java dir="${maven.docbook.target.html}"
classname="org.apache.xalan.xslt.Process" fork="yes">
+ <classpath>
+ <pathelement location="${plugin.dir}/jars/jimi.jar"/>
+ <pathelement location="${plugin.getDependencyPath('batik')}"/>
+ <pathelement location="${plugin.getDependencyPath('fop')}"/>
+ <pathelement location="${plugin.getDependencyPath('xalan')}"/>
+ <pathelement
location="${plugin.getDependencyPath('xercesImpl')}"/>
+ <pathelement location="${plugin.getDependencyPath('xml-apis')}"/>
+ </classpath>
+ <arg value="-in"/>
+ <arg value="${file.absolutePath}"/>
+ <arg value="-out"/>
+ <arg value="${maven.docbook.target.html}/${basename}.html"/>
+ <arg value="-xsl"/>
+ <arg value="${stylesheet}"/>
+ </java>
+
+ </j:forEach>
+ </goal>
+
+ <!--
================================================================== -->
+ <!-- G E N E R A T E F
O -->
+ <!--
================================================================== -->
+
+ <goal
+ name="docbook:generate-fo"
+ description="DEPRECATED: Generate FO for all sdocbooks in
${maven.docbook.src.dir}">
+ <attainGoal name="docbook:generate-fo-simple"/>
+ </goal>
+
+ <goal
+ name="docbook:generate-fo-simple"
+ prereqs="docbook:init-simple"
+ description="Generate FO for all sdocbooks in
${maven.docbook.src.dir}">
+ <j:set var="stylesheet"
value="${plugin.dir}/plugin-resources/sdocbook/fo/docbook.xsl"/>
+ <attainGoal name="docbook:prepare-filesystem"/>
+ <attainGoal name="docbook:do-generate-fo"/>
+ <attainGoal name="docbook:move"/>
+ </goal>
+
+ <goal
+ name="docbook:generate-fo-full"
+ prereqs="docbook:init-full"
+ description="Generate FO for all docbooks in ${maven.docbook.src.dir}">
+ <j:set var="stylesheet"
value="${plugin.dir}/plugin-resources/docbook/fo/docbook.xsl"/>
+ <attainGoal name="docbook:prepare-filesystem"/>
+ <attainGoal name="docbook:do-generate-fo"/>
+ <attainGoal name="docbook:move"/>
+ </goal>
+
+ <goal
+ name="docbook:generate-fo-from-chunked"
+ prereqs="docbook:init-chunk"
+ description="Generate fo from a chunked docbook at
${maven.docbook.chunk.base}">
+ <j:set var="stylesheet"
value="${plugin.dir}/plugin-resources/docbook/fo/docbook.xsl"/>
+ <attainGoal name="docbook:prepare-filesystem"/>
+ <attainGoal name="docbook:do-generate-fo"/>
+ <attainGoal name="docbook:move"/>
+ </goal>
+
+
+ <goal
+ name="docbook:do-generate-fo"
+ description="This actually calls the processor. CAUTION: Do not
assert this goal directly.">
+
+ <!-- create target directory for generated FO -->
+ <mkdir dir="${maven.docbook.target.fo}"/>
+ <delete>
+ <fileset dir="${maven.docbook.target.fo}" includes="**/*.fo"/>
+ </delete>
+
+ <j:forEach var="file" items="${scanner.iterator()}">
+
+ <echo>Processing ${file.absolutePath}</echo>
+
+ <!-- strip the extension from the file name -->
+ <j:set var="index" value="${file.name.lastIndexOf('.')}"/>
+ <j:set var="basename" value="${file.name.substring(0,index)}"/>
+
+ <java dir="${maven.docbook.target.html}"
classname="org.apache.xalan.xslt.Process" fork="yes">
+ <classpath>
+ <pathelement location="${plugin.getDependencyPath('xalan')}"/>
+ <pathelement
location="${plugin.getDependencyPath('xercesImpl')}"/>
+ <pathelement location="${plugin.getDependencyPath('xml-apis')}"/>
+ </classpath>
+ <arg value="-in"/>
+ <arg value="${file.absolutePath}"/>
+ <arg value="-out"/>
+ <arg value="${maven.docbook.target.fo}/${basename}.fo"/>
+ <arg value="-xsl"/>
+ <arg value="${stylesheet}"/>
+ </java>
+
+ </j:forEach>
+
+ </goal>
<!--
================================================================== -->
- <!-- S I M P L E D O C B O O K D O C U M E N T A T I O
N -->
+ <!-- G E N E R A T E P D
F -->
<!--
================================================================== -->
+
<goal
+ name="docbook:generate-pdf"
+ description="Generate PDF for all .fo in ${maven.docbook.target.fo}">
+ <attainGoal name="docbook:prepare-filesystem"/>
+ <attainGoal name="docbook:do-generate-pdf"/>
+ </goal>
+
+ <goal
+ name="docbook:do-generate-pdf"
+ description="Generate PDF for all *.fo">
+
+ <!-- create target directory for generated PDF -->
+ <mkdir dir="${maven.docbook.target.pdf}"/>
+
+ <!-- get all *.xml and *.sgml -->
+ <fileScanner var="scanner">
+ <fileset dir="${maven.docbook.target.fo}" includes="**/*.fo"/>
+ </fileScanner>
+
+ <j:forEach var="file" items="${scanner.iterator()}">
+
+ <echo>Processing ${file.absolutePath}</echo>
+
+ <!-- strip the extension from the file name -->
+ <j:set var="index" value="${file.name.lastIndexOf('.')}"/>
+ <j:set var="basename" value="${file.name.substring(0,index)}"/>
+
+ <!-- Run FOP to transform FO into PDF -->
+ <java classname="org.apache.fop.apps.Fop" fork="yes">
+ <classpath>
+ <pathelement location="${plugin.dir}/jars/jimi.jar"/>
+ <pathelement
location="${plugin.getDependencyPath('avalon-framework')}"/>
+ <pathelement location="${plugin.getDependencyPath('batik')}"/>
+ <pathelement location="${plugin.getDependencyPath('fop')}"/>
+ <pathelement location="${plugin.getDependencyPath('logkit')}"/>
+ <pathelement location="${plugin.getDependencyPath('xalan')}"/>
+ <pathelement
location="${plugin.getDependencyPath('xerces:xercesImpl')}"/>
+ <pathelement location="${plugin.getDependencyPath('xml-apis')}"/>
+ </classpath>
+ <arg line="-fo ${file.absolutePath} -pdf
${maven.docbook.target.pdf}/${basename}.pdf"/>
+ </java>
+
+ </j:forEach>
+ <attainGoal name="docbook:move"/>
+
+ </goal>
+
+ <!--
================================================================== -->
+ <!-- M O V
E -->
+ <!--
================================================================== -->
+
+ <goal
+ name="docbook:move"
+ description="Move the generated HTML and PDF into doc">
+
+ <!-- create target directory for generated files -->
+ <mkdir dir="${maven.docbook.target.doc}"/>
+ <mkdir dir="${maven.docbook.target.doc}/html"/>
+ <mkdir dir="${maven.docbook.target.doc}/pdf"/>
+
+ <move todir="${maven.docbook.target.doc}/html" filtering="no">
+ <fileset dir="${maven.docbook.target.html}">
+ <include name="**/*.html"/>
+ </fileset>
+ </move>
+ <move todir="${maven.docbook.target.doc}/html" filtering="no">
+ <fileset dir="${maven.docbook.src.dir}">
+ <include name="**/*.html"/>
+ </fileset>
+ </move>
+ <move todir="${maven.docbook.target.doc}/pdf" filtering="no">
+ <fileset dir="${maven.docbook.target.pdf}">
+ <include name="**/*.pdf"/>
+ </fileset>
+ </move>
+ </goal>
+
+ <!--
================================================================== -->
+ <!-- D O C B O O K T O X D O
C -->
+ <!--
================================================================== -->
+ <goal
name="docbook:transform"
prereqs="xdoc:init"
description="Transform any docbook-simple source into xdocs for
later use">
@@ -38,6 +313,47 @@
</ant:xmlcatalog>
</ant:style>
</j:if>
+ </goal>
+
+ <!--
================================================================== -->
+ <!-- J A V A D O C E N T I T Y L I S
T -->
+ <!--
================================================================== -->
+ <goal
+ name="docbook:javadoc"
+ prereqs="javadoc:generate,docbook:prepare-filesystem"
+ description="Create an entity list that will insert direct links to
a javadoc API.">
+
+ <fileScanner var="scanner">
+ <fileset dir="${maven.docbook.javadoc.dir}" includes="**/*.html"/>
+ </fileScanner>
+
+ <echo file="${maven.docbook.target.doc}/JavadocLinks.xml"
message="<!-- 

+ Provides a common place to define entities that are links to API and
other external 

+ documentation. You will probably need to fix the ApiRoot entity
below to match your 

+ actual javadoc API root directory. 
-->"/>
+
+ <!-- Insert an entity pointing to the root of the javadocs -->
+ <j:set var="javadocRoot"
value="${context.getVariable('maven.docbook.javadoc.dir')}"/>
+ <!-- Make sure any '\' get changed to '/' -->
+ <util:replace oldChar="\" newChar="/" var="javadocRoot"
value="${javadocRoot}"/>
+ <echo file="${maven.docbook.target.doc}/JavadocLinks.xml" append="true"
+ message="

<!ENTITY ApiRoot
"${javadocRoot}">

"/>
+
+ <j:forEach var="file" items="${scanner.iterator()}">
+ <!-- strip the extension from the file name -->
+ <j:set var="index" value="${file.name.lastIndexOf('.')}"/>
+ <j:set var="basename" value="${file.name.substring(0,index)}"/>
+
+ <!-- strip off maven.docbook.javadoc.dir so we can make the links
go to the proper directory -->
+ <j:set var="javadocDirLength"
value="${context.getVariable('maven.docbook.javadoc.dir').length()}"/>
+ <j:set var="path" value="${file.getPath()}"/>
+ <j:set var="relpath" value="${path.substring(javadocDirLength)}"/>
+ <!-- pull the old switcheroo on the slashes -->
+ <util:replace oldChar="\" newChar="/" var="relpath"
value="${relpath}"/>
+
+ <echo file="${maven.docbook.target.doc}/JavadocLinks.xml"
append="true" message="
<!ENTITY ${basename} '<ulink
url="&ApiRoot;${relpath}"><classname>${basename}</classname></ulink>'>"/>
+
+ </j:forEach>
</goal>
</project>
Index: plugin.properties
===================================================================
RCS file:
/home/cvspublic/maven/src/plugins-build/docbook/plugin.properties,v
retrieving revision 1.2
diff -u -r1.2 plugin.properties
--- plugin.properties 28 Jan 2003 04:12:16 -0000 1.2
+++ plugin.properties 31 May 2003 16:14:46 -0000
@@ -1,7 +1,13 @@
# -------------------------------------------------------------------
-# P L U G I N P R O P E R I E S
-# -------------------------------------------------------------------
-# DocBook plugin.
+# Default properties for the DocBook plugin
# -------------------------------------------------------------------
-maven.docbook.src=${maven.src.dir}/docbook
+maven.docbook.src.dir = ${basedir}/docbook
+
+maven.docbook.target.html = ${maven.build.dir}/docbook-temp/html
+maven.docbook.target.fo = ${maven.build.dir}/docbook-temp/fo
+maven.docbook.target.pdf = ${maven.build.dir}/docbook-temp/pdf
+
+maven.docbook.target.doc = ${maven.build.dir}/docbook
+
+maven.docbook.javadoc.dir = ${maven.build.dir}/docs/apidocs
\ No newline at end of file
Index: project.properties
===================================================================
RCS file:
/home/cvspublic/maven/src/plugins-build/docbook/project.properties,v
retrieving revision 1.2
diff -u -r1.2 project.properties
--- project.properties 10 Feb 2003 08:25:00 -0000 1.2
+++ project.properties 31 May 2003 16:14:46 -0000
@@ -1,7 +1,2 @@
-# -------------------------------------------------------------------
-# P R O J E C T P R O P E R T I E S
-# -------------------------------------------------------------------
-maven.xdoc.date=left
-maven.xdoc.version=${pom.currentVersion}
-maven.license.licenseFile=${basedir}/../../../LICENSE.txt
-
+maven.repo.remote = http://www.ibiblio.org/maven
+maven.license.licenseFile=LICENSE.txt
\ No newline at end of file
Index: project.xml
===================================================================
RCS file: /home/cvspublic/maven/src/plugins-build/docbook/project.xml,v
retrieving revision 1.9
diff -u -r1.9 project.xml
--- project.xml 27 May 2003 23:26:27 -0000 1.9
+++ project.xml 31 May 2003 16:14:46 -0000
@@ -1,18 +1,23 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="ISO-8859-1"?>
<project>
- <extend>${basedir}/../project.xml</extend>
+<!-- <extend>${basedir}/../project.xml</extend>-->
<pomVersion>3</pomVersion>
<id>maven-docbook-plugin</id>
- <name>Maven DocBook Plug-in</name>
- <currentVersion>1.1-SNAPSHOT</currentVersion>
- <shortDescription>Java Project Management Tools</shortDescription>
+ <name>Maven DOCBOOK Plug-in</name>
+ <currentVersion>2.0</currentVersion>
+ <shortDescription>Maven Plugin for Docbook</shortDescription>
<url>http://maven.apache.org/reference/plugins/docbook/</url>
+ <siteAddress>maven.apache.org</siteAddress>
<siteDirectory>/www/maven.apache.org/reference/plugins/docbook/</siteDirectory>
+
+ <package>org.apache.maven</package>
+
<repository>
<connection>scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:maven/src/plugins-build/docbook/</connection>
<url>http://cvs.apache.org/viewcvs/maven/src/plugins-build/docbook/</url>
</repository>
+
<developers>
<developer>
<name>dIon Gillard</name>
@@ -24,6 +29,24 @@
</roles>
</developer>
<developer>
+ <name>Siegfried Goeschl</name>
+ <id>wdsgoe</id>
+ <email>siegfried.goeschl@it20one.at</email>
+ <organization>IT20one</organization>
+ <roles>
+ <role>SQA Consultant</role>
+ </roles>
+ </developer>
+ <developer>
+ <name>Gabriel Sjoberg</name>
+ <id>TheLibrar</id>
+ <email>xabbu@hotmail.com</email>
+ <organization></organization>
+ <roles>
+ <role>Feature Meister</role>
+ </roles>
+ </developer>
+ <developer>
<name>Jason van Zyl</name>
<id>jvanzyl</id>
<email>jason@zenplex.com</email>
@@ -34,6 +57,7 @@
</roles>
</developer>
</developers>
+
<dependencies>
<dependency>
<id>ant</id>
@@ -48,14 +72,82 @@
<properties>
<classloader>root.maven</classloader>
</properties>
- </dependency>
+ </dependency>
+ <dependency>
+ <id>avalon-framework</id>
+ <version>4.0</version>
+ <url>http://jakarta.apache.org/avalon/index.html</url>
+ <properties>
+ <classloader>maven.root</classloader>
+ </properties>
+ </dependency>
+ <dependency>
+ <id>batik</id>
+ <version>1.1.1</version>
+ <url>http://xml.apache.org/batik/index.html</url>
+ <properties>
+ <classloader>maven.root</classloader>
+ </properties>
+ </dependency>
+ <dependency>
+ <id>fop</id>
+ <version>0.20.5-rc3-alpha</version>
+ <url>http://xml.apache.org/fop/index.html</url>
+ <properties>
+ <classloader>maven.root</classloader>
+ </properties>
+ </dependency>
+ <dependency>
+ <id>logkit</id>
+ <version>1.0.1</version>
+ <url>http://jakarta.apache.org/avalon/logkit/index.html</url>
+ <properties>
+ <classloader>maven.root</classloader>
+ </properties>
+ </dependency>
<dependency>
<id>xalan</id>
- <version>2.3.1</version>
- <url>http://xml.apache.org/xalan-j/</url>
+ <version>2.5.0</version>
+ <url>http://xml.apache.org/xalan-j/</url>
<properties>
- <classloader>root</classloader>
- </properties>
- </dependency>
+ <classloader>maven.root</classloader>
+ </properties>
+ </dependency>
+ <dependency>
+ <id>xerces:xercesImpl</id>
+ <version>2.4.0</version>
+ <url>http://xml.apache.org/xerces2-j/index.html</url>
+ <properties>
+ <classloader>maven.root</classloader>
+ </properties>
+ </dependency>
+ <dependency>
+ <id>xml-apis</id>
+ <version>1.0.b2</version>
+ <url>http://xml.apache.org/xerces2-j/index.html</url>
+ <properties>
+ <classloader>maven.root</classloader>
+ </properties>
+ </dependency>
</dependencies>
+
+
+ <build>
+ <resources>
+ <resource>
+ <directory>${basedir}/src/plugin-resources</directory>
+ <targetPath>plugin-resources</targetPath>
+ </resource>
+ <resource>
+ <directory>${basedir}</directory>
+ <includes>
+ <include>plugin.jelly</include>
+ <include>plugin.properties</include>
+ <include>project.properties</include>
+ <include>project.xml</include>
+ </includes>
+ </resource>
+ </resources>
+ </build>
</project>
+
cvs server: Diffing src
cvs server: Diffing src/plugin-resources
cvs server: Diffing src/test
cvs server: Diffing src/test/xslt
cvs server: Diffing xdocs
Index: xdocs/changes.xml
===================================================================
RCS file:
/home/cvspublic/maven/src/plugins-build/docbook/xdocs/changes.xml,v
retrieving revision 1.2
diff -u -r1.2 changes.xml
--- xdocs/changes.xml 27 May 2003 23:27:29 -0000 1.2
+++ xdocs/changes.xml 31 May 2003 16:14:46 -0000
@@ -17,5 +17,4 @@
</action>
</release>
</body>
-</document>
-
+</document>
\ No newline at end of file
Index: xdocs/goals.xml
===================================================================
RCS file: /home/cvspublic/maven/src/plugins-build/docbook/xdocs/goals.xml,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 goals.xml
--- xdocs/goals.xml 24 Jan 2003 03:45:09 -0000 1.1.1.1
+++ xdocs/goals.xml 31 May 2003 16:14:47 -0000
@@ -14,6 +14,127 @@
Transform any docbook-simple source into xdocs for later use
</description>
</goal>
+
+
+ <goal>
+ <name>docbook:prepare-filesystem</name>
+ <description>
+ Prepares the proper directory structure
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:init-simple</name>
+ <description>
+ Init for processing sdocbooks
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:init-full</name>
+ <description>
+ Init for processing full docbooks
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:init-chunk</name>
+ <description>
+ Init for processing chunked docbooks
+ </description>
+ </goal>
+
+
+ <goal>
+ <name>docbook:generate-html</name>
+ <description>
+ DEPRECATED: Generate HTML for all sdocbooks in
${maven.docbook.src.dir}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:generate-html-simple</name>
+ <description>
+ Generate HTML for all sdocbooks in ${maven.docbook.src.dir}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:generate-html-chunk</name>
+ <description>
+ Generate chunked HTML for docbook at ${maven.docbook.chunk.base}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:generate-html-full</name>
+ <description>
+ Generate HTML for all full docbooks in ${maven.docbook.src.dir}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:do-generate-html</name>
+ <description>
+ This actually calls the processor. CAUTION: Do not assert
this goal directly.
+ </description>
+ </goal>
+
+
+ <goal>
+ <name>docbook:generate-fo</name>
+ <description>
+ DEPRECATED: Generate FO for all sdocbooks in
${maven.docbook.src.dir}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:generate-fo-simple</name>
+ <description>
+ Generate FO for all sdocbooks in ${maven.docbook.src.dir}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:generate-fo-chunk</name>
+ <description>
+ Generate chunked FO for docbook at ${maven.docbook.chunk.base}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:generate-fo-full</name>
+ <description>
+ Generate FO for all full docbooks in ${maven.docbook.src.dir}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:do-generate-fo</name>
+ <description>
+ This actually calls the processor. CAUTION: Do not assert
this goal directly.
+ </description>
+ </goal>
+
+
+ <goal>
+ <name>docbook:generate-PDF</name>
+ <description>
+ Generate PDF for all .fo in ${maven.docbook.target.fo}
+ </description>
+ </goal>
+ <goal>
+ <name>docbook:do-generate-PDF</name>
+ <description>
+ Generate PDF for all *.fo. CAUTION: Do not assert this goal
directly.
+ </description>
+ </goal>
+
+
+ <goal>
+ <name>docbook:move</name>
+ <description>
+ Move the generated HTML and PDF into doc
+ </description>
+ </goal>
+
+
+ <goal>
+ <name>docbook:javadoc</name>
+ <description>
+ Create an entity list that will insert direct links to a
javadoc API.
+ </description>
+ </goal>
+
</goals>
- </body>
-</document>
+ </body>
+</document>
\ No newline at end of file
Index: xdocs/index.xml
===================================================================
RCS file: /home/cvspublic/maven/src/plugins-build/docbook/xdocs/index.xml,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 index.xml
--- xdocs/index.xml 24 Jan 2003 03:45:09 -0000 1.1.1.1
+++ xdocs/index.xml 31 May 2003 16:14:47 -0000
@@ -2,19 +2,23 @@
<document>
<properties>
- <title>Maven Docbook Plug-in</title>
- <author email="jason@zenplex.com">Jason van Zyl</author>
+ <title>Maven Simplified DOCBOOK Plug-in</title>
+ <author email="siegfried.goeschl@it20one.at">Siegfried Goeschl</author>
</properties>
<body>
<section name="Maven Docbook Plug-in">
<p>
- This plugin allows you to write your project documentation in the
- Docbook format.
- </p>
+ This plugin uses Apache Xalan to create HTML and Apache FOP to
create PDF
+ from Docbook directly, i.e. without creating an
+ intermediate XDOC file as it was done with the previous
+ DocBook plugin. NOTE: This plugin retains the ability to do this.
+ </p>
<p>
- <strong>Warning: </strong> This plugin has had limited testing
- </p>
+ Some of the style sheets used in this plugin are taken from the
+ <a href="http://sourceforge.net/projects/docbook/">
+ DocBook Open Repository</a> project on SourceForge
+ </p>
</section>
- </body>
+ </body>
</document>
Index: xdocs/navigation.xml
===================================================================
RCS file:
/home/cvspublic/maven/src/plugins-build/docbook/xdocs/navigation.xml,v
retrieving revision 1.2
diff -u -r1.2 navigation.xml
--- xdocs/navigation.xml 19 Mar 2003 05:54:20 -0000 1.2
+++ xdocs/navigation.xml 31 May 2003 16:14:47 -0000
@@ -1,17 +1,20 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="Maven DocBook Plugin">
+<project>
- <title>Maven DocBook Plugin</title>
+ <title>Java Simplified DocBook Plugin</title>
<body>
- <links>
- <item name="Maven" href="http://maven.apache.org/"/>
- <item name="Simple DocBook"
- href="http://www.oasis-open.org/docbook/xml/simple/"/>
- </links>
<menu name="Overview">
+ <item name="Front Page" href="/index.html"/>
<item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" />
</menu>
+ <links>
+ <item name="Maven" href="http://maven.apache.org/"/>
+ <item name="Simple DocBook"
+ href="http://www.oasis-open.org/docbook/xml/simple/"/>
+ <item name="Full DocBook"
+ href="http://www.oasis-open.org/docbook/xml/4.2/index.shtml"/>
+ </links>
</body>
</project>
Index: xdocs/properties.xml
===================================================================
RCS file:
/home/cvspublic/maven/src/plugins-build/docbook/xdocs/properties.xml,v
retrieving revision 1.2
diff -u -r1.2 properties.xml
--- xdocs/properties.xml 27 May 2003 23:25:55 -0000 1.2
+++ xdocs/properties.xml 31 May 2003 16:14:47 -0000
@@ -2,24 +2,52 @@
<document>
<properties>
- <title>Maven DocBook Plugin Properties</title>
- <author email="dion@apache.org">dIon Gillard</author>
+ <title>Properties</title>
+ <author email="siegfried.goeschl@it20one.at">Siegfried Goeschl</author>
</properties>
<body>
- <section name="Maven DocBook Plugin Settings">
+ <section name="Property Settings">
<table>
+ <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
- <th>Property name</th>
- <th>Optional?</th>
- <th>Description</th>
+ <td>maven.sdocbook.src.dir</td>
+ <td>No</td>
+ <td>
+ The location were the XML documents are found. It defaults
+ to "${basedir}/sdocbook"
+ </td>
</tr>
<tr>
- <td>maven.src.docbook-simple</td>
- <td>Yes</td>
+ <td>maven.sdocbook.target.html</td>
+ <td>No</td>
+ <td>
+ Target directory for the created HTML documents. It defaults
+ to ${maven.build.dir}/docbook-html
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sdocbook.target.fo</td>
+ <td>No</td>
+ <td>
+ Target directory for the created FO documents. It defaults
+ to ${maven.build.dir}/docbook-fo
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sdocbook.target.pdf</td>
+ <td>No</td>
+ <td>
+ Target directory for the created PDF documents. It defaults
+ to ${maven.build.dir}/docbook-pdf
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sdocbook.target.doc</td>
+ <td>No</td>
<td>
- Defaults to <code>${maven.src.dir}/sdocbook</code>. This is the
- source directory for the simple docbook xml files
+ Target directory for the created documents. It defaults
+ to ${maven.docs.dest}/docbook
</td>
</tr>
<tr>
@@ -36,4 +64,4 @@
</table>
</section>
</body>
-</document>
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org