| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"><head> |
| <meta http-equiv="X-UA-Compatible" content="IE=7"></meta> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta> |
| <title>README: Web-based Help from DocBook XML</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></meta><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="next" href="ch01.html" title="Introduction"></link><script type="text/javascript"> |
| //The id for tree cookie |
| var treeCookieId = "treeview-1055"; |
| var language = "en"; |
| var w = new Object(); |
| //Localization |
| txt_filesfound = 'Results'; |
| txt_enter_at_least_1_char = "You must enter at least one character."; |
| txt_browser_not_supported = "JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site."; |
| txt_please_wait = "Please wait. Search in progress..."; |
| txt_results_for = "Results for: "; |
| </script><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"></link><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"></link><style type="text/css"> |
| noscript{ |
| font-weight:bold; |
| } |
| input { |
| margin-bottom: 5px; |
| margin-top: 2px; |
| } |
| .folder { |
| display: block; |
| height: 22px; |
| padding-left: 20px; |
| background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat; |
| } |
| span.contentsTab { |
| padding-left: 20px; |
| background: url(../common/images/toc-icon.png) no-repeat 0 center; |
| } |
| span.searchTab { |
| padding-left: 20px; |
| background: url(../common/images/search-icon.png) no-repeat 0 center; |
| } |
| |
| /* Overide jquery treeview's defaults for ul. */ |
| .treeview ul { |
| background-color: transparent; |
| margin-top: 4px; |
| } |
| #webhelp-currentid { |
| background-color: #D8D8D8 !important; |
| } |
| .treeview .hover { color: black; } |
| .filetree li span a { text-decoration: none; font-size: 12px; color: #517291; } |
| |
| /* Override jquery-ui's default css customizations. These are supposed to take precedence over those.*/ |
| .ui-widget-content { |
| border: 0px; |
| background: none; |
| color: none; |
| } |
| .ui-widget-header { |
| color: #e9e8e9; |
| border-left: 1px solid #e5e5e5; |
| border-right: 1px solid #e5e5e5; |
| border-bottom: 1px solid #bbc4c5; |
| border-top: 4px solid #e5e5e5; |
| border: medium none; |
| background: #F4F4F4; /* old browsers */ |
| background: -moz-linear-gradient(top, #F4F4F4 0%, #E6E4E5 100%); /* firefox */ |
| background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#F4F4F4), color-stop(100%,#E6E4E5)); /* webkit */ |
| font-weight: none; |
| } |
| .ui-widget-header a { color: none; } |
| .ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { |
| border: none; background: none; font-weight: none; color: none; } |
| .ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: black; text-decoration: none; } |
| .ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: none; background: none; font-weight: none; color: none; } |
| |
| .ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: none; background: none; font-weight: none; color: none; } |
| .ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { |
| color: black; text-decoration: none; |
| background: #C6C6C6; /* old browsers */ |
| background: -moz-linear-gradient(top, #C6C6C6 0%, #D8D8D8 100%); /* firefox */ |
| background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#C6C6C6), color-stop(100%,#D8D8D8)); /* webkit */ |
| -webkit-border-radius:15px; -moz-border-radius:10px; |
| border: 1px solid #f1f1f1; |
| } |
| .ui-corner-all { border-radius: 0 0 0 0; } |
| |
| .ui-tabs { padding: .2em;} |
| .ui-tabs .ui-tabs-nav li { top: 0px; margin: -2px 0 1px; text-transform: uppercase; font-size: 10.5px;} |
| .ui-tabs .ui-tabs-nav li a { padding: .25em 2em .25em 1em; margin: .5em; text-shadow: 0 1px 0 rgba(255,255,255,.5); } |
| </style><script type="text/javascript" src="../common/browserDetect.js"></script><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/l10n.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"><a target="_blank" href="#"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt=" Documentation"></img></a><h1>README: Web-based Help from DocBook XML<br></br> </h1><div id="navheader"><table class="navLinks"><tr><td><a id="showHideButton" href="javascript:showHideToc();" class="pointLeft" tabindex="5" title="Hide TOC tree">Sidebar |
| </a></td><td> |
| | |
| <a accesskey="n" class="navLinkNext" tabindex="5" href="ch01.html">Next</a></td></tr></table></div></div><div id="content"><noscript>JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.</noscript><div class="book"><div xmlns="" class="titlepage"> |
| <div> |
| <div><h1 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id275648"></a>README: Web-based Help from DocBook XML</h1></div> |
| <div><div xmlns="http://www.w3.org/1999/xhtml" class="author"><h3 class="author"><span class="firstname">David</span> <span class="surname">Cramer</span></h3><code class="email"><<a class="email" href="mailto:david AT thingbag DOT net">david AT thingbag DOT net</a>></code></div></div> |
| <div><div xmlns="http://www.w3.org/1999/xhtml" class="author"><h3 class="author"><span class="firstname">Kasun</span> <span class="surname">Gajasinghe</span></h3><code class="email"><<a class="email" href="mailto:kasunbg AT gmail DOT com">kasunbg AT gmail DOT com</a>></code></div></div> |
| <div><p xmlns="http://www.w3.org/1999/xhtml" class="copyright">Copyright © 2008-2012 Kasun Gajasinghe, David Cramer</p></div> |
| <div><div xmlns="http://www.w3.org/1999/xhtml" class="legalnotice"><a id="id375193"></a><p>Permission is hereby granted, free of charge, to any person obtaining a copy of this |
| software and associated documentation files (the <span class="quote">“<span class="quote">Software</span>”</span>), to deal in the |
| Software without restriction, including without limitation the rights to use, copy, modify, |
| merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit |
| persons to whom the Software is furnished to do so, subject to the following conditions: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>The above copyright notice and this permission notice shall be included in all |
| copies or substantial portions of the Software.</p></li><li class="listitem"><p>Except as contained in this notice, the names of individuals credited with |
| contribution to this software shall not be used in advertising or otherwise to promote |
| the sale, use or other dealings in this Software without prior written authorization |
| from the individuals in question.</p></li><li class="listitem"><p>Any stylesheet derived from this Software that is publicly distributed will be |
| identified with a different name and the version strings in any derived Software will |
| be changed so that no possibility of confusion between the derived package and this |
| Software will exist.</p></li></ul></div><p><strong>Warranty: </strong>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, |
| INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
| PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY |
| OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
| ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p><p>This package is maintained by Kasun Gajasinghe, <code class="email"><<a class="email" href="mailto:kasunbg AT gmail DOT com">kasunbg AT gmail DOT com</a>></code> |
| and David Cramer, <code class="email"><<a class="email" href="mailto:david AT thingbag DOT net">david AT thingbag DOT net</a>></code>.</p><p>This package also includes the following software written and copyrighted by others:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Files in <code class="filename">template/common/jquery</code> are |
| copyrighted by <a class="ulink" href="http://jquery.com/" target="_top">JQuery</a> under the MIT License. |
| The file <code class="filename">jquery.cookie.js</code> Copyright (c) 2006 Klaus Hartl under |
| the MIT license.</p><a id="id375285" 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 part of |
| N. Quaine's htmlsearch DITA plugin. The htmlsearch DITA plugin is available from the |
| <a class="ulink" href="http://tech.groups.yahoo.com/group/dita-users/files/Demos/" target="_top">files |
| page</a> of the DITA-users yahoogroup. The htmlsearch plugin was released under |
| a BSD-style license. See <code class="filename">indexer/license.txt</code> for details. <a id="id375327" class="indexterm"></a> |
| <a id="id374881" 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 |
| 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 Lucene</a> search |
| engine provides support for tokenizing Chinese, Japanese, and Korean content released |
| under the Apache 2.0 license. </p></li><li class="listitem"><p>Code that provides weighted search results and some |
| other improvements was graciously donated by <a class="ulink" href="http://www.oxygenxml.com" target="_top">SyncRO Soft |
| Ltd.</a>, the publishers of the oXygen XML |
| Editor.</p></li><li class="listitem"><p>Cosmetic improvements provided by <a class="ulink" href="http://docs.openstack.org" target="_top">OpenStack</a>.</p></li></ul></div><p> Webhelp for DocBook was first developed as a <a class="ulink" href="http://code.google.com/soc/" target="_top">Google Summer of Code</a> project. </p></div></div> |
| <div><p xmlns="http://www.w3.org/1999/xhtml" class="pubdate">January 2012</p></div> |
| </div> |
| <hr> |
| </div> |
| <div class="list-of-figures"><p><strong>List of Figures</strong></p><dl><dt>1. <a href="ch02s05.html#id376944">Sample Image</a></dt></dl></div><div class="list-of-examples"><p><strong>List of Examples</strong></p><dl><dt>1. <a href="ch02s05.html#id376967">Example code for adding images. Note down the relative path used</a></dt><dt>2. <a href="ch03s02s01.html#id377526">Add new language to supportedLanguages array</a></dt><dt>3. <a href="ch03s02s01.html#id377581">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></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 id="sidebar"><div id="leftnavigation" style="padding-top:3px;"><div id="tabs"><ul><li><a href="#treeDiv" style="outline:0;" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="#searchDiv" style="outline:0;" tabindex="1" onclick="doSearch()"><span class="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"></img><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li><span class="file"><a href="ch01.html" tabindex="1">Introduction</a></span></li><li><span class="file"><a href="ch02.html" tabindex="1">Using the package</a></span><ul><li><span class="file"><a href="ch02s01.html" tabindex="1">Generating webhelp output</a></span></li><li><span class="file"><a href="ch02s02.html" tabindex="1">Using and customizing the output</a></span><ul><li><span class="file"><a href="ch02s02s01.html" tabindex="1">Recommended Apache configurations</a></span></li></ul></li><li><span class="file"><a href="ch02s03.html" tabindex="1">Search indexing</a></span></li><li><span class="file"><a href="ch02s04.html" tabindex="1">Adding support for other (non-CJKV) languages</a></span></li><li><span class="file"><a href="ch02s05.html" tabindex="1">Adding images</a></span></li></ul></li><li><span class="file"><a href="ch03.html" tabindex="1">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html" tabindex="1">Design</a></span></li><li><span class="file"><a href="ch03s02.html" tabindex="1">Search</a></span><ul><li><span class="file"><a href="ch03s02s01.html" tabindex="1">New Stemmers</a></span></li></ul></li></ul></li><li><span class="file"><a href="ch04.html" tabindex="1">FAQ</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(searchForm);return false" name="searchForm" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="search" class="searchText" tabindex="1"></input> <input onclick="Verifie(searchForm)" type="button" class="searchButton" value="Go" id="doSearch" tabindex="1"></input></center></fieldset></form></div><div id="searchResults"><center></center></div><p class="searchHighlight"><a href="#" onclick="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div></body></html> |
