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 0a715024050897d562d901d2cd164d2082b55e29..9369cb5e37c37fd4916faa8cbf88d7efee0d8a65 100755 (executable)
--- a/xsl/webhelp/docsrc/readme.xml
+++ b/xsl/webhelp/docsrc/readme.xml
@@ -155,6 +155,9 @@
                <listitem>
                  <para>Parameterize width of the TOC pane OR make the TOC pane resizable by the user.</para>
                </listitem>
+               <listitem>
+                 <para>Support ns and non-ns DocBook stylesheets.</para>
+               </listitem>
          </itemizedlist>
       <itemizedlist>
         <title>Future enhancements</title>
@@ -198,7 +201,7 @@
   </chapter>
   <chapter>
     <title>Using the package</title>
-    <para role="summary">The following sections describe how to install and use the package.</para>
+    <para role="summary">The following sections describe how to install and use the package on Windows.</para>
     <section>
       <sectioninfo>
         <abstract>
@@ -207,7 +210,7 @@
       </sectioninfo>
       <title>Installation</title>
       <procedure>
-        <title>To install the package</title>
+        <title>To install the package on Windows</title>
                <note>
                  <para>The examples in this procedure assume a Windows installation, but the process is the same in other environments, <foreignphrase>mutatis mutandis</foreignphrase>.</para>
                </note>
@@ -226,19 +229,32 @@
                          <para>Unzip the Ant binary distribution to a convenient location on your system. For example: <filename>c:\Program Files</filename>.</para>
                        </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>.</para>
+                         <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>
+                                 <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>
+                               </tip>
+</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>
                        </step>
                        <step>
                          <para>Confirm that Ant is installed by typing the following at a command prompt: <programlisting>ant -version</programlisting></para>
+                         <note>
+                               <para>If you see a message about the file <filename>tools.jar</filename> being missing, you can safely ignore it.</para>
+                         </note>
                        </step>
                  </substeps>
         </step>
         <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>. </para>
+          <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 <ulink url="http://prdownloads.sourceforge.net/saxon/saxon6-5-5.zip">Saxon 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.</para>
+               </step>
         <step>
           <para>Obtain the package. <!--ulink url="http://www.thingbag.net/docbook/docbook-webhelp.zip">docbook-webhelp.zip</ulink--> Currently, the webhelp package is only available through Subversion.</para>
                  <substeps>
@@ -257,7 +273,7 @@
                        </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>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</programlisting></para>
+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</programlisting></para>
                </step>
         <step>
-          <para>Test the package by running the command <code>ant webhelp</code> at the command line in the webhelp directory. It should generate a copy of this documentation in the <filename class="directory">doc</filename> directory.</para>
+          <para>Test the package by running the command <code>ant webhelp</code> at the command line in the webhelp directory. It should generate a copy of this documentation in the <filename class="directory">doc</filename> directory. Type <code>start doc\index.html</code> to open the output in a browser.</para>
         </step>
         <step>
-          <para>If you wish to use the included <filename>build.xml</filename> file for your own content, create a <filename>build.xml</filename> file that imports the one from this package: 
+          <para>To process your own content: </para>
+                 <substeps>
+                       <step>
+                         <para>
+                               create a new <filename>build.xml</filename> file that defines the name of your source file, the desired output directory, and imports the <filename>build.xml</filename> from this package. For example:  
             <programlisting>&lt;project>
   &lt;property name="input-xml" value="<replaceable>path-to/yourfile.xml</replaceable>"/>
   &lt;property name="frameset.base.dir" value="<replaceable>path-to/desired-output-dir</replaceable>"/>
-  &lt;property name="xslt-processor-classpath" value="<replaceable>c:/workhead/export/saxon/6.5/lib/saxon.jar</replaceable>"/>
-  &lt;property name="docbook-xsl-catalog" value="<replaceable>c:/gsoc2010/docbook-xsl-1.75.2/catalog.xml</replaceable>"/>
-  &lt;property name="docbookx.dtd value="<replaceable>file:///c:/workhead/export/DocBookDTD/4.5/docbookx.dtd</replaceable>"/>
   &lt;import file="<replaceable>path-to/docbook-webhelp/</replaceable>build.xml"/>
 &lt;/project></programlisting>
-          </para>
-        </step>
-               <step>
-                 <para>From the directory containing your newly created <filename>build.xml</filename> file, type <code>ant webhelp</code> to build your document.</para>
-               </step>
-               <step>
-                 <para>Add some code to the main ant script to copy your images to the output directory.</para>
+                         </para>
+                       </step>
+                       <step>
+                         <para>From the directory containing your newly created <filename>build.xml</filename> file, type <code>ant webhelp</code> to build your document. </para>
+                       </step>
+                       <step>
+                         <para>Add some code to the main ant script to copy your images to the output directory.</para>
+                       </step>
+                 </substeps>
                </step>
       </procedure>
     </section>