From: David Cramer Date: Mon, 12 Jul 2010 20:59:14 +0000 (+0000) Subject: Updating readme with indexer-language and exclude.search.from.chunked.html parameters X-Git-Tag: release/1.79.1~6^2~831^2~64 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=68fb528a8a44a0292f83810d14fb6c3270ae59ef;p=docbook-dsssl Updating readme with indexer-language and exclude.search.from.chunked.html parameters --- diff --git a/xsl/webhelp/docsrc/readme.xml b/xsl/webhelp/docsrc/readme.xml index 0a7150240..9369cb5e3 100755 --- a/xsl/webhelp/docsrc/readme.xml +++ b/xsl/webhelp/docsrc/readme.xml @@ -155,6 +155,9 @@ Parameterize width of the TOC pane OR make the TOC pane resizable by the user. + + Support ns and non-ns DocBook stylesheets. + Future enhancements @@ -198,7 +201,7 @@ Using the package - The following sections describe how to install and use the package. + The following sections describe how to install and use the package on Windows.
@@ -207,7 +210,7 @@ Installation - To install the package + To install the package on Windows The examples in this procedure assume a Windows installation, but the process is the same in other environments, mutatis mutandis. @@ -226,19 +229,32 @@ Unzip the Ant binary distribution to a convenient location on your system. For example: c:\Program Files. - Set the environment variable ANT_HOME to the top-level Ant directory. For example: c:\Program Files\apache-ant-1.7.1. + Set the environment variable ANT_HOME to the top-level Ant directory. For example: c:\Program Files\apache-ant-1.7.1. + See How To Manage Environment Variables in Windows XP for information on setting environment variables. + + Add the Ant bin directory to your PATH. For example: c:\Program Files\apache-ant-1.7.1\bin Confirm that Ant is installed by typing the following at a command prompt: ant -version + + If you see a message about the file tools.jar being missing, you can safely ignore it. + - If necessary, download xml-commons-resolver.jar and add it to your CLASSPATH. + If necessary, download xml-commons-resolver.jar and add it to your CLASSPATH. + + When adding jar files to your CLASSPATH, be sure to include the jar file. For example: C:\programs\xml-commons-resolver-1.2\resolver.jar. Note that on Windows, the CLASSPATH is a semicolon delimited list of jar files and paths to java class files. + + + + Download Saxon 6.5.x and unzip the distribution to a convenient location on your filesystem. You will use the path to saxon.jar in below. + Obtain the package. Currently, the webhelp package is only available through Subversion. @@ -257,7 +273,7 @@ - + In a text editor, edit the build.properties file in the webhelp directory and make the changes indicated by the comments:input-xml=docsrc/readme.xml frameset.base.dir=doc @@ -267,9 +283,7 @@ 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. If you omit this step, -# the xsls will use the stylesheets off the internet, which -# will slow down your document generation. +# to your docbook xsl stylesheets' catalog docbook-xsl-catalog=c:/gsoc2010/docbook-xsl-1.75.2/catalog.xml # If you wish to have the ant script validate the document before @@ -277,28 +291,39 @@ docbook-xsl-catalog=c:/gsoc2010/docbook-xsl-1.75.2/catalog.xml # of your DocBook DTD. The sample document is # a DocBook 4.5 document and uncomment the line validate=true. docbookx.dtd=c:/workhead/export/DocBookDTD/4.5/docbookx.dtd -#validate=true +validate=true + +# Set this to true if you don't need a search tab. +exclude.search.from.chunked.html=false + +#indexer-language is used to tell the search indexer which language the docbook is written. +#This will be used to identify the correct stemmer, and punctuations that differs from language to language. +#see the documentation for details. en=English, cn=Chinese, jp=Japanese etc. +indexer-language=en - Test the package by running the command ant webhelp at the command line in the webhelp directory. It should generate a copy of this documentation in the doc directory. + Test the package by running the command ant webhelp at the command line in the webhelp directory. It should generate a copy of this documentation in the doc directory. Type start doc\index.html to open the output in a browser. - If you wish to use the included build.xml file for your own content, create a build.xml file that imports the one from this package: + To process your own content: + + + + create a new build.xml file that defines the name of your source file, the desired output directory, and imports the build.xml from this package. For example: <project> <property name="input-xml" value="path-to/yourfile.xml"/> <property name="frameset.base.dir" value="path-to/desired-output-dir"/> - <property name="xslt-processor-classpath" value="c:/workhead/export/saxon/6.5/lib/saxon.jar"/> - <property name="docbook-xsl-catalog" value="c:/gsoc2010/docbook-xsl-1.75.2/catalog.xml"/> - <property name="docbookx.dtd value="file:///c:/workhead/export/DocBookDTD/4.5/docbookx.dtd"/> <import file="path-to/docbook-webhelp/build.xml"/> </project> - - - - From the directory containing your newly created build.xml file, type ant webhelp to build your document. - - - Add some code to the main ant script to copy your images to the output directory. + + + + From the directory containing your newly created build.xml file, type ant webhelp to build your document. + + + Add some code to the main ant script to copy your images to the output directory. + +