url="http://code.google.com/soc/">Google Summer of Code</ulink> project. </para>
</legalnotice>
<copyright>
- <year>2008-2011</year>
+ <year>2008-2012</year>
<holder>Kasun Gajasinghe</holder>
<holder>David Cramer</holder>
</copyright>
<surname>Gajasinghe</surname>
<email>kasunbg AT gmail DOT com</email>
</author>
- <pubdate>September 2011</pubdate>
+ <pubdate>January 2012</pubdate>
</bookinfo>
<chapter>
<chapterinfo>
</step>
<step>
<para>If necessary, install <ulink url="http://ant.apache.org/bindownload.cgi">Apache
- Ant</ulink> 1.6.5 or higher. See <ulink
- url="http://ant.apache.org/manual/install.html">Ant installation instructions</ulink>.
- 2.x gives brief instructions.</para>
+ Ant</ulink> 1.8.0 or higher. See <ulink
+ url="http://ant.apache.org/manual/install.html">Ant installation instructions</ulink>.</para>
<substeps>
<step>
<para>Unzip the Ant binary distribution to a convenient location on your system. For
</step>
<step>
<para>Set the environment variable <envar>ANT_HOME</envar> to the top-level Ant
- directory. For example: <filename>c:\Program Files\apache-ant-1.7.1</filename>. <tip>
+ directory. For example: <filename>c:\Program Files\apache-ant-1.8.0</filename>. <tip>
<para>See <ulink url="http://support.microsoft.com/kb/310519">How To Manage
Environment Variables in Windows XP</ulink> for information on setting
environment variables.</para>
</step>
<step>
<para>Add the Ant <filename>bin</filename> directory to your <envar>PATH</envar>. For
- example: <filename>c:\Program Files\apache-ant-1.7.1\bin</filename></para>
+ example: <filename>c:\Program Files\apache-ant-1.8.0\bin</filename></para>
</step>
<step>
<para>Confirm that Ant is installed by typing the following at a command prompt:
<envar>CLASSPATH</envar>.</para>
</note></para>
</step>
- <step>
+<!-- <step>
<para>If you are using Ant 1.8.1 or higher, you may need to add
<filename>xercesImpl.jar</filename>, and <filename>xml-apis.jar</filename> to the
classpath. See <function>index</function> target in the Ant script to see how it's
currently added. <note>
- <para>The way webhelp indexer get invoked is made easier after the XSL-1.76.1 release.
- </para>
+ <para>The way webhelp indexer is invoked is made easier after the XSL-1.76.1 release. </para>
</note></para>
- </step>
+ </step>-->
<step id="edit-build-properties">
<para>In a text editor, edit the <filename>build.properties</filename> file in the webhelp
- directory and make the changes indicated by the
- comments:<programlisting># The path (relative to the build.xml file) to your input document.
+ directory and make the changes indicated by the comments.<important>
+ <para>You must set appropriate values for <code>xslt-processor-classpath</code>,
+ <code>xercesImpl.jar</code>, and <code>xml-apis.jar</code>.</para>
+ </important><programlisting>
+# The path (relative to the build.xml file) to your input document.
# To use your own input document, create a build.xml file of your own
# and import this build.xml.
input-xml=docsrc/readme.xml
# and uncomment this line.
#input-images-basedir=/path/to/image/location
-# Modify this so that it points to your copy of the Saxon 6.5 jar.
-xslt-processor-classpath=/usr/share/java/saxon-6.5.5.jar
+# Modify the follosing so that they point to your local
+# copy of the jars indicated:
+# * Saxon 6.5 jar
+# * Xerces 2: xercesImpl.jar
+# * xml-commons: xml-apis.jar
+xslt-processor-classpath=/usr/share/java/saxon-6.5.5.jar
+xercesImpl.jar=/usr/share/java/xercesImpl.jar
+xml-apis.jar=/usr/share/java/xml-apis.jar
# For non-ns version only, this validates the document
# against a dtd.
validate-against-dtd=true
+# The extension for files to be indexed (html/htm/xhtml etc.)
+html.extension=html
+
# Set this to false if you don't need a search tab.
webhelp.include.search.tab=true
# stemmer, and punctuations that differs from language to language.
# see the documentation for details. en=English, fr=French, de=German,
# zh=Chinese, ja=Japanese etc.
-webhelp.indexer.language=en</programlisting></para>
+webhelp.indexer.language=en
+
+# Enables/Disables stemming
+# Stemming allows better querying for the search
+enable.stemming=true
+
+#Set the table of contents file. This file will not be indexed.
+#toc.file=dummy.html
+
+#Used for adding branding specific contents to the html files.
+#For example, the url docbook.org, Google Analytics id etc.
+branding=docbook
+brandname=DocBook
+
+# Set admon.graphics to 1 to user graphics for note, tip, etc.
+admon.graphics=0
+suppress.footer.navigation=0</programlisting></para>
</step>
<step>
<para>Test the package by running the command <code>ant webhelp
<title>Adding images</title>
<para>This section shows how to add images to WebHelp. For that, follow the simple procedure given.<itemizedlist>
<listitem>
- <para>Add all the images to template/content folder.</para>
+ <para>Put the images in a subdirectory of your source file directory. For example
+ <filename>docsrc/images</filename>.</para>
</listitem>
<listitem>
<para>Then refer to those images from your docbook document.</para>
<para>Following image is from <emphasis role="bold"
- >webhelp/template/content/images/sample.jpg</emphasis>. The docbook code is shown
+ >webhelp/docsrs/images/sample.jpg</emphasis>. The docbook code is shown
below.</para>
<para>
<figure>
</figure></programlisting>
</example>
</listitem>
+ <listitem>
+ <para> The <filename>build.properties</filename> file controls what directories are copied
+ over from the source tree to the output
+ tree:<programlisting># If your document has image directories that need to be copied
+# to the output directory, you can list patterns here.
+# See the Ant documentation for fileset for documentation
+# on patterns.
+input-images-dirs=images/**,figures/**,graphics/**</programlisting></para>
+ </listitem>
</itemizedlist></para>
</section>
</chapter>
<primary>FAQ</primary>
</indexterm>
</chapter>
- <xi:include href="xinclude-test.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</book>
\ No newline at end of file
+ <!--<xi:include href="xinclude-test.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>-->
+</book>
projects / docbook-dsssl / commitdiff
