From 780df76f911609d4bdf38acdf3e9076fc015b4b0 Mon Sep 17 00:00:00 2001 From: David Cramer Date: Wed, 7 Jul 2010 20:15:18 +0000 Subject: [PATCH] updating install instructions --- xsl/webhelp/docsrc/readme.xml | 59 ++++++++++++++++++++++++----------- 1 file changed, 41 insertions(+), 18 deletions(-) diff --git a/xsl/webhelp/docsrc/readme.xml b/xsl/webhelp/docsrc/readme.xml index 5ce64a445..9c2879383 100755 --- a/xsl/webhelp/docsrc/readme.xml +++ b/xsl/webhelp/docsrc/readme.xml @@ -1,7 +1,5 @@ - - - + Web-based Help from DocBook XML Readme @@ -104,7 +102,7 @@ Search pane. Search results can include brief descriptions of the target. - Support for deep linking by appending ?content=content/filename.html to the url. + Support for deep linking by simply linking to the page since no frameset is used. A demo build.xml file to generate output. You can use this build file by importing it into your own or use it as a model for integrating this output format into your own build system. @@ -126,24 +124,45 @@ - Planned enhancements - - Add a switch so that the indexer only indexs meta tags. This will reduce the size of the index since only the meta tag content matters for Asian languages. - + Enhancements planned as part of GSOC 2010 + + Add stemmming support for English and one major non-Asian language. + + + Improve the support for Japanese and Chinese. + + + Add search highlighting. + + + Make indexer skip next and prev links in the footer and header. + + + Document skinning and customization options. + + + Add a show/hide toc button. + + + Move the header Next and Prev links to the banner + + + + Future enhancements + + Add an option to use Lucene for server-side searches with toc state persisted on the server. + - Limit the size of the search description to something like 150 characters or so. + Automatically limit the size of the search description to something 140 characters. - Add to the indexer the ability to specify a list of files or file patterns not to index. Currently it does not index index.html or ix01.html. + Support boolean operators in search. - When you mouse over a node in the table of contents, have it show the brief description in a Tool Tip. + Add to the indexer the ability to specify a list of files or file patterns not to index. Currently it does not index index.html or ix01.html, which is generally appropriate, but it should be up to the user to decide. - - Add a show/hide toc button. - - Make indexer skip next and prev links in the footer and header. + Add a parameter to make it possible to disable the search tab if it is not required. @@ -167,7 +186,7 @@ Confirm that you have xml-commons-resolver.jar in your CLASSPATH. - Download the package: docbook-webhelp.zip and unzip it somewhere convenient. + Download the package and unzip it somewhere convenient. Test the package by running ant webhelp. It should generate a copy of this documentation in the doc directory. @@ -197,7 +216,7 @@
Using the output - To deep link to a topic inside the help set, append ?content=content/filename.html to the URL, for example: http://yourdomain.com/help/index.html?content=content/filename.html, where filename.html is the name of the file in your helpset that you want to navigate to. + To deep link to a topic inside the help set, simply link directly to the page. This help system uses no frameset, so nothing further is necessary. See Chunking into multiple HTML files in Bob Stayton's DocBook XSL: The Complete Guide for information on controlling output file names in DocBook. @@ -223,10 +242,14 @@
+ + Design + This chapter provides an overview of how webhelp is implemented. WRITEME + - ネットワークに接続されているコンピュータ。加入者コンピュータはクライアント ホストであり、プロバイダ システムはサーバー ホストです。 + Demo of Japanese text: ネットワークに接続されているコンピュータ。加入者コンピュータはクライアント ホストであり、プロバイダ システムはサーバー ホストです。 ホスト -- 2.40.0