From 802da9dd5d4bc18f46a916eedc0c5c1980a15e59 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Sun, 17 Mar 2013 20:07:05 +0000 Subject: Imported from /home/lorry/working-area/delta_docbook-xsl/docbook-xsl-1.78.1.tar.bz2. --- webhelp/docs/ch02s03.html | 157 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 webhelp/docs/ch02s03.html (limited to 'webhelp/docs/ch02s03.html') diff --git a/webhelp/docs/ch02s03.html b/webhelp/docs/ch02s03.html new file mode 100644 index 0000000..3cfb5df --- /dev/null +++ b/webhelp/docs/ch02s03.html @@ -0,0 +1,157 @@ + + + + +Search indexing - - README: Web-based Help from DocBook XML

Search indexing

+

Run ant index in the webhelp directory to index the content. Running + ant webhelp will do the indexing as part of the process as well.

Here's some detailed information about invoking the indexer. The indexing process is + pretty smooth, so probably you doesn't need to be concerned with following details. Webhelp + Ant script does all the needed bits.

  • Following should be in the CLASSPATH.

    +

    • webhelpindexer.jar, + lucene-analyzers-3.0.0.jar, + lucene-core-3.0.0.jar - These three are available in the + extensions/ directory of docsbook-xsl-1.76.1, and is automatically fetched to the + webhelp's Ant script. Go for a XSL snapshot if you can which contains the latest + version http://docbook.sourceforge.net/snapshot/

    • xercesImpl.jar, xml-apis.jar - + These two comes by default with Ant 1.8.0 or prior versions. These are available + under /usr/share/java directory of Linux distributions as well. Else, you may have + to download, and put them to jre/lib/endorsed.

    +

  • The main class is com.nexwave.nquindexer.IndexerMain for the + version 1.76.1+. It's com.nexwave.nquindexer.IndexerTask for the + versions 1.76.0 and 1.76.1.

    +

    • Needs two parameters as command-line arguments:

      +

      • The folder where the files to be indexed reside

      +

      • (Optional) language. defaults to "en". See build.properties for + details

      +

    +

    Note

    We have changed the way we invoke the webhelp indexer from the Ant Task to + indexertask to direct invocation. This seems to have remove the + CLASSPATH issue some people were having.

    +

To build the indexer, you must have installed the JDK version 1.5 or + higher and set the ANT_HOME environment variable.

Prev Up Next
 Home 
-- cgit v1.2.1