as a model for integrating this output format into your own build
system.</para>
</listitem>
- </itemizedlist><itemizedlist>
- <title>Features planned as part of GSOC 2010</title>
+ </itemizedlist>
+
+ <itemizedlist>
+ <title>Features completed as part of GSOC 2010</title>
<listitem>
- <para>[DONE] Implement the toc and search pane without using
+ <para>Implement the toc and search pane without using
frames.</para>
</listitem>
<listitem>
- <para>[DONE] Add autosynchronization to the toc.</para>
+ <para>Add autosynchronization to the toc.</para>
</listitem>
<listitem>
- <para>[DONE] Add stemmming support for English and one major
+ <para>Add stemmming support for English and one major
non-Asian language.</para>
</listitem>
<listitem>
- <para>[DONE] Add a show/hide toc button.</para>
+ <para>Add a show/hide toc button.</para>
</listitem>
<listitem>
- <para>[DONE] Move the header Next and Prev links to the
+ <para>Move the header Next and Prev links to the
banner</para>
</listitem>
<listitem>
- <para>[DONE] Make indexer skip next and prev links in the footer and
+ <para>Make indexer skip next and prev links in the footer and
header.</para>
</listitem>
<listitem>
- <para>[DONE] Add search highlighting with a button to toggle it on
+ <para>Add search highlighting with a button to toggle it on
an off.</para>
</listitem>
<listitem>
- <para>[DONE] Improve the support for Japanese and Chinese.</para>
+ <para>Improve the support for Japanese and Chinese.</para>
</listitem>
<listitem>
<para>Support 5.x/ns and 4.x/non-ns DocBook stylesheets.</para>
</listitem>
</itemizedlist><itemizedlist>
- <title>Future enhancements (GSOC 2011?)</title>
+ <title>Possible future enhancements</title>
<listitem>
<para>Use <sgmltag class="attribute">tabindex</sgmltag> attributes to control the tab order in the output. The Contents and Search tabs should be first and second, then the search box and button, then the table of contents items, and so on.</para>
6.5.x</ulink> and unzip the distribution to a convenient location on
your filesystem. You will use the path to
<filename>saxon.jar</filename> in <xref
- linkend="edit-build-properties" /> below.<important>
- <para>If you receive errors from the indexer when building documents, remove Saxon 6.5 from your <envar>CLASSPATH</envar>
- when you generate webhelp output.</para>
- </important></para>
- </step>
-
- <step>
- <para>Obtain the package in one of two ways:</para>
-
- <itemizedlist>
- <listitem>
- <para>Download the beta version of the package: <ulink
- url="http://www.thingbag.net/docbook/gsoc2010/webhelp-gsoc2010-beta.zip">for
- DocBook 4.x</ulink> or <ulink
- url="http://www.thingbag.net/docbook/gsoc2010/webhelp-ns-gsoc2010-beta.zip">for
- DocBook 5.x</ulink>.</para>
- </listitem>
-
- <listitem>
- <para>OR, if you prefer to have the bleeding edge, you can use a
- <ulink
- url="http://en.wikipedia.org/wiki/Comparison_of_Subversion_clients">Subversion
- client</ulink> to download it directly from Subversion:
- <programlisting>svn co https://docbook.svn.sourceforge.net/svnroot/docbook/branches/webhelp/xsl/webhelp webhelp</programlisting></para>
- </listitem>
- </itemizedlist>
- </step>
-
- <step>
- <para>To improve performance, you should use a catalog resolver to
- cause webhelp.xsl to import a local version of the DocBook XSL
- stylesheets. Alternatively, you can edit the <sgmltag
- class="attribute">href</sgmltag> attribute in the
- <sgmltag>xsl:import</sgmltag> element in
- <filename>webhelp.xsl</filename>.</para>
-
- <substeps>
- <step>
- <para>If necessary, download <ulink
- url="http://xml.apache.org/commons/dist">xml-commons-resolver.jar</ulink>
- and add it to your <envar>CLASSPATH</envar>. <tip>
- <para>When adding jar files to your
- <envar>CLASSPATH</envar>, be sure to include the jar file.
- For example:
- <filename>C:\programs\xml-commons-resolver-1.2\resolver.jar</filename>.
- Note that on Windows, the <envar>CLASSPATH</envar> is a
- semicolon delimited list of jar files and paths to java
- class files.</para>
- </tip></para>
- </step>
-
- <step>
- <para>Download and extract DocBook XSLs to a convenient location
- on your file system. Currently, this package supports <ulink
- url="http://sourceforge.net/projects/docbook/files/#files">docbook-xsl</ulink>
- (i.e. it does not yet support the namespace version of the xsls
- and does not yet strip the namespace from DocBook 5.x documents.
- <note>
- <para>If you see the message <screen>Warning: catalogpath listing external catalogs will be ignored</screen>
- when you generate output, this indicates that your catalog
- resolver is not installed correctly and is not being
- used.</para>
- </note></para>
- </step>
- </substeps>
+ linkend="edit-build-properties" /> below.</para>
</step>
<step id="edit-build-properties">
# Modify this so that it points to your copy of the Saxon 6.5 jar.
xslt-processor-classpath=c:/workhead/export/saxon/6.5/lib/saxon.jar
-# To use this catalog, make sure the resolver is in your classpath.
-# Download xml-commons-resolver from http://xml.apache.org/commons/dist/
-# and add it to your CLASSPATH. Then use the following property to point
-# to your docbook xsl stylesheets' catalog. Better yet,
-# you can list the catalog file in your CatalogManager.properties file.
-docbook-xsl-catalog=c:/gsoc2010/docbook-xsl-1.75.2/catalog.xml
-
# If you wish to have the ant script validate the document before
# building it, set this property to the location
# of your DocBook DTD. The sample document is
xmlns:db="http://docbook.org/ns/docbook"
version="1.0" xmlns="http://www.w3.org/1999/xhtml">
- <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/chunk.xsl"/>
+ <xsl:import href="../../xhtml/chunk.xsl"/>
<xsl:output
method="html"
encoding="utf-8"
cdata-section-elements=""/>
- <!-- Custom params! -->
+ <!-- webhelp-specific params! -->
<xsl:param name="webhelp.include.search.tab">true</xsl:param>
<xsl:param name="webhelp.start.filename">index.html</xsl:param>
<xsl:param name="webhelp.base.dir">doc</xsl:param>
<xsl:param name="webhelp.tree.cookie.id" select="concat( 'treeview-', count(//node()) )"/>
<xsl:param name="webhelp.indexer.language">en</xsl:param>
- <!-- Custom params! -->
+ <!-- webhelp-specific params! -->
- <!-- Set some reasonable defaults for webhelp output -->
+ <!-- Set some reasonable defaults for webhelp output -->
<xsl:param name="chunker.output.indent">no</xsl:param>
<xsl:param name="navig.showtitles">0</xsl:param>
<xsl:param name="manifest.in.base.dir" select="0"/>
projects / docbook-dsssl / commitdiff