From: Per O. <per...@us...> - 2004-04-12 13:55:30
|
perolesen 04/04/12 06:41:44 Added: sdocbook/xdocs users-guide.xml Log: Added a users guide Revision Changes Path 1.1 maven-plugins/sdocbook/xdocs/users-guide.xml Index: users-guide.xml =================================================================== <?xml version="1.0"?> <document> <properties> <title>Users Guide - sdocbook</title> <author email="po...@no...">Per Olesen</author> </properties> <body> <section name="Introduction"> <p> We assume you have some sources of DocBook XML documents, that you wish to process and convert into pdf or html output. </p> </section> <section name="Basic usage"> <p> Put you DocBook sources into dir which "maven.sdocbook.src.dir" property points to. </p> <p> Simply typing "maven sdocbook" will generate both html and pdf. The html is produced directly from the sources. The pdf output is done in a two-step process, first converting sources to FO using the <a href="http://docbook.sourceforge.net/">DocBook stylesheets</a> and then converting the FO output to pdf using the <a href="http://xml.apache.org/fop/">Apache FOP</a> processor. </p> </section> <section name="Parameterizing stylesheets"> <p> The stylesheets which this plugin uses can be controlled with parameters. For examle, they implement various extensions, which you need to enable if you want them in output. </p> <p> Taking the stylesheets which convert into html as example, you could set the "draft" option by setting the property "maven.sdocbook.html.params==-param draft.mode yes" in your project.properties. </p> </section> <section name="Using another version of stylesheets"> <p> The plugin includes a specific version of the <a href="http://docbook.sourceforge.net/">DocBook stylesheets</a> but these are developed in a separate project, and might very well be available in newer versions than included in this plugin. </p> <p> Then it is lucky, that you can point to a newer version :-) You simply need to set the "maven.sdocbook.stylesheets.dir" property to point to the location of the version you want to use. </p> <p> One way of doing this is to manually get a distribution of the stylesheets you want and point to the location where you unzip them. Another way of doing this is to let your project depend on the version of the stylesheets as a maven dependency, and then pointing the maven.sdocbook.stylesheets.dir property into you maven.repo.local. This requires that the docbook stylesheets are in a repository you can access. The maven repository at Ibiblio has some <a href="http://www.ibiblio.org/maven/docbook/">here</a>. </p> </section> </body> </document> |
From: Carlos S. <car...@us...> - 2004-12-19 13:03:22
|
carlossg 04/12/19 05:03:14 Modified: sdocbook plugin.properties plugin.jelly project.xml sdocbook/xdocs users-guide.xml Removed: sdocbook/src/plugin-resources/common nn.xml et.xml ro.xml zh_tw.xml gentext.xsl l10n.dtd titles.xsl l10n.xml targets.xsl fi.xml subtitles.xsl uk.xml sr.xml pi.xsl ko.xml ca.xml id.xml ChangeLog nl.xml zh_cn.xml sv.xml fr.xml ru.xml sk.xml labels.xsl vi.xml af.xml pt.xml sl.xml cs.xml he.xml eu.xml no.xml common.xsl de.xml it.xml hu.xml ja.xml pt_br.xml tr.xml lt.xml hr.xml xh.xml pl.xml da.xml bg.xml l10n.xsl el.xml targetdatabase.dtd table.xsl th.xml es.xml ar.xml en.xml sdocbook/src/plugin-resources/xhtml inline.xsl html.xsl oldchunker.xsl graphics.xsl sections.xsl division.xsl onechunk.xsl chunk.xsl chunkfast.xsl toc.xsl ChangeLog profile-docbook.xsl profile-onechunk.xsl chunktoc.xsl autotoc.xsl verbatim.xsl changebars.xsl glossary.xsl synop.xsl component.xsl refentry.xsl xref.xsl formal.xsl html2xhtml.xsl pi.xsl titlepage.xsl ebnf.xsl table.xsl biblio.xsl block.xsl info.xsl chunk-common.xsl titlepage.templates.xsl html-rtf.xsl maketoc.xsl chunk-code.xsl index.xsl autoidx.xsl footnote.xsl profile-chunk.xsl lists.xsl admon.xsl math.xsl docbook.xsl profile-chunk-code.xsl qandaset.xsl param.xsl chunker.xsl manifest.xsl keywords.xsl callout.xsl sdocbook/src/plugin-resources README WhatsNew BUGS TODO VERSION RELEASE-NOTES.xml ChangeLog RELEASE-NOTES.html sdocbook/src/plugin-resources/fo xref.xsl lists.xsl docbook.xsl info.xsl param.ent glossary.xsl titlepage.xsl pdf2index profile-docbook.xsl refentry.xsl param.xml autotoc.xsl synop.xsl index.xsl pi.xsl biblio.xsl inline.xsl sections.xsl graphics.xsl verbatim.xsl division.xsl qandaset.xsl toc.xsl fo-patch-for-fop.xsl formal.xsl fop.xsl math.xsl block.xsl passivetex.xsl param.xweb axf.xsl ChangeLog titlepage.templates.xsl fo.xsl keywords.xsl admon.xsl callout.xsl autoidx.xsl ebnf.xsl table.xsl xep.xsl titlepage.templates.xml fo-rtf.xsl param.xsl pagesetup.xsl footnote.xsl component.xsl sdocbook/src/plugin-resources/html autotoc.xsl chunker.xsl qandaset.xsl table.xsl titlepage.templates.xml math.xsl verbatim.xsl info.xsl html-rtf.xsl changebars.xsl synop.xsl param.xsl pi.xsl admon.xsl param.xml maketoc.xsl index.xsl chunktoc.xsl ebnf.xsl profile-chunk-code.xsl chunk-common.xsl docbook.xsl profile-docbook.xsl block.xsl param.ent refentry.xsl chunkfast.xsl chunk-code.xsl graphics.xsl ChangeLog titlepage.xsl titlepage.templates.xsl keywords.xsl xref.xsl manifest.xsl profile-chunk.xsl lists.xsl oldchunker.xsl glossary.xsl division.xsl biblio.xsl sections.xsl component.xsl profile-onechunk.xsl footnote.xsl param.xweb onechunk.xsl autoidx.xsl inline.xsl formal.xsl html.xsl callout.xsl chunk.xsl toc.xsl sdocbook/src/plugin-resources/lib lib.xweb ChangeLog lib.xml lib.xsl sdocbook/src/plugin-resources/manpages README ChangeLog xref.xsl sect23.xsl docbook.xsl lists.xsl synop.xsl sdocbook/src/plugin-resources/javahelp javahelp.xsl profile-javahelp.xsl ChangeLog Log: Allow the use of docbook stylesheets as dependencies Revision Changes Path 1.4 +3 -1 maven-plugins/sdocbook/plugin.properties Index: plugin.properties =================================================================== RCS file: /cvsroot/maven-plugins/maven-plugins/sdocbook/plugin.properties,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- plugin.properties 17 Mar 2004 21:49:44 -0000 1.3 +++ plugin.properties 19 Dec 2004 13:03:14 -0000 1.4 @@ -11,7 +11,9 @@ maven.sdocbook.target.dir = ${maven.build.dir}/docs/docbook # the root dir of the stylesheet to use (defaults to plugin-internal version) -maven.sdocbook.stylesheets.dir = ${plugin.dir}/plugin-resources +maven.sdocbook.stylesheets.version=1.66.1 +#maven.sdocbook.stylesheets.dir = ${plugin.dir}/plugin-resources/docbook-xsl-${maven.sdocbook.stylesheets.version} +maven.sdocbook.stylesheets.zip = ${maven.repo.local}/docbook/zips/docbook-xsl-${maven.sdocbook.stylesheets.version}.zip # the resources which are to be copied from maven.sdocbook.src.dir maven.sdocbook.resources.include = **/*.png, **/*.gif 1.7 +24 -1 maven-plugins/sdocbook/plugin.jelly Index: plugin.jelly =================================================================== RCS file: /cvsroot/maven-plugins/maven-plugins/sdocbook/plugin.jelly,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- plugin.jelly 11 Dec 2004 20:11:01 -0000 1.6 +++ plugin.jelly 19 Dec 2004 13:03:14 -0000 1.7 @@ -2,7 +2,8 @@ <project xmlns:j="jelly:core" - > + xmlns:util="jelly:util" + xmlns:ant="jelly:ant"> <!-- Determine path seperator for the platform --> <j:set var="_sep" value="${path.separator}"/> @@ -29,6 +30,28 @@ <!-- create target directory for generated documentation --> <mkdir dir="${maven.sdocbook.target.dir}"/> + + <j:set var="docbookZipPath" value="${pom.getDependencyPath('docbook:docbook-xsl')}"/> + <j:if test="${docbookZipPath == null}"> + <echo>Using default stylesheets</echo> + <j:set var="docbookZipPath" value="${maven.sdocbook.stylesheets.zip}"></j:set> + <j:set var="maven.sdocbook.stylesheets.version" value="${pom.getDependency('docbook:docbook-xsl').version}"/> + </j:if> + + <j:if test="${context.getVariable('maven.sdocbook.stylesheets.dir') == null}"> + <j:set var="maven.sdocbook.stylesheets.dir" value="${plugin.dir}/plugin-resources/docbook-xsl-${maven.sdocbook.stylesheets.version}"/> + </j:if> + + <j:set var="unzipped" value="false" /> + <util:available file="${maven.sdocbook.stylesheets.dir}"> + <j:set var="unzipped" value="true" /> + <echo>Using previusly unzipped docbook stylesheets in ${maven.sdocbook.stylesheets.dir}</echo> + </util:available> + <j:if test="${!unzipped}"> + <!-- unzip docbook files --> + <ant:unzip dest="${maven.sdocbook.stylesheets.dir}/.." + src="${docbookZipPath}"/> + </j:if> </goal> 1.18 +10 -0 maven-plugins/sdocbook/project.xml Index: project.xml =================================================================== RCS file: /cvsroot/maven-plugins/maven-plugins/sdocbook/project.xml,v retrieving revision 1.17 retrieving revision 1.18 diff -u -r1.17 -r1.18 --- project.xml 11 Dec 2004 23:03:37 -0000 1.17 +++ project.xml 19 Dec 2004 13:03:14 -0000 1.18 @@ -59,6 +59,16 @@ </developers> <dependencies> + + <!-- default docbook stylesheets --> + <dependency> + <groupId>docbook</groupId> + <artifactId>docbook-xsl</artifactId> + <version>1.66.1</version> + <url>http://docbook.sourceforge.net</url> + <type>zip</type> + </dependency> + <dependency> <id>avalon-framework</id> <version>4.0</version> 1.4 +5 -40 maven-plugins/sdocbook/xdocs/users-guide.xml Index: users-guide.xml =================================================================== RCS file: /cvsroot/maven-plugins/maven-plugins/sdocbook/xdocs/users-guide.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- users-guide.xml 11 Dec 2004 22:47:28 -0000 1.3 +++ users-guide.xml 19 Dec 2004 13:03:14 -0000 1.4 @@ -45,45 +45,7 @@ included in this plugin. </p> <p> - Then it is lucky, that you can point to a newer version :-) - You simply need to set the "maven.sdocbook.stylesheets.dir" property to point to the location - of the version you want to use. - </p> - <p> - One way of doing this is to manually get a distribution of the stylesheets you want and point to - the location where you unzip them. - Another way of doing this is to let your project depend on the version of the stylesheets as a maven - dependency, and then pointing the maven.sdocbook.stylesheets.dir property into you maven.repo.local. - This requires that the docbook stylesheets are in a repository you can access. - The maven repository at Ibiblio has some <a href="http://www.ibiblio.org/maven/docbook/">here</a>. - e.g. add the folowing to maven.xml: - <pre> -<![CDATA[ - <postGoal name="sdocbook:prepare-filesystem"> - <j:set var="unzipped" value="false" /> - <util:available file="${maven.sdocbook.generated.fo}"> - <j:set var="unzipped" value="true" /> - <echo>Using previusly unzipped docbook files</echo> - </util:available> - <j:if test="${!unzipped}"> - <!-- unzip docbook files --> - <ant:unzip dest="${maven.build.dir}" - src="${pom.getDependencyPath('docbook:docbook-xsl')}"/> - </j:if> - - </postGoal> -]]> - </pre> - </p> - <p> - and this property to project.properties: - <pre> - maven.sdocbook.stylesheets.dir=${maven.build.dir}/docbook-xsl-1.66.1 - </pre> - </p> - - <p> - and finally add the dependency to the project.xml with the version you want + You can use another version just adding a dependency to the project.xml with the version you want <pre> <![CDATA[ <dependency> @@ -96,7 +58,10 @@ ]]> </pre> </p> - + <p> + Another way of doing this is to manually get a distribution of the stylesheets you want and point to + the location where you unzip them setting the "maven.sdocbook.stylesheets.dir" property. + </p> </section> <section name="Using custom stylesheets"> |
From: Carlos S. <car...@us...> - 2004-12-19 13:32:43
|
carlossg 04/12/19 05:32:37 Modified: sdocbook/xdocs users-guide.xml Log: Fixed typo Revision Changes Path 1.5 +1 -1 maven-plugins/sdocbook/xdocs/users-guide.xml Index: users-guide.xml =================================================================== RCS file: /cvsroot/maven-plugins/maven-plugins/sdocbook/xdocs/users-guide.xml,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- users-guide.xml 19 Dec 2004 13:03:14 -0000 1.4 +++ users-guide.xml 19 Dec 2004 13:32:37 -0000 1.5 @@ -34,7 +34,7 @@ </p> <p> Taking the stylesheets which convert into html as example, you could set the "draft" option by setting - the property "maven.sdocbook.html.params==-param draft.mode yes" in your project.properties. + the property "maven.sdocbook.html.params=-param draft.mode yes" in your project.properties. </p> </section> |
From: Carlos S. <car...@us...> - 2005-01-01 23:39:41
|
carlossg 05/01/01 15:39:32 Modified: sdocbook/xdocs users-guide.xml Log: Changed xsl version Revision Changes Path 1.7 +1 -1 maven-plugins/sdocbook/xdocs/users-guide.xml Index: users-guide.xml =================================================================== RCS file: /cvsroot/maven-plugins/maven-plugins/sdocbook/xdocs/users-guide.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- users-guide.xml 29 Dec 2004 22:32:05 -0000 1.6 +++ users-guide.xml 1 Jan 2005 23:39:31 -0000 1.7 @@ -51,7 +51,7 @@ <dependency> <groupId>docbook</groupId> <artifactId>docbook-xsl</artifactId> - <version>1.66.1</version> + <version>1.67.2</version> <url>http://docbook.sourceforge.net</url> <type>zip</type> </dependency> |