doc/xslt/webhelp/docs/content/index.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head>
   4 <meta http-equiv="X-UA-Compatible" content="IE=7" />
   5 <title>README: Web-based Help from DocBook XML</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML" /><link rel="next" href="ch01.html" title="Chapter 1. Introduction" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript">
   6             //The id for tree cookie
   7             var treeCookieId = "treeview-897";
   8             var language = "en";
   9             var w = new Object();
  10             //Localization
  11             txt_filesfound = 'Results';
  12             txt_enter_at_least_1_char = "You must enter at least one character.";
  13             txt_browser_not_supported = "Your browser is not supported. Use of Mozilla Firefox is recommended.";
  14             txt_please_wait = "Please wait. Search in progress...";
  15             txt_results_for = "Results for: ";
  16         </script><style type="text/css">
  17             input {
  18             margin-bottom: 5px;
  19             margin-top: 2px;
  20             }
  21
  22             .folder {
  23             display: block;
  24             height: 22px;
  25             padding-left: 20px;
  26             background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat;
  27             }
  28             </style><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon" /><link rel="stylesheet" type="text/css" href="../common/css/positioning.css" /><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css" /><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css" /><script type="text/javascript" src="../common/jquery/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"></script><script type="text/javascript" src="search/htmlFileList.js"></script><script type="text/javascript" src="search/htmlFileInfoList.js"></script><script type="text/javascript" src="search/nwSearchFnt.js"></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"></script><script type="text/javascript" src="search/index-2.js"></script><script type="text/javascript" src="search/index-3.js"></script></head><body><div id="header"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt="Company Logo" /><h1 align="center">README: Web-based Help from DocBook XML<br /> </h1><div id="navheader" align="right"><table><tr><td style="height: 28px; width: 16px;"><a id="showHideButton" onclick="showHideToc();" class="pointLeft" title="Hide TOC tree">.
  29                             </a></td><td><img src="../common/images/highlight-blue.gif" alt="H" height="25px" onclick="toggleHighlight()" id="showHideHighlight" style="cursor:pointer" title="Toggle search result highlighting" /></td><td>
  30                                     |
  31                                     <a accesskey="n" href="ch01.html">Next</a></td></tr></table></div></div><div id="content"><div class="book" title="README: Web-based Help from DocBook XML"><div class="titlepage"><div><div><h1 class="title"><a id="id36085812"></a>README: Web-based Help from DocBook XML</h1></div><div><div class="author"><h3 class="author"><span class="firstname">David</span> <span class="surname">Cramer</span></h3><code class="email">&lt;<a class="email" href="mailto:dcramer AT motive DOT com">dcramer AT motive DOT com</a>&gt;</code><code class="email">&lt;<a class="email" href="mailto:david AT thingbag DOT net">david AT thingbag DOT net</a>&gt;</code></div></div><div><div class="author"><h3 class="author"><span class="firstname">Kasun</span> <span class="surname">Gajasinghe</span></h3><code class="email">&lt;<a class="email" href="mailto:kasunbg AT gmail DOT com">kasunbg AT gmail DOT com</a>&gt;</code></div></div><div><p class="copyright">Copyright © 2008-2010 Kasun Gajasinghe, David Cramer</p></div><div><div class="legalnotice" title="Legal Notice"><a id="id36122924"></a><p>Permission is hereby granted, free of charge, to any person
  32       obtaining a copy of this software and associated documentation files
  33       (the <span class="quote">“<span class="quote">Software</span>”</span>), to deal in the Software without
  34       restriction, including without limitation the rights to use, copy,
  35       modify, merge, publish, distribute, sublicense, and/or sell copies of
  36       the Software, and to permit persons to whom the Software is furnished to
  37       do so, subject to the following conditions: </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>The above copyright notice and this permission notice shall
  38             be included in all copies or substantial portions of the
  39             Software.</p></li><li class="listitem"><p>Except as contained in this notice, the names of individuals
  40             credited with contribution to this software shall not be used in
  41             advertising or otherwise to promote the sale, use or other
  42             dealings in this Software without prior written authorization from
  43             the individuals in question.</p></li><li class="listitem"><p>Any stylesheet derived from this Software that is publicly
  44             distributed will be identified with a different name and the
  45             version strings in any derived Software will be changed so that no
  46             possibility of confusion between the derived package and this
  47             Software will exist.</p></li></ul></div><p title="Warranty:"><strong>Warranty: </strong>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  48         EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  49         MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  50         IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR
  51         ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  52         CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  53         WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p><p>This package is maintained by Kasun Gajasinghe, <code class="email">&lt;<a class="email" href="mailto:kasunbg AT&#10;      gmail DOT com">kasunbg AT
  54       gmail DOT com</a>&gt;</code> and David Cramer, <code class="email">&lt;<a class="email" href="mailto:david AT thingbag DOT&#10;      net">david AT thingbag DOT
  55       net</a>&gt;</code>.</p><p>This package also includes the following software written and
  56       copyrighted by others:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Files in <code class="filename">template/common/jquery</code> are
  57             copyrighted by <a class="ulink" href="http://jquery.com/" target="_top">JQuery</a>
  58             under the MIT License. The file
  59             <code class="filename">jquery.cookie.js</code> Copyright (c) 2006 Klaus
  60             Hartl under the MIT license.</p><a id="id36123021" class="indexterm"></a></li><li class="listitem"><p>Some files in the <code class="filename">template/content/search</code> and <code class="filename">indexer</code> directories were originally
  61             part of N. Quaine's htmlsearch DITA plugin. The htmlsearch DITA
  62             plugin is available from the <a class="ulink" href="http://tech.groups.yahoo.com/group/dita-users/files/Demos/" target="_top">files
  63             page</a> of the DITA-users yahoogroup. The htmlsearch plugin
  64             was released under a BSD-style license. See
  65             <code class="filename">indexer/license.txt</code> for details. <a id="id36123055" class="indexterm"></a> <a id="id36123063" class="indexterm"></a></p></li><li class="listitem"><p>Stemmers from the <a class="ulink" href="http://snowball.tartarus.org/texts/stemmersoverview.html" target="_top">Snowball
  66             project</a> released under a BSD license.</p></li><li class="listitem"><p>Code from the <a class="ulink" href="http://lucene.apache.org/" target="_top">Apache
  67             Lucene</a> search engine provides support for tokenizing
  68             Chinese, Japanese, and Korean content released under the Apache
  69             2.0 license. </p></li></ul></div><p>
  70                 Webhelp for DocBook was developed as a <a class="ulink" href="http://socghop.appspot.com" target="_top">Google Summer of Code</a> project.
  71           </p></div></div><div><p class="pubdate">August 2010</p></div></div><hr /></div><div class="toc"><p><strong>Contents</strong></p><dl><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dt><span class="chapter"><a href="ch02.html">2. Using the package</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s01.html">Generating webhelp output</a></span></dt><dt><span class="section"><a href="ch02s02.html">Using and customizing the output</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s02.html#id36124136">Recommended Apache configurations</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s03.html">Building the indexer</a></span></dt><dt><span class="section"><a href="ch02s04.html">Adding support for other (non-CJKV) languages</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. Developer Docs</a></span></dt><dd><dl><dt><span class="section"><a href="ch03s01.html">Design</a></span></dt><dt><span class="section"><a href="ch03s02.html">Search</a></span></dt><dd><dl><dt><span class="section"><a href="ch03s02.html#id36124646">New Stemmers</a></span></dt></dl></dd></dl></dd></dl></div><div class="list-of-examples"><p><strong>List of Examples</strong></p><dl><dt>3.1. <a href="ch03s02.html#id36124759">Add new language to supportedLanguages array</a></dt><dt>3.2. <a href="ch03s02.html#id36124809">initialize correct stemmer based on the <code class="code">webhelp.indexer.language</code> specified</a></dt></dl></div></div><script type="text/javascript" src="../common/main.js"></script><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr></table></div></div><div><div id="leftnavigation" style="padding-top:3px; background-color:white;"><div id="tabs"><ul><li><a href="#treeDiv"><em>Contents</em></a></li><li><a href="#searchDiv"><em>Search</em></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;" /><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li><span class="file"><a href="ch01.html">Introduction</a></span></li><li><span class="file"><a href="ch02.html">Using the package</a></span><ul><li><span class="file"><a href="ch02s01.html">Generating webhelp output</a></span></li><li><span class="file"><a href="ch02s02.html">Using and customizing the output</a></span><ul><li><span class="file"><a href="ch02s02.html#id36124136">Recommended Apache configurations</a></span></li></ul></li><li><span class="file"><a href="ch02s03.html">Building the indexer</a></span></li><li><span class="file"><a href="ch02s04.html">Adding support for other (non-CJKV) languages</a></span></li></ul></li><li><span class="file"><a href="ch03.html">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html">Design</a></span></li><li><span class="file"><a href="ch03s02.html">Search</a></span><ul><li><span class="file"><a href="ch03s02.html#id36124646">New Stemmers</a></span></li></ul></li></ul></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(ditaSearch_Form);return false" name="ditaSearch_Form" class="searchForm" id="ditaSearch_Form"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="text" class="searchText" /> &nbsp; <input onclick="Verifie(ditaSearch_Form)" type="button" class="searchButton" value="Go" id="doSearch" /></center></fieldset></form></div><div id="searchResults"><center></center></div></div></div></div></div></body></html>