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/ch01.html | 148 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 webhelp/docs/ch01.html (limited to 'webhelp/docs/ch01.html') diff --git a/webhelp/docs/ch01.html b/webhelp/docs/ch01.html new file mode 100644 index 0000000..5495587 --- /dev/null +++ b/webhelp/docs/ch01.html @@ -0,0 +1,148 @@ + + + + +Introduction - - README: Web-based Help from DocBook XML

Introduction

+

A common requirement for technical publications groups is to produce a Web-based help + format that includes a table of contents pane, a search feature, and an index similar to what + you get from the Microsoft HTML Help (.chm) format or Eclipse help. If the content is help for + a Web application that is not exposed to the Internet or requires that the user be logged in, + then it is impossible to use services like Google to add search. +

Features

  • Sophisticated CSS-based page layout

  • Client-side search.

    • Provides full content search of the documentation. Shows the search results with + links to chunked pages, and a small description.

    • Search results scoring/rating - The results are weighted according to how many + times the words in search query appears in it, is it bold or not, is in index terms + etc. The score out of 5 is shown by small colored boxes after each + search-result.

    • Search results can include brief descriptions of the target.

    • Stemming support for English, French, and German. Stemming support can be added + for other languages by implementing a stemmer.

    • Support for Chinese, Japanese, and Korean languages using code from the Lucene search + engine.

    • Search highlighting shows where the searched term appears in the results. +

  • Table of contents (TOC) pane with collapsible toc tree.

  • Auto-synchronization of content pane and TOC.

  • Nicely placed small forward, backward, top links

  • TOC and search pane implemented without the use of a frameset.

  • An Ant script and sample Makefile to generate output. + You can use the ant build file by importing it into your + own or use it as a model for integrating this output + format into your own build system. Alternatively, you can + use the build scripts as a template for creating your own + script. You can also generate webhelp from DocBook using + the Docbkx Maven plugin.

Prev   Next
 Home 
-- cgit v1.2.1