diff options
author | William Deegan <bill@baddogconsulting.com> | 2015-07-25 19:42:43 -0400 |
---|---|---|
committer | William Deegan <bill@baddogconsulting.com> | 2015-07-25 19:42:43 -0400 |
commit | 687b66ca93f675a1019c12eabe68441cba2318ca (patch) | |
tree | e41ddec022fdf09497b715cac78f4818058a4f5a /src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content | |
download | scons-git-687b66ca93f675a1019c12eabe68441cba2318ca.tar.gz |
merge pull request 236: ajf58: Corrected escaping of less-than and greater-than symbols.
Diffstat (limited to 'src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content')
17 files changed, 2073 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch01.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch01.html new file mode 100644 index 000000000..7edbb5340 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch01.html @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Chapter 1. Introduction</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><meta name="description" content="Overview of the package." /><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML" /><link rel="up" href="index.html" title="README: Web-based Help from DocBook XML" /><link rel="prev" href="index.html" title="README: Web-based Help from DocBook XML" /><link rel="next" href="ch02.html" title="Chapter 2. Using the package" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Chapter 1. Introduction<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">. + </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><a accesskey="p" href="index.html">Prev</a> + | + <a accesskey="n" href="ch02.html">Next</a></td></tr></table></div></div><div id="content"><div class="chapter" title="Chapter 1. Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id36123150"></a>Chapter 1. Introduction</h2></div><div><div class="abstract" title="Abstract"><p class="title"><strong>Abstract</strong></p><p>Overview of the package.</p></div></div></div></div><p>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. <a id="id36123176" class="indexterm"></a> + </p><div class="itemizedlist" title="Features"><p class="title"><strong>Features</strong></p><ul class="itemizedlist" type="disc"><li class="listitem"><p>Full text search.<a id="id36123195" class="indexterm"></a></p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p>Stemming support for English, French, and German. Stemming support can be added + for other languages by implementing a stemmer.<a id="id36123214" class="indexterm"></a></p></li><li class="listitem"><p>Support for Chinese, Japanese, and Korean using code from the Lucene search + engine. </p></li><li class="listitem"><p>Search highlighting shows where the searched for term appears in the results. + Use the <span class="guibutton">H</span> button to toggle the highlighting off and on. + <a id="id36123242" class="indexterm"></a></p></li><li class="listitem"><p>Search results can include brief descriptions of the target.<a id="id36123259" class="indexterm"></a></p></li></ul></div></li><li class="listitem"><p>Table of contents pane with collapsible toc tree.</p></li><li class="listitem"><p>Auto-synchronization of content pane and TOC.</p></li><li class="listitem"><p>TOC and search pane implemented without the use of a frameset.</p></li><li class="listitem"><p>An Ant <code class="filename">build.xml</code> 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.</p></li></ul></div><p> + </p><div class="itemizedlist" title="Possible future enhancements"><p class="title"><strong>Possible future enhancements</strong></p><ul class="itemizedlist" type="disc"><li class="listitem"><p>Move webhelp-specific parameters and gentext strings into base DocBook stylesheets. + </p></li><li class="listitem"><p>Use <code class="sgmltag-attribute">tabindex</code> attributes to control the tab + order in the output. The Contents and Search tabs should be first and second, then the + search box and button, then the table of contents items, and so on.</p></li><li class="listitem"><p>Add "Expand all" and "Collapse all" buttons to the table of contents.</p></li><li class="listitem"><p>Add other search options:</p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p>Add an option to use Lucene for server-side searches with table of contents + state persisted on the server.</p></li><li class="listitem"><p>Add a simple form that uses a Google site:my.domain.com based search.</p></li></ul></div></li><li class="listitem"><p>Sort search results based on relevance</p></li><li class="listitem"><p>Support wild card characters in the search query.</p></li><li class="listitem"><p>Parameterize width of the TOC pane OR make the TOC pane resizeable by the + user.</p></li><li class="listitem"><p>Automate search results summary text:</p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p>Automatically use the first non-heading content as the summary in the search + results.</p></li><li class="listitem"><p>Automatically limit the size of the search description to something 140 + characters.</p></li></ul></div></li><li class="listitem"><p>Support boolean operators in search.</p></li><li class="listitem"><p>Parameterize list of files to exclude from indexing. Currently it's hard coded that + we don't index <code class="filename">index.html </code>and <code class="filename">ix01.html</code> (the + legal notice and index topics). It should be smarter and automatically not index the + index file even if it's not named <code class="filename">ix01.html</code>.</p></li><li class="listitem"><p>Improve performance by moving the table of contents div out of each page and into a + separate JavaScript file which then adds it to the page.</p></li><li class="listitem"><p>Add to the indexer the ability to specify a list of files or file patterns not to + index. Currently it does not index <code class="filename">index.html</code> or + <code class="filename">ix01.html</code>, which is generally appropriate, but it should be up to + the user to decide.</p></li><li class="listitem"><p>Add an index tab populated by a separate JavaScript file. Include a param/property + that allows the content creator to disable the index.</p></li><li class="listitem"><p>Add functionality to the <code class="filename">build.xml</code> file so that when a property + is set, the build generates a pdf version of the document and includes a link to it from + the header.</p></li><li class="listitem"><p>Add <a class="ulink" href="http://www.comparenetworks.com/developers/jqueryplugins/jbreadcrumb.html" target="_top">breadcrumbs</a> so the user will know what topics he's been to.</p></li><li class="listitem"><p>Consider using more advanced Lucene indexers for Chinese and Japanese than the + CJKAnalyzer</p></li></ul></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"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02.html new file mode 100644 index 000000000..d7f7def8b --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02.html @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Chapter 2. Using the package</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="up" href="index.html" title="README: Web-based Help from DocBook XML" /><link rel="prev" href="ch01.html" title="Chapter 1. Introduction" /><link rel="next" href="ch02s01.html" title="Generating webhelp output" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Chapter 2. Using the package<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">. + </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><a accesskey="p" href="ch01.html">Prev</a> + | + <a accesskey="n" href="ch02s01.html">Next</a></td></tr></table></div></div><div id="content"><div class="chapter" title="Chapter 2. Using the package"><div class="titlepage"><div><div><h2 class="title"><a id="id36123631"></a>Chapter 2. Using the package</h2></div></div></div><div class="toc"><p><strong>Contents</strong></p><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></div><p class="summary">The following sections describe how to install and + use the package on Windows.</p></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"><a accesskey="p" href="ch01.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch02s01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s01.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s01.html new file mode 100644 index 000000000..0b7c93078 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s01.html @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Generating webhelp output</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><meta name="description" content="Installation instructions" /><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML" /><link rel="up" href="ch02.html" title="Chapter 2. Using the package" /><link rel="prev" href="ch02.html" title="Chapter 2. Using the package" /><link rel="next" href="ch02s02.html" title="Using and customizing the output" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Generating webhelp output<br />Chapter 2. Using the package</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">. + </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><a accesskey="p" href="ch02.html">Prev</a> + | + <a accesskey="u" href="ch02.html">Up</a> + | + <a accesskey="n" href="ch02s02.html">Next</a></td></tr></table></div></div><div id="content"><div class="section" title="Generating webhelp output"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id36123640"></a>Generating webhelp output</h2></div><div><div class="abstract" title="Abstract"><p class="title"><strong>Abstract</strong></p><p>Installation instructions</p></div></div></div></div><div class="procedure" title="Procedure 2.1. To install the package on Windows"><a id="id36123655"></a><p class="title"><strong>Procedure 2.1. To install the package on Windows</strong></p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The examples in this procedure assume a Windows installation, + but the process is the same in other environments, + <span class="foreignphrase"><em class="foreignphrase">mutatis mutandis</em></span>.</p></div><ol class="procedure" type="1"><li class="step" title="Step 1"><p>If necessary, install <a class="ulink" href="http://www.java.com/en/download/manual.jsp" target="_top">Java 1.6</a> or + higher.</p><ol type="a" class="substeps"><li class="step" title="Step 1.a"><p>Confirm that Java is installed and in your + <code class="envar">PATH</code> by typing the following at a command prompt: + </p><pre class="programlisting">java -version</pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>To build the indexer, you must have the JDK.</p></div></li></ol></li><li class="step" title="Step 2"><p>If necessary, install <a class="ulink" href="http://ant.apache.org/bindownload.cgi" target="_top">Apache Ant</a> 1.6.5 + or higher.</p><ol type="a" class="substeps"><li class="step" title="Step 2.a"><p>Unzip the Ant binary distribution to a convenient location + on your system. For example: <code class="filename">c:\Program + Files</code>.</p></li><li class="step" title="Step 2.b"><p>Set the environment variable <code class="envar">ANT_HOME</code> to + the top-level Ant directory. For example: <code class="filename">c:\Program + Files\apache-ant-1.7.1</code>. </p><div class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>See <a class="ulink" href="http://support.microsoft.com/kb/310519" target="_top">How To Manage + Environment Variables in Windows XP</a> for information + on setting environment variables.</p></div></li><li class="step" title="Step 2.c"><p>Add the Ant <code class="filename">bin</code> directory to your + <code class="envar">PATH</code>. For example: <code class="filename">c:\Program + Files\apache-ant-1.7.1\bin</code></p></li><li class="step" title="Step 2.d"><p>Confirm that Ant is installed by typing the following at a + command prompt: </p><pre class="programlisting">ant -version</pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If you see a message about the file + <code class="filename">tools.jar</code> being missing, you can safely + ignore it.</p></div></li></ol></li><li class="step" title="Step 3"><p>Download <a class="ulink" href="http://prdownloads.sourceforge.net/saxon/saxon6-5-5.zip" target="_top">Saxon + 6.5.x</a> and unzip the distribution to a convenient location on your file system. + You will use the path to <code class="filename">saxon.jar</code> in <a class="xref" href="ch02s01.html#edit-build-properties" title="Step 4">Step 4</a> below.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The <code class="filename">build.xml</code> has only been tested with Saxon 6.5, though + it could be adapted to work with other XSLT processors. However, when you generate + output, the Saxon jar must <span class="bold"><strong>not</strong></span> be in your + <code class="envar">CLASSPATH</code>.</p></div></li><li class="step" title="Step 4"><a id="edit-build-properties"></a><p>In a text editor, edit the + <code class="filename">build.properties</code> file in the webhelp directory + and make the changes indicated by the comments:</p><pre class="programlisting"># The path (relative to the build.xml file) to your input document. +# To use your own input document, create a build.xml file of your own +# and import this build.xml. +input-xml=docsrc/readme.xml + +# The directory in which to put the output files. +# This directory is created if it does not exist. +output-dir=docs + +# If you are using a customization layer that imports webhelp.xsl, use +# this property to point to it. +stylesheet-path=${ant.file.dir}/xsl/webhelp.xsl + +# If your document has image directories that need to be copied +# to the output directory, you can list patterns here. +# See the Ant documentation for fileset for documentation +# on patterns. +#input-images-dirs=images/**,figures/**,graphics/** + +# By default, the ant script assumes your images are stored +# in the same directory as the input-xml. If you store your +# image directories in another directory, specify it here. +# and uncomment this line. +#input-images-basedir=/path/to/image/location + +# Modify this so that it points to your copy of the Saxon 6.5 jar. +xslt-processor-classpath=/usr/share/java/saxon-6.5.5.jar + +# For non-ns version only, this validates the document +# against a dtd. +validate-against-dtd=true + +# Set this to false if you don't need a search tab. +webhelp.include.search.tab=true + +# 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, fr=French, de=German, +# zh=Chinese, ja=Japanese etc. +webhelp.indexer.language=en</pre></li><li class="step" title="Step 5"><p>Test the package by running the command <code class="code">ant webhelp + -Doutput-dir=test-ouput</code> at the command line in the webhelp directory. It should + generate a copy of this documentation in the <code class="filename">doc</code> + directory. Type <code class="code">start test-output\index.html</code> to open the output in a + browser. Once you have confirmed that the process worked, you can delete the <code class="filename">test-output</code> directory. </p><div class="important" title="Important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>The Saxon 6.5 jar should <span class="emphasis"><em>not</em></span> be in your + <code class="envar">CLASSPATH</code> when you generate the webhelp output. If you have any + problems, try running ant with an empty <code class="envar">CLASSPATH</code>.</p></div></li><li class="step" title="Step 6"><p>To process your own document, simply refer to this package + from another <code class="filename">build.xml</code> in arbitrary location on + your system:</p><ol type="a" class="substeps"><li class="step" title="Step 6.a"><p>Create a new <code class="filename">build.xml</code> file that + defines the name of your source file, the desired output + directory, and imports the <code class="filename">build.xml</code> from + this package. For example: </p><pre class="programlisting"><project> + <property name="input-xml" value="<em class="replaceable"><code>path-to/yourfile.xml</code></em>"/> + <property name="input-images-dirs" value="<em class="replaceable"><code>images/** figures/** graphics/**</code></em>"/> + <property name="output-dir" value="<em class="replaceable"><code>path-to/desired-output-dir</code></em>"/> + <import file="<em class="replaceable"><code>path-to/docbook-webhelp/</code></em>build.xml"/> +</project></pre></li><li class="step" title="Step 6.b"><p>From the directory containing your newly created + <code class="filename">build.xml</code> file, type <code class="code">ant + webhelp</code> to build your document.</p><div class="important" title="Important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>The Saxon 6.5 jar should <span class="emphasis"><em>not</em></span> be in your + <code class="envar">CLASSPATH</code> when you generate the webhelp output. If you have any + problems, try running ant with an empty <code class="envar">CLASSPATH</code>.</p></div></li></ol></li></ol></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"><a accesskey="p" href="ch02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s02.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s02.html new file mode 100644 index 000000000..091e67c78 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s02.html @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Using and customizing the output</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="up" href="ch02.html" title="Chapter 2. Using the package" /><link rel="prev" href="ch02s01.html" title="Generating webhelp output" /><link rel="next" href="ch02s03.html" title="Building the indexer" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Using and customizing the output<br />Chapter 2. Using the package</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">. + </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><a accesskey="p" href="ch02s01.html">Prev</a> + | + <a accesskey="u" href="ch02.html">Up</a> + | + <a accesskey="n" href="ch02s03.html">Next</a></td></tr></table></div></div><div id="content"><div class="section" title="Using and customizing the output"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id36124011"></a>Using and customizing the output</h2></div></div></div><p>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. </p><div class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>See <a class="ulink" href="http://www.sagehill.net/docbookxsl/Chunking.html" target="_top">Chunking into + multiple HTML files</a> in Bob Stayton's <a class="ulink" href="http://www.sagehill.net/docbookxsl/index.html" target="_top">DocBook XSL: The + Complete Guide</a> for information on controlling output file + names and which files are chunked in DocBook.</p></div><p>When you perform a search, the results can include brief + summaries. These are populated in one of two ways:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>By adding <code class="sgmltag-element">role="summary"</code> to a + <code class="sgmltag-element">para</code> or <code class="sgmltag-element">phrase</code> in the + <code class="sgmltag-element">chapter</code> or <code class="sgmltag-element">section</code>.</p></li><li class="listitem"><p>By adding an <code class="sgmltag-element">abstract</code> to the + <code class="sgmltag-element">chapterinfo</code> or <code class="sgmltag-element">sectioninfo</code> + element.</p></li></ul></div><p>To customize the look and feel of the help, study the following + css files:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="filename">docs/common/css/positioning.css</code>: This + handles the Positioning of DIVs in appropriate positions. For + example, it causes the <code class="code">leftnavigation</code> div to appear + on the left, the header on top, and so on. Use this if you need to + change the relative positions or need to change the width/height + etc.</p></li><li class="listitem"><p><code class="filename">docs/common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css</code>: + This is the theming part which adds colors and stuff. This is a + default theme comes with <a class="ulink" href="http://jqueryui.com/download" target="_top">jqueryui</a> unchanged. You + can get any theme based your interest from this. (Themes are on + right navigation bar.) Then replace the css theme folder + (theme-redmond) with it, and change the xsl to point to the new + css.</p></li><li class="listitem"><p><code class="filename">docs/common/jquery/treeview/jquery.treeview.css</code>: + This styles the toc Tree. Generally, you don't have to edit this + file.</p></li></ul></div><div class="section" title="Recommended Apache configurations"><div class="titlepage"><div><div><h3 class="title"><a id="id36124136"></a>Recommended Apache configurations</h3></div></div></div><p>If you are serving a long document from an Apache web server, we + recommend you make the following additions or changes to your + <code class="filename">httpd.conf</code> or <code class="filename">.htaccess</code> + file. <em><span class="remark">TODO: Explain what each thing + does.</span></em></p><pre class="programlisting">AddDefaultCharSet UTF-8 # <a id="AddDefaultCharSet"></a><img src="images/callouts/1.png" alt="1" border="0" /> + + # 480 weeks + <FilesMatch "\.(ico|pdf|flv|jpg|jpeg|png|gif|js|css|swf)$"> # <a id="CachingSettings"></a><img src="images/callouts/2.png" alt="2" border="0" /> + Header set Cache-Control "max-age=290304000, public" + </FilesMatch> + + # 2 DAYS + <FilesMatch "\.(xml|txt)$"> + Header set Cache-Control "max-age=172800, public, must-revalidate" + </FilesMatch> + + # 2 HOURS + <FilesMatch "\.(html|htm)$"> + Header set Cache-Control "max-age=7200, must-revalidate" + </FilesMatch> + + # compress text, html, javascript, css, xml: + AddOutputFilterByType DEFLATE text/plain # <a id="CompressSetting"></a><img src="images/callouts/3.png" alt="3" border="0" /> + AddOutputFilterByType DEFLATE text/html + AddOutputFilterByType DEFLATE text/xml + AddOutputFilterByType DEFLATE text/css + AddOutputFilterByType DEFLATE application/xml + AddOutputFilterByType DEFLATE application/xhtml+xml + AddOutputFilterByType DEFLATE application/rss+xml + AddOutputFilterByType DEFLATE application/javascript + AddOutputFilterByType DEFLATE application/x-javascript + + # Or, compress certain file types by extension: + <Files *.html> + SetOutputFilter DEFLATE + </Files> + </pre><div class="calloutlist"><table border="0" summary="Callout list"><tr><td width="5%" valign="top" align="left"><p><a href="#AddDefaultCharSet"><img src="images/callouts/1.png" alt="1" border="0" /></a> </p></td><td valign="top" align="left"><p>See <a class="ulink" href="http://www.sagehill.net/docbookxsl/SpecialChars.html" target="_top">Odd + characters in HTML output</a> in Bob Stayton's book + <em class="citetitle">DocBook XSL: The Complete Guide</em> for more + information about this setting.</p></td></tr><tr><td width="5%" valign="top" align="left"><p><a href="#CachingSettings"><img src="images/callouts/2.png" alt="2" border="0" /></a> </p></td><td valign="top" align="left"><p>These lines and those that follow cause the browser to + cache various resources such as bitmaps and JavaScript files. + Note that caching JavaScript files could cause your users to + have stale search indexes if you update your document since the + search index is stored in JavaScript files.</p></td></tr><tr><td width="5%" valign="top" align="left"><p><a href="#CompressSetting"><img src="images/callouts/3.png" alt="3" border="0" /></a> </p></td><td valign="top" align="left"><p>These lines cause the the server to compress html, css, + and JavaScript files and the brower to uncompress them to + improve download performance.</p></td></tr></table></div></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"><a accesskey="p" href="ch02s01.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s03.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s03.html new file mode 100644 index 000000000..4e0efdeb4 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s03.html @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Building the indexer</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="up" href="ch02.html" title="Chapter 2. Using the package" /><link rel="prev" href="ch02s02.html" title="Using and customizing the output" /><link rel="next" href="ch02s04.html" title="Adding support for other (non-CJKV) languages" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Building the indexer<br />Chapter 2. Using the package</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">. + </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><a accesskey="p" href="ch02s02.html">Prev</a> + | + <a accesskey="u" href="ch02.html">Up</a> + | + <a accesskey="n" href="ch02s04.html">Next</a></td></tr></table></div></div><div id="content"><div class="section" title="Building the indexer"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id36124227"></a>Building the indexer</h2></div></div></div><p class="summary">To build the indexer, you must have installed the + JDK version 1.5 or higher and set the <code class="envar">ANT_HOME</code> + environment variable. Run <code class="code">ant build-indexer</code> to recompile + <code class="filename">nw-cms.jar</code></p><a id="id36124248" class="indexterm"></a><a id="id36124257" class="indexterm"></a></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"><a accesskey="p" href="ch02s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s04.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s04.html new file mode 100644 index 000000000..d3ba7e838 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch02s04.html @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Adding support for other (non-CJKV) languages</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="up" href="ch02.html" title="Chapter 2. Using the package" /><link rel="prev" href="ch02s03.html" title="Building the indexer" /><link rel="next" href="ch03.html" title="Chapter 3. Developer Docs" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Adding support for other (non-CJKV) languages<br />Chapter 2. Using the package</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">. + </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><a accesskey="p" href="ch02s03.html">Prev</a> + | + <a accesskey="u" href="ch02.html">Up</a> + | + <a accesskey="n" href="ch03.html">Next</a></td></tr></table></div></div><div id="content"><div class="section" title="Adding support for other (non-CJKV) languages"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id36124269"></a>Adding support for other (non-CJKV) languages</h2></div></div></div><p>To support stemming for a language, the search mechanism requires + a stemmer implemented in both Java and JavaScript. The Java version is + used by the indexer and the JavaScript verison is used to stem the + user's input on the search form. Currently the search mechanism supports + stemming for English and German. In addition, Java stemmers are included + for the following languages. Therefore, to support these languages, you + only need to implement the stemmer in JavaScript and add it to the + template. If you do undertake this task, please consider contributing + the JavaScript version back to this project and to <a class="ulink" href="http://snowball.tartarus.org/texts/stemmersoverview.html" target="_top">Martin + Porter's project</a>.</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Danish</p></li><li class="listitem"><p>Dutch</p></li><li class="listitem"><p>Finnish</p></li><li class="listitem"><p>Hungarian</p></li><li class="listitem"><p>Italian</p></li><li class="listitem"><p>Norwegian</p></li><li class="listitem"><p>Portuguese</p></li><li class="listitem"><p>Romanian</p></li><li class="listitem"><p>Russian</p></li><li class="listitem"><p>Spanish</p></li><li class="listitem"><p>Swedish</p></li><li class="listitem"><p>Turkish</p></li></ul></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"><a accesskey="p" href="ch02s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03.html new file mode 100644 index 000000000..0e608fdc5 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03.html @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Chapter 3. Developer Docs</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="up" href="index.html" title="README: Web-based Help from DocBook XML" /><link rel="prev" href="ch02s04.html" title="Adding support for other (non-CJKV) languages" /><link rel="next" href="ch03s01.html" title="Design" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Chapter 3. Developer Docs<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">. + </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><a accesskey="p" href="ch02s04.html">Prev</a> + | + <a accesskey="n" href="ch03s01.html">Next</a></td></tr></table></div></div><div id="content"><div class="chapter" title="Chapter 3. Developer Docs"><div class="titlepage"><div><div><h2 class="title"><a id="id36124370"></a>Chapter 3. Developer Docs</h2></div></div></div><div class="toc"><p><strong>Contents</strong></p><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></div><p class="summary">This chapter provides an overview of how webhelp is implemented.</p><p>The table of contents and search panes are implemented as divs and + rendered as if they were the left pane in a frameset. As a result, the + page must save the state of the table of contents and the search in + cookies when you navigate away from a page. When you load a new page, the + page reads these cookies and restores the state of the table of contents + tree and search. The result is that the help system behaves exactly as if + it were a frameset.</p></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"><a accesskey="p" href="ch02s04.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch03s01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03s01.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03s01.html new file mode 100644 index 000000000..f41f8019f --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03s01.html @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Design</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="up" href="ch03.html" title="Chapter 3. Developer Docs" /><link rel="prev" href="ch03.html" title="Chapter 3. Developer Docs" /><link rel="next" href="ch03s02.html" title="Search" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Design<br />Chapter 3. Developer Docs</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">. + </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><a accesskey="p" href="ch03.html">Prev</a> + | + <a accesskey="u" href="ch03.html">Up</a> + | + <a accesskey="n" href="ch03s02.html">Next</a></td></tr></table></div></div><div id="content"><div class="section" title="Design"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id36124388"></a>Design</h2></div></div></div><p class="summary">An overview of webhelp page structure.</p><p>DocBook WebHelp page structure is fully built on css-based design + abandoning frameset structure. Overall page structure can be divided in to three main sections + </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Header: Header is a separate Div which include company logo, + navigation button(prev, next etc.), page title and heading of parent topic.</p></li><li class="listitem"><p>Content: This includes the content of the documentation. The processing of this part is + done by <a class="ulink" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/chunk.xsl" target="_top"> + DocBook XSL Chunking customization</a>. Few further css-styling applied from + <code class="filename">positioning.css</code>. + </p></li><li class="listitem"><p>Left Navigation: This includes the table of contents and search tab. This + is customized using <a class="ulink" href="http://jqueryui.com/" target="_top">jquery-ui</a> styling.</p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p>Tabbed Navigation: The navigation pane is organized in to two tabs. + Contents tab, and Search tab. Tabbed output is achieved using + <a class="ulink" href="http://docs.jquery.com/UI/Tabs" target="_top">JQuery Tabs plugin</a>. + </p></li><li class="listitem"><p>Table of Contents (TOC) tree: When building the chunked html from the + docbook file, Table of Contents is generated as an Unordered List (a list + made from <code class="code"><ul> <li></code> tags). When page loads in the browser, + we apply styling to it to achieve the nice look that you see. Styling for TOC + tree is done by a JQuery UI plugin called + <a class="ulink" href="http://bassistance.de/jquery-plugins/jquery-plugin-treeview/" target="_top"> + TreeView</a>. We can generate the tree easily by following javascript code: + +</p><pre class="programlisting"> +//Generate the tree +$("#tree").treeview({ +collapsed: true, +animated: "medium", +control: "#sidetreecontrol", +persist: "cookie" +}); +</pre><p> + </p></li><li class="listitem"><p>Search Tab: This includes the search feature.</p></li></ul></div></li></ul></div><p> + </p></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"><a accesskey="p" href="ch03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03s02.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03s02.html new file mode 100644 index 000000000..c4ba87291 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/ch03s02.html @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<title>Search</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="up" href="ch03.html" title="Chapter 3. Developer Docs" /><link rel="prev" href="ch03s01.html" title="Design" /><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">Search<br />Chapter 3. Developer Docs</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">. + </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><a accesskey="p" href="ch03s01.html">Prev</a> + | + <a accesskey="u" href="ch03.html">Up</a></td></tr></table></div></div><div id="content"><div class="section" title="Search"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id36124495"></a>Search</h2></div></div></div><p class="summary">Overview design of Search mechanism.</p><p> + The searching is a fully client-side implementation of querying texts for + content searching, and no server is involved. That means when a user enters a query, + it is processed by JavaScript inside the browser, and displays the matching results by + comparing the query with a generated 'index', which too reside in the client-side web browser. + + Mainly the search mechanism has two parts. + </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Indexing: First we need to traverse the content in the docs/content folder and index + the words in it. This is done by <code class="filename">nw-cms.jar</code>. You can invoke it by + <code class="code">ant index</code> command from the root of webhelp of directory. You can recompile it + again and build the jar file by <code class="code">ant build-indexer</code>. Indexer has some extensive + support for such as stemming of words. Indexer has extensive support for English, German, + French languages. By extensive support, what I meant is that those texts are stemmed + first, to get the root word and then indexes them. For CJK (Chinese, Japanese, Korean) + languages, it uses bi-gram tokenizing to break up the words. (CJK languages does not have + spaces between words.) + </p><p> + When we run <code class="code">ant index</code>, it generates five output files: + </p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p><code class="filename">htmlFileList.js</code> - This contains an array named <code class="code">fl</code> which stores details + all the files indexed by the indexer. + </p></li><li class="listitem"><p><code class="filename">htmlFileInfoList.js</code> - This includes some meta data about the indexed files in an array + named <code class="code">fil</code>. It includes details about file name, file (html) title, a summary + of the content.Format would look like, + <code class="code">fil["4"]= "ch03.html@@@Developer Docs@@@This chapter provides an overview of how webhelp is implemented.";</code> + </p></li><li class="listitem"><p><code class="filename">index-*.js</code> (Three index files) - These three files actually stores the index of the content. + Index is added to an array named <code class="code">w</code>.</p></li></ul></div><p> + + </p></li><li class="listitem"><p> + Querying: Query processing happens totally in client side. Following JavaScript files handles them. + </p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p><code class="filename">nwSearchFnt.js</code> - This handles the user query and returns the search results. It does query + word tokenizing, drop unnecessary punctuations and common words, do stemming if docbook language + supports it, etc.</p></li><li class="listitem"><p><code class="filename">{$indexer-language-code}_stemmer.js</code> - This includes the stemming library. + <code class="filename">nwSearchFnt.js</code> file calls <code class="code">stemmer</code> method in this file for stemming. + ex: <code class="code">var stem = stemmer(foobar);</code> + </p></li></ul></div><p> + </p></li></ul></div><p> + </p><div class="section" title="New Stemmers"><div class="titlepage"><div><div><h3 class="title"><a id="id36124646"></a>New Stemmers</h3></div></div></div><p class="summary">Adding new Stemmers is very simple.</p><p>Currently, only English, French, and German stemmers are integrated in to WebHelp. But the code is + extensible such that you can add new stemmers easily by few steps.</p><p>What you need: + </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>You'll need two versions of the stemmer; One written in JavaScript, and another in Java. But fortunately, + Snowball contains Java stemmers for number of popular languages, and are already included with the package. + You can see the full list in <a class="ulink" href="ch02s04.html" target="_top">Adding support for other (non-CJKV) languages</a>. + If your language is listed there, + Then you have to find javascript version of the stemmer. Generally, new stemmers are getting added in to + <a class="ulink" href="http://snowball.tartarus.org/otherlangs/index.html" target="_top">Snowball Stemmers in other languages</a> location. + If javascript stemmer for your language is available, then download it. Else, you can write a new stemmer in + JavaScript using SnowBall algorithm fairly easily. Algorithms are at + <a class="ulink" href="http://snowball.tartarus.org/" target="_top">Snowball</a>. + </p></li><li class="listitem"><p>Then, name the JS stemmer exactly like this: <code class="filename">{$language-code}_stemmer.js</code>. For example, + for Italian(it), name it as, <code class="filename">it_stemmer.js</code>. Then, copy it to the + <code class="filename">docbook-webhelp/template/content/search/stemmers/</code> folder. (I assumed + <code class="filename">docbook-webhelp</code> is the root folder for webhelp.) + </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Make sure you changed the <code class="code">webhelp.indexer.language</code> property in <code class="filename">build.properties</code> + to your language. + </p></div><p> + + </p></li><li class="listitem"><p>Now two easy changes needed for the indexer.</p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p>Open <code class="filename">docbook-webhelp/indexer/src/com/nexwave/nquindexer/IndexerTask.java</code> in + a text editor and add your language code to the <code class="code">supportedLanguages</code> String Array. </p><div class="example"><a id="id36124759"></a><p class="title"><strong>Example 3.1. Add new language to supportedLanguages array</strong></p><div class="example-contents"><p> + change the Array from, +</p><pre class="programlisting"> +private String[] supportedLanguages= {"en", "de", "fr", "cn", "ja", "ko"}; + //currently extended support available for + // English, German, French and CJK (Chinese, Japanese, Korean) languages only. +</pre><p> + To,</p><pre class="programlisting"> +private String[] supportedLanguages= {"en", "de", "fr", "cn", "ja", "ko", <span class="emphasis"><em>"it"</em></span>}; + //currently extended support available for + // English, German, French, CJK (Chinese, Japanese, Korean), and Italian languages only. + </pre></div></div><br class="example-break" /></li><li class="listitem"><p> + Now, open <code class="filename">docbook-webhelp/indexer/src/com/nexwave/nquindexer/SaxHTMLIndex.java</code> and + add the following line to the code where it initializes the Stemmer (Search for + <code class="code">SnowballStemmer stemmer;</code>). Then add code to initialize the stemmer Object in your language. + It's self understandable. See the example. The class names are at: + <code class="filename">docbook-webhelp/indexer/src/com/nexwave/stemmer/snowball/ext/</code>. + </p><div class="example"><a id="id36124809"></a><p class="title"><strong>Example 3.2. initialize correct stemmer based on the <code class="code">webhelp.indexer.language</code> specified</strong></p><div class="example-contents"><pre class="programlisting"> + SnowballStemmer stemmer; + if(indexerLanguage.equalsIgnoreCase("en")){ + stemmer = new EnglishStemmer(); + } else if (indexerLanguage.equalsIgnoreCase("de")){ + stemmer= new GermanStemmer(); + } else if (indexerLanguage.equalsIgnoreCase("fr")){ + stemmer= new FrenchStemmer(); + } +<span class="emphasis"><em>else if (indexerLanguage.equalsIgnoreCase("it")){ //If language code is "it" (Italian) + stemmer= new italianStemmer(); //Initialize the stemmer to <code class="code">italianStemmer</code> object. + } </em></span> + else { + stemmer = null; + } +</pre></div></div><br class="example-break" /></li></ul></div></li></ul></div><p> + </p><p>That's all. Now run <code class="code">ant build-indexer</code> to compile and build the java code. + Then, run <code class="code">ant webhelp</code> to generate the output from your docbook file. + For any questions, contact us or email to the docbook mailing list + <code class="email"><<a class="email" href="mailto:docbook-apps@lists.oasis-open.org">docbook-apps@lists.oasis-open.org</a>></code>. + </p></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"><a accesskey="p" href="ch03s01.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03.html">Up</a></td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </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 id="webhelp-currentid"><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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/index.html b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/index.html new file mode 100644 index 000000000..54ae64254 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/index.html @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!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" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:db="http://docbook.org/ns/docbook"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7" /> +<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"> + //The id for tree cookie + var treeCookieId = "treeview-897"; + 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 = "Your browser is not supported. Use of Mozilla Firefox is recommended."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><style type="text/css"> + 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; + } + </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">. + </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> + | + <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"><<a class="email" href="mailto:dcramer AT motive DOT com">dcramer AT motive DOT com</a>></code><code class="email"><<a class="email" href="mailto:david AT thingbag DOT net">david AT thingbag DOT net</a>></code></div></div><div><div 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 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 + 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" 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 title="Warranty:"><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" 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="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 + 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="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 + 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></ul></div><p> + Webhelp for DocBook was developed as a <a class="ulink" href="http://socghop.appspot.com" target="_top">Google Summer of Code</a> project. + </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" /> <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> diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/htmlFileInfoList.js b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/htmlFileInfoList.js new file mode 100644 index 000000000..4517cb8c6 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/htmlFileInfoList.js @@ -0,0 +1,10 @@ +fil = new Array(); +fil["0"]= "ch01.html@@@Chapter 1. Introduction@@@Overview of the package."; +fil["1"]= "ch02.html@@@Chapter 2. Using the package@@@The following sections describe how to install and use the package on Windows."; +fil["2"]= "ch02s01.html@@@Generating webhelp output@@@Installation instructions"; +fil["3"]= "ch02s02.html@@@Using and customizing the output@@@null"; +fil["4"]= "ch02s03.html@@@Building the indexer@@@To build the indexer, you must have installed the JDK version 1.5 or higher and set the ANT_HOME environment variable. Run ant build-indexer to recompile nw-cms.jar"; +fil["5"]= "ch02s04.html@@@Adding support for other (non-CJKV) languages@@@null"; +fil["6"]= "ch03.html@@@Chapter 3. Developer Docs@@@This chapter provides an overview of how webhelp is implemented."; +fil["7"]= "ch03s01.html@@@Design@@@An overview of webhelp page structure."; +fil["8"]= "ch03s02.html@@@Search@@@Adding new Stemmers is very simple."; diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/htmlFileList.js b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/htmlFileList.js new file mode 100644 index 000000000..c09eccf40 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/htmlFileList.js @@ -0,0 +1,11 @@ +//List of files which are indexed. +fl = new Array(); +fl["0"]= "ch01.html"; +fl["1"]= "ch02.html"; +fl["2"]= "ch02s01.html"; +fl["3"]= "ch02s02.html"; +fl["4"]= "ch02s03.html"; +fl["5"]= "ch02s04.html"; +fl["6"]= "ch03.html"; +fl["7"]= "ch03s01.html"; +fl["8"]= "ch03s02.html"; diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-1.js b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-1.js new file mode 100644 index 000000000..8af5f1e15 --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-1.js @@ -0,0 +1,224 @@ +var indexerLanguage="en"; +//Auto generated index for searching. +w["-"]="8"; +w["-doutput-dir"]="2"; +w["-version"]="2"; +w["1"]="0,2,4,8"; +w["140"]="0"; +w["172800"]="3"; +w["2"]="1,2,3,8"; +w["290304000"]="3"; +w["3"]="6,8"; +w["4"]="2,8"; +w["480"]="3"; +w["5"]="2,4"; +w["6"]="2"; +w["7"]="2"; +w["7200"]="3"; +w["8"]="3"; +w["_stemmer"]="8"; +w["abandon"]="7"; +w["abil"]="0"; +w["abstract"]="0,2,3"; +w["achiev"]="7"; +w["actual"]="8"; +w["ad"]="0,1,3,5,8"; +w["adapt"]="2"; +w["add"]="0,2,3,5,8"; +w["adddefaultcharset"]="3"; +w["addit"]="3,5"; +w["addoutputfilterbytyp"]="3"; +w["advanc"]="0"; +w["again"]="8"; +w["against"]="2"; +w["algorithm"]="8"; +w["all"]="0,8"; +w["allow"]="0"; +w["alreadi"]="8"; +w["and"]="0,1,2,3,4,5,6,7,8"; +w["ani"]="2,3,8"; +w["anim"]="7"; +w["anoth"]="2,8"; +w["ant"]="0,2,4,8"; +w["ant_hom"]="2,4"; +w["apach"]="1,2,3"; +w["apache-ant-1"]="2"; +w["appear"]="0,3"; +w["appli"]="7"; +w["applic"]="0,3"; +w["appropri"]="0,3"; +w["arbitrari"]="2"; +w["array"]="8"; +w["assum"]="2,8"; +w["attribut"]="0"; +w["auto-synchron"]="0"; +w["autom"]="0"; +w["automat"]="0"; +w["avail"]="8"; +w["away"]="6"; +w["back"]="5"; +w["bar"]="3"; +w["base"]="0,3,8"; +w["be"]="2"; +w["been"]="0,2"; +w["behav"]="6"; +w["below"]="2"; +w["between"]="8"; +w["bi-gram"]="8"; +w["bin"]="2"; +w["binari"]="2"; +w["bitmap"]="3"; +w["bob"]="3"; +w["book"]="3"; +w["boolean"]="0"; +w["both"]="5"; +w["box"]="0"; +w["breadcrumb"]="0"; +w["break"]="8"; +w["brief"]="0,3"; +w["brower"]="3"; +w["browser"]="2,3,7,8"; +w["build"]="0,1,2,4,7,8"; +w["build-index"]="4,8"; +w["built"]="7"; +w["but"]="0,2,8"; +w["button"]="0,7"; +w["c"]="2"; +w["cach"]="3"; +w["cache-control"]="3"; +w["call"]="7,8"; +w["can"]="0,2,3,7,8"; +w["card"]="0"; +w["caus"]="3"; +w["certain"]="3"; +w["ch03"]="8"; +w["chang"]="2,3,8"; +w["chapter"]="0,1,3,6,8"; +w["chapterinfo"]="3"; +w["charact"]="0,3"; +w["chines"]="0,2,8"; +w["chm"]="0"; +w["chunk"]="3,7"; +w["cjk"]="8"; +w["cjkanalyz"]="0"; +w["class"]="8"; +w["classpath"]="2"; +w["client"]="8"; +w["client-sid"]="8"; +w["cn"]="8"; +w["code"]="0,7,8"; +w["collaps"]="0,7"; +w["color"]="3"; +w["come"]="3"; +w["command"]="2,8"; +w["comment"]="2"; +w["common"]="0,3,8"; +w["compani"]="7"; +w["compar"]="8"; +w["compil"]="8"; +w["complet"]="3"; +w["compress"]="3"; +w["conf"]="3"; +w["configur"]="1,3"; +w["confirm"]="2"; +w["consid"]="0,5"; +w["contact"]="8"; +w["contain"]="2,8"; +w["content"]="0,1,6,7,8"; +w["contribut"]="5"; +w["control"]="0,3,7"; +w["conveni"]="2"; +w["cooki"]="6,7"; +w["copi"]="2,8"; +w["correct"]="2,8"; +w["could"]="2,3"; +w["creat"]="2"; +w["creator"]="0"; +w["css"]="3,7"; +w["css-base"]="7"; +w["css-style"]="7"; +w["current"]="0,5,8"; +w["custom"]="1,2,3,7"; +w["danish"]="5"; +w["data"]="8"; +w["day"]="3"; +w["decid"]="0"; +w["deep"]="3"; +w["default"]="2,3"; +w["defin"]="2"; +w["deflat"]="3"; +w["delet"]="2"; +w["describ"]="1"; +w["descript"]="0"; +w["design"]="6,7,8"; +w["desir"]="2"; +w["desired-output-dir"]="2"; +w["detail"]="2,8"; +w["develop"]="6"; +w["differ"]="2"; +w["dir"]="2"; +w["direct"]="3"; +w["directori"]="2,8"; +w["disabl"]="0"; +w["display"]="8"; +w["distribut"]="2"; +w["div"]="0,3,6,7"; +w["divid"]="7"; +w["do"]="5,8"; +w["doc"]="2,3,6,8"; +w["docbook"]="0,2,3,7,8"; +w["docbook-apps@list"]="8"; +w["docbook-webhelp"]="2,8"; +w["docs@@@"]="8"; +w["docsrc"]="2"; +w["document"]="0,2,3,7"; +w["doe"]="0,2,3,8"; +w["domain"]="0"; +w["don"]="0,2,3"; +w["done"]="7,8"; +w["download"]="2,3,8"; +w["drop"]="8"; +w["dtd"]="2"; +w["dutch"]="5"; +w["each"]="0,3"; +w["easi"]="8"; +w["easili"]="7,8"; +w["eclips"]="0"; +w["edit"]="2,3"; +w["editor"]="2,8"; +w["element"]="3"; +w["els"]="8"; +w["email"]="8"; +w["empti"]="2"; +w["engin"]="0"; +w["english"]="0,2,5,8"; +w["englishstemm"]="8"; +w["enhanc"]="0"; +w["enter"]="8"; +w["environ"]="2,4"; +w["equalsignorecas"]="8"; +w["etc"]="2,3,7,8"; +w["even"]="0"; +w["ex"]="8"; +w["exact"]="6,8"; +w["exampl"]="2,3,8"; +w["exclud"]="0"; +w["exist"]="2"; +w["expand"]="0"; +w["explain"]="3"; +w["expos"]="0"; +w["ext"]="8"; +w["extend"]="8"; +w["extens"]="3,8"; +w["fair"]="8"; +w["fals"]="2"; +w["featur"]="0,7"; +w["feel"]="3"; +w["few"]="7,8"; +w["figur"]="2"; +w["fil"]="8"; +w["file"]="0,2,3,7,8"; +w["fileset"]="2"; +w["filesmatch"]="3"; +w["find"]="8"; + diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-2.js b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-2.js new file mode 100644 index 000000000..ebab2194f --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-2.js @@ -0,0 +1,223 @@ +//Auto generated index for searching. +w["finnish"]="5"; +w["first"]="0,8"; +w["five"]="8"; +w["fl"]="8"; +w["flv"]="3"; +w["folder"]="3,8"; +w["follow"]="1,2,3,5,7,8"; +w["foobar"]="8"; +w["form"]="0,5"; +w["format"]="0,8"; +w["fortun"]="8"; +w["fr"]="2,8"; +w["frameset"]="0,3,6,7"; +w["french"]="0,2,8"; +w["frenchstemm"]="8"; +w["full"]="0,8"; +w["fulli"]="7,8"; +w["function"]="0"; +w["further"]="3,7"; +w["futur"]="0"; +w["general"]="0,3,8"; +w["generat"]="0,1,2,7,8"; +w["gentext"]="0"; +w["german"]="0,2,5,8"; +w["germanstemm"]="8"; +w["get"]="0,3,8"; +w["gif"]="3"; +w["googl"]="0"; +w["graphic"]="2"; +w["group"]="0"; +w["guid"]="3"; +w["h"]="0"; +w["handl"]="3,8"; +w["happen"]="8"; +w["hard"]="0"; +w["has"]="2,8"; +w["have"]="2,3,4,8"; +w["he"]="0"; +w["head"]="7"; +w["header"]="0,3,7"; +w["height"]="3"; +w["help"]="0,3,6"; +w["here"]="2"; +w["higher"]="2,4"; +w["highlight"]="0"; +w["hour"]="3"; +w["howev"]="2"; +w["htaccess"]="3"; +w["htm"]="3"; +w["html"]="0,2,3,7,8"; +w["html@@@develop"]="8"; +w["htmlfileinfolist"]="8"; +w["htmlfilelist"]="8"; +w["httpd"]="3"; +w["hungarian"]="5"; +w["ico"]="3"; +w["identifi"]="2"; +w["if"]="0,2,3,5,6,8"; +w["ignor"]="2"; +w["imag"]="2"; +w["implement"]="0,5,6,8"; +w["import"]="0,2"; +w["imposs"]="0"; +w["improv"]="0,3"; +w["includ"]="0,2,3,5,7,8"; +w["index"]="0,1,2,3,4,5,8"; +w["index-"]="8"; +w["indexer-languag"]="2"; +w["indexer-language-cod"]="8"; +w["indexerlanguag"]="8"; +w["indexertask"]="8"; +w["indic"]="2"; +w["inform"]="2,3"; +w["initi"]="8"; +w["input"]="2,5"; +w["input-images-basedir"]="2"; +w["input-images-dir"]="2"; +w["input-xml"]="2"; +w["insid"]="3,8"; +w["instal"]="1,2,4"; +w["instruct"]="2"; +w["integr"]="0,8"; +w["interest"]="3"; +w["internet"]="0"; +w["into"]="0,3"; +w["introduct"]="0"; +w["invok"]="8"; +w["involv"]="8"; +w["it_stemm"]="8"; +w["italian"]="5,8"; +w["italianstemm"]="8"; +w["item"]="0"; +w["ix01"]="0"; +w["ja"]="2,8"; +w["japanes"]="0,2,8"; +w["jar"]="2,4,8"; +w["java"]="2,5,8"; +w["javascript"]="0,3,5,7,8"; +w["jdk"]="2,4"; +w["jpeg"]="3"; +w["jpg"]="3"; +w["jqueri"]="3,7"; +w["jquery-ui"]="7"; +w["jquery-ui-1"]="3"; +w["jqueryui"]="3"; +w["js"]="3,8"; +w["know"]="0"; +w["ko"]="8"; +w["korean"]="0,8"; +w["languag"]="0,1,2,5,8"; +w["language-cod"]="8"; +w["layer"]="2"; +w["left"]="3,6,7"; +w["leftnavig"]="3"; +w["legal"]="0"; +w["li"]="7"; +w["librari"]="8"; +w["like"]="0,8"; +w["limit"]="0"; +w["line"]="2,3,8"; +w["link"]="0,3"; +w["list"]="0,2,7,8"; +w["ll"]="8"; +w["load"]="6,7"; +w["locat"]="2,8"; +w["log"]="0"; +w["logo"]="7"; +w["long"]="3"; +w["look"]="3,7,8"; +w["lucen"]="0"; +w["made"]="7"; +w["mail"]="8"; +w["main"]="7,8"; +w["make"]="0,2,3,8"; +w["manag"]="2"; +w["martin"]="5"; +w["match"]="8"; +w["max-ag"]="3"; +w["mean"]="8"; +w["meant"]="8"; +w["mechan"]="5,8"; +w["medium"]="7"; +w["messag"]="2"; +w["meta"]="8"; +w["method"]="8"; +w["microsoft"]="0"; +w["miss"]="2"; +w["model"]="0"; +w["modifi"]="2"; +w["more"]="0,3"; +w["move"]="0"; +w["multipl"]="3"; +w["must"]="2,4,6"; +w["must-revalid"]="3"; +w["mutandi"]="2"; +w["mutati"]="2"; +w["my"]="0"; +w["name"]="0,2,3,8"; +w["navig"]="3,6,7"; +w["necessari"]="2,3"; +w["need"]="2,3,5,8"; +w["new"]="2,3,6,8"; +w["newli"]="2"; +w["next"]="7"; +w["nexwav"]="8"; +w["nice"]="7"; +w["no"]="3,8"; +w["non-cjkv"]="1,5,8"; +w["non-head"]="0"; +w["non-n"]="2"; +w["norwegian"]="5"; +w["not"]="0,2,8"; +w["note"]="2,3,8"; +w["noth"]="3"; +w["notic"]="0"; +w["now"]="8"; +w["nquindex"]="8"; +w["null"]="8"; +w["number"]="8"; +w["nw-cms"]="4,8"; +w["nwsearchfnt"]="8"; +w["oasis-open"]="8"; +w["object"]="8"; +w["odd"]="3"; +w["off"]="0"; +w["onc"]="2"; +w["one"]="3,8"; +w["onli"]="2,5,8"; +w["open"]="2,8"; +w["oper"]="0"; +w["option"]="0"; +w["order"]="0"; +w["org"]="8"; +w["organ"]="7"; +w["other"]="0,1,2,5,8"; +w["out"]="0"; +w["output"]="0,1,2,3,7,8"; +w["output-dir"]="2"; +w["overal"]="7"; +w["overview"]="0,6,7,8"; +w["own"]="0,2"; +w["packag"]="0,1,2,8"; +w["page"]="0,3,6,7"; +w["pane"]="0,6,7"; +w["para"]="3"; +w["param"]="0"; +w["paramet"]="0"; +w["parameter"]="0"; +w["parent"]="7"; +w["part"]="3,7,8"; +w["path"]="2"; +w["path-"]="2"; +w["pattern"]="0,2"; +w["pdf"]="0,3"; +w["perform"]="0,3"; +w["persist"]="0,7"; +w["phrase"]="3"; +w["plain"]="3"; +w["pleas"]="5"; +w["plugin"]="7"; +w["png"]="3"; + diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-3.js b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-3.js new file mode 100644 index 000000000..b71ffe67c --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/index-3.js @@ -0,0 +1,221 @@ +//Auto generated index for searching. +w["point"]="2,3"; +w["popul"]="0,3"; +w["popular"]="8"; +w["porter"]="5"; +w["portugues"]="5"; +w["posit"]="3,7"; +w["possibl"]="0"; +w["prev"]="7"; +w["privat"]="8"; +w["problem"]="2"; +w["procedur"]="2"; +w["process"]="2,7,8"; +w["processor"]="2"; +w["produc"]="0"; +w["program"]="2"; +w["project"]="2,5"; +w["prompt"]="2"; +w["properti"]="0,2,8"; +w["provid"]="6,8"; +w["public"]="0,3"; +w["punctuat"]="2,8"; +w["put"]="2"; +w["queri"]="0,8"; +w["question"]="8"; +w["read"]="6"; +w["readm"]="2"; +w["recommend"]="1,3"; +w["recompil"]="4,8"; +w["refer"]="2"; +w["relat"]="2,3"; +w["relev"]="0"; +w["render"]="6"; +w["replac"]="3"; +w["requir"]="0,5"; +w["resid"]="8"; +w["resiz"]="0"; +w["resourc"]="3"; +w["restor"]="6"; +w["result"]="0,3,6,8"; +w["return"]="8"; +w["right"]="3"; +w["role"]="3"; +w["romanian"]="5"; +w["root"]="8"; +w["rss"]="3"; +w["run"]="2,4,8"; +w["russian"]="5"; +w["s"]="0,3,5,8"; +w["safe"]="2"; +w["same"]="2"; +w["save"]="6"; +w["saxhtmlindex"]="8"; +w["saxon"]="2"; +w["saxon-6"]="2"; +w["script"]="2"; +w["search"]="0,2,3,5,6,7,8"; +w["second"]="0"; +w["section"]="1,3,7"; +w["sectioninfo"]="3"; +w["see"]="2,3,7,8"; +w["self"]="8"; +w["separ"]="0,7"; +w["serv"]="3"; +w["server"]="0,3,8"; +w["server-sid"]="0"; +w["servic"]="0"; +w["set"]="0,2,3,4"; +w["setoutputfilt"]="3"; +w["share"]="2"; +w["should"]="0,2"; +w["show"]="0"; +w["side"]="8"; +w["sidetreecontrol"]="7"; +w["similar"]="0"; +w["simpl"]="0,8"; +w["simpli"]="2,3"; +w["sinc"]="3"; +w["site"]="0"; +w["size"]="0"; +w["smarter"]="0"; +w["snowbal"]="8"; +w["snowballstemm"]="8"; +w["so"]="0,2,3"; +w["some"]="8"; +w["someth"]="0"; +w["sort"]="0"; +w["sourc"]="2"; +w["space"]="8"; +w["spanish"]="5"; +w["specifi"]="0,2,8"; +w["src"]="8"; +w["stale"]="3"; +w["start"]="2"; +w["state"]="0,6"; +w["stayton"]="3"; +w["stem"]="0,5,8"; +w["stemmer"]="0,2,5,6,8"; +w["step"]="2,8"; +w["store"]="2,3,8"; +w["string"]="0,8"; +w["structur"]="7"; +w["studi"]="3"; +w["stuff"]="3"; +w["style"]="3,7"; +w["stylesheet"]="0"; +w["stylesheet-path"]="2"; +w["such"]="3,8"; +w["summari"]="0,3,8"; +w["support"]="0,1,5,8"; +w["supportedlanguag"]="8"; +w["sure"]="8"; +w["swedish"]="5"; +w["swf"]="3"; +w["system"]="0,2,3,6"; +w["t"]="0,2,3"; +w["tab"]="0,2,7"; +w["tabindex"]="0"; +w["tabl"]="0,6,7"; +w["tag"]="7"; +w["target"]="0"; +w["task"]="5"; +w["technic"]="0"; +w["tell"]="2"; +w["templat"]="5,8"; +w["term"]="0"; +w["test"]="2"; +w["test-ouput"]="2"; +w["test-output"]="2"; +w["text"]="0,2,3,8"; +w["than"]="0"; +w["them"]="3,8"; +w["theme"]="3"; +w["theme-redmond"]="3"; +w["then"]="0,3,8"; +w["there"]="8"; +w["therefor"]="5"; +w["these"]="3,5,6,8"; +w["they"]="6"; +w["thing"]="3"; +w["those"]="3,8"; +w["though"]="2"; +w["three"]="7,8"; +w["tip"]="2,3"; +w["titl"]="7,8"; +w["toc"]="0,3,7"; +w["todo"]="3"; +w["toggl"]="0"; +w["token"]="8"; +w["too"]="8"; +w["tool"]="2"; +w["top"]="3"; +w["top-level"]="2"; +w["topic"]="0,3,7"; +w["total"]="8"; +w["travers"]="8"; +w["tree"]="0,3,6,7"; +w["treeview"]="3,7"; +w["tri"]="2"; +w["true"]="2,7"; +w["turkish"]="5"; +w["two"]="3,7,8"; +w["txt"]="3"; +w["type"]="2,3"; +w["ui"]="7"; +w["ul"]="7"; +w["unchang"]="3"; +w["uncom"]="2"; +w["uncompress"]="3"; +w["understand"]="8"; +w["undertak"]="5"; +w["unnecessari"]="8"; +w["unord"]="7"; +w["unzip"]="2"; +w["up"]="0,2,3,4,5,7,8"; +w["updat"]="3"; +w["us"]="8"; +w["use"]="0,1,2,3,5,7,8"; +w["user"]="0,3,5,8"; +w["usr"]="2"; +w["utf-8"]="3"; +w["valid"]="2"; +w["validate-against-dtd"]="2"; +w["valu"]="2"; +w["var"]="8"; +w["variabl"]="2,4"; +w["various"]="3"; +w["veri"]="8"; +w["verison"]="5"; +w["version"]="0,2,4,5,8"; +w["w"]="8"; +w["way"]="3"; +w["we"]="0,3,7,8"; +w["web"]="0,3,8"; +w["web-bas"]="0"; +w["webhelp"]="1,2,6,7,8"; +w["webhelp-specif"]="0"; +w["week"]="3"; +w["were"]="6"; +w["which"]="0,2,3,7,8"; +w["width"]="0,3"; +w["wild"]="0"; +w["window"]="1,2"; +w["without"]="0"; +w["word"]="8"; +w["work"]="2"; +w["would"]="8"; +w["write"]="8"; +w["written"]="2,8"; +w["x"]="2"; +w["x-javascript"]="3"; +w["xhtml"]="3"; +w["xml"]="0,2,3"; +w["xp"]="2"; +w["xsl"]="2,3,7"; +w["xslt"]="2"; +w["xslt-processor-classpath"]="2"; +w["you"]="0,2,3,4,5,6,7,8"; +w["your"]="0,2,3,8"; +w["yourfil"]="2"; + diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/nwSearchFnt.js b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/nwSearchFnt.js new file mode 100644 index 000000000..0111559cc --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/nwSearchFnt.js @@ -0,0 +1,513 @@ +/*----------------------------------------------------------------------------
+ * JavaScript for webhelp search
+ *----------------------------------------------------------------------------
+ This file is part of the webhelpsearch plugin for DocBook WebHelp
+ Copyright (c) 2007-2008 NexWave Solutions All Rights Reserved.
+ www.nexwave.biz Nadege Quaine
+ http://kasunbg.blogspot.com/ Kasun Gajasinghe
+ */
+
+//string initialization
+var htmlfileList = "htmlFileList.js";
+var htmlfileinfoList = "htmlFileInfoList.js";
+var useCJKTokenizing = false;
+
+/* Cette fonction verifie la validite de la recherche entrre par l utilisateur */
+function Verifie(ditaSearch_Form) {
+
+ // Check browser compatibitily
+ if (navigator.userAgent.indexOf("Konquerer") > -1) {
+
+ alert(txt_browser_not_supported);
+ return;
+ }
+
+
+ var expressionInput = document.ditaSearch_Form.textToSearch.value;
+ //Set a cookie to store the searched keywords
+ $.cookie('textToSearch', expressionInput);
+
+
+ if (expressionInput.length < 1) {
+
+ // expression is invalid
+ alert(txt_enter_at_least_1_char);
+ // reactive la fenetre de search (utile car cadres)
+ document.ditaSearch_Form.textToSearch.focus();
+ }
+ else {
+
+ // Effectuer la recherche
+ Effectuer_recherche(expressionInput);
+
+ // reactive la fenetre de search (utile car cadres)
+ document.ditaSearch_Form.textToSearch.focus();
+ }
+}
+
+var stemQueryMap = new Array(); // A hashtable which maps stems to query words
+
+/* This function parses the search expression, loads the indices and displays the results*/
+function Effectuer_recherche(expressionInput) {
+
+ /* Display a waiting message */
+ //DisplayWaitingMessage();
+
+ /*data initialisation*/
+ var searchFor = ""; // expression en lowercase et sans les caracte res speciaux
+ //w = new Object(); // hashtable, key=word, value = list of the index of the html files
+ scriptLetterTab = new Scriptfirstchar(); // Array containing the first letter of each word to look for
+ var wordsList = new Array(); // Array with the words to look for
+ var finalWordsList = new Array(); // Array with the words to look for after removing spaces
+ var linkTab = new Array();
+ var fileAndWordList = new Array();
+ var txt_wordsnotfound = "";
+
+
+ /*nqu: expressionInput, la recherche est lower cased, plus remplacement des char speciaux*/
+ searchFor = expressionInput.toLowerCase().replace(/<\//g, "_st_").replace(/\$_/g, "_di_").replace(/\.|%2C|%3B|%21|%3A|@|\/|\*/g, " ").replace(/(%20)+/g, " ").replace(/_st_/g, "</").replace(/_di_/g, "%24_");
+
+ searchFor = searchFor.replace(/ +/g, " ");
+ searchFor = searchFor.replace(/ $/, "").replace(/^ /, "");
+
+ wordsList = searchFor.split(" ");
+ wordsList.sort();
+
+ //set the tokenizing method
+ if(typeof indexerLanguage != "undefined" && (indexerLanguage=="zh" || indexerLanguage=="ja" ||indexerLanguage=="ko")){
+ useCJKTokenizing=true;
+ } else {
+ useCJKTokenizing=false;
+ }
+ //If Lucene CJKTokenizer was used as the indexer, then useCJKTokenizing will be true. Else, do normal tokenizing.
+ // 2-gram tokenizinghappens in CJKTokenizing,
+ if(useCJKTokenizing){
+ finalWordsList = cjkTokenize(wordsList);
+ } else {
+ finalWordsList = tokenize(wordsList);
+ }
+
+ //load the scripts with the indices: the following lines do not work on the server. To be corrected
+ /*if (IEBrowser) {
+ scriptsarray = loadTheIndexScripts (scriptLetterTab);
+ } */
+
+ /**
+ * Compare with the indexed words (in the w[] array), and push words that are in it to tempTab.
+ */
+ var tempTab = new Array();
+ for (var t in finalWordsList) {
+ if (w[finalWordsList[t].toString()] == undefined) {
+ txt_wordsnotfound += finalWordsList[t] + " ";
+ } else {
+ tempTab.push(finalWordsList[t]);
+ }
+ }
+ finalWordsList = tempTab;
+
+ if (finalWordsList.length) {
+
+ //search 'and' and 'or' one time
+ fileAndWordList = SortResults(finalWordsList);
+
+ var cpt = fileAndWordList.length;
+ for (var i = cpt - 1; i >= 0; i--) {
+ if (fileAndWordList[i] != undefined) {
+ linkTab.push("<p>" + txt_results_for + " " + "<span class=\"searchExpression\">" + fileAndWordList[i][0].motslisteDisplay + "</span>" + "</p>");
+
+ linkTab.push("<ul class='searchresult'>");
+ for (t in fileAndWordList[i]) {
+ //DEBUG: alert(": "+ fileAndWordList[i][t].filenb+" " +fileAndWordList[i][t].motsliste);
+ //linkTab.push("<li><a href=\"../"+fl[fileAndWordList[i][t].filenb]+"\">"+fl[fileAndWordList[i][t].filenb]+"</a></li>");
+ var tempInfo = fil[fileAndWordList[i][t].filenb];
+ var pos1 = tempInfo.indexOf("@@@");
+ var pos2 = tempInfo.lastIndexOf("@@@");
+ var tempPath = tempInfo.substring(0, pos1);
+ var tempTitle = tempInfo.substring(pos1 + 3, pos2);
+ var tempShortdesc = tempInfo.substring(pos2 + 3, tempInfo.length);
+
+ //file:///home/kasun/docbook/WEBHELP/webhelp-draft-output-format-idea/src/main/resources/web/webhelp/installation.html
+ var linkString = "<li><a href=" + tempPath + ">" + tempTitle + "</a>";
+ // var linkString = "<li><a href=\"installation.html\">" + tempTitle + "</a>";
+ if ((tempShortdesc != "null")) {
+ linkString += "\n<div class=\"shortdesclink\">" + tempShortdesc + "</div>";
+ }
+ linkString += "</li>";
+ linkTab.push(linkString);
+ }
+ linkTab.push("</ul>");
+ }
+ }
+ }
+
+ var results = "";
+ if (linkTab.length > 0) {
+ /*writeln ("<p>" + txt_results_for + " " + "<span class=\"searchExpression\">" + cleanwordsList + "</span>" + "<br/>"+"</p>");*/
+ results = "<p>";
+ //write("<ul class='searchresult'>");
+ for (t in linkTab) {
+ results += linkTab[t].toString();
+ }
+ results += "</p>";
+ } else {
+ results = "<p>" + "Your search returned no results for " + "<span class=\"searchExpression\">" + txt_wordsnotfound + "</span>" + "</p>";
+ }
+ //alert(results);
+ document.getElementById('searchResults').innerHTML = results;
+}
+
+function tokenize(wordsList){
+ var stemmedWordsList = new Array(); // Array with the words to look for after removing spaces
+ var cleanwordsList = new Array(); // Array with the words to look for
+ for(var j in wordsList){
+ var word = wordsList[j];
+ if(typeof stemmer != "undefined" ){
+ stemQueryMap[stemmer(word)] = word;
+ } else {
+ stemQueryMap[word] = word;
+ }
+ }
+ //stemmedWordsList is the stemmed list of words separated by spaces.
+ for (var t in wordsList) {
+ wordsList[t] = wordsList[t].replace(/(%22)|^-/g, "");
+ if (wordsList[t] != "%20") {
+ scriptLetterTab.add(wordsList[t].charAt(0));
+ cleanwordsList.push(wordsList[t]);
+ }
+ }
+
+ if(typeof stemmer != "undefined" ){
+ //Do the stemming using Porter's stemming algorithm
+ for (var i = 0; i < cleanwordsList.length; i++) {
+ var stemWord = stemmer(cleanwordsList[i]);
+ stemmedWordsList.push(stemWord);
+ }
+ } else {
+ stemmedWordsList = cleanwordsList;
+ }
+ return stemmedWordsList;
+}
+
+//Invoker of CJKTokenizer class methods.
+function cjkTokenize(wordsList){
+ var allTokens= new Array();
+ var notCJKTokens= new Array();
+ var j=0;
+ for(j=0;j<wordsList.length;j++){
+ var word = wordsList[j];
+ if(getAvgAsciiValue(word) < 127){
+ notCJKTokens.push(word);
+ } else {
+ var tokenizer = new CJKTokenizer(word);
+ var tokensTmp = tokenizer.getAllTokens();
+ allTokens = allTokens.concat(tokensTmp);
+ }
+ }
+ allTokens = allTokens.concat(tokenize(notCJKTokens));
+ return allTokens;
+}
+
+//A simple way to determine whether the query is in english or not.
+function getAvgAsciiValue(word){
+ var tmp = 0;
+ var num = word.length < 5 ? word.length:5;
+ for(var i=0;i<num;i++){
+ if(i==5) break;
+ tmp += word.charCodeAt(i);
+ }
+ return tmp/num;
+}
+
+//CJKTokenizer
+function CJKTokenizer(input){
+ this.input = input;
+ this.offset=-1;
+ this.tokens = new Array();
+ this.incrementToken = incrementToken;
+ this.tokenize = tokenize;
+ this.getAllTokens = getAllTokens;
+ this.unique = unique;
+
+ function incrementToken(){
+ if(this.input.length - 2 <= this.offset){
+ // console.log("false "+offset);
+ return false;
+ }
+ else {
+ this.offset+=1;
+ return true;
+ }
+ }
+
+ function tokenize(){
+ //document.getElementById("content").innerHTML += x.substring(offset,offset+2)+"<br>";
+ return this.input.substring(this.offset,this.offset+2);
+ }
+
+ function getAllTokens(){
+ while(this.incrementToken()){
+ var tmp = this.tokenize();
+ this.tokens.push(tmp);
+ }
+ return this.unique(this.tokens);
+// document.getElementById("content").innerHTML += tokens+" ";
+// document.getElementById("content").innerHTML += "<br>dada"+sortedTokens+" ";
+// console.log(tokens.length+"dsdsds");
+ /*for(i=0;i<tokens.length;i++){
+ console.log(tokens[i]);
+ var ss = tokens[i] == sortedTokens[i];
+
+// document.getElementById("content").innerHTML += "<br>dada"+un[i]+"- "+stems[i]+" "+ ss;
+ document.getElementById("content").innerHTML += "<br>"+sortedTokens[i];
+ }*/
+ }
+
+ function unique(a)
+ {
+ var r = new Array();
+ o:for(var i = 0, n = a.length; i < n; i++)
+ {
+ for(var x = 0, y = r.length; x < y; x++)
+ {
+ if(r[x]==a[i]) continue o;
+ }
+ r[r.length] = a[i];
+ }
+ return r;
+ }
+}
+
+
+/* Scriptfirstchar: to gather the first letter of index js files to upload */
+function Scriptfirstchar() {
+ this.strLetters = "";
+ this.add = addLettre;
+}
+
+function addLettre(caract) {
+
+ if (this.strLetters == 'undefined') {
+ this.strLetters = caract;
+ } else if (this.strLetters.indexOf(caract) < 0) {
+ this.strLetters += caract;
+ }
+
+ return 0;
+}
+/* end of scriptfirstchar */
+
+/*main loader function*/
+/*tab contains the first letters of each word looked for*/
+function loadTheIndexScripts(tab) {
+
+ //alert (tab.strLetters);
+ var scriptsarray = new Array();
+
+ for (var i = 0; i < tab.strLetters.length; i++) {
+
+ scriptsarray[i] = "..\/search" + "\/" + tab.strLetters.charAt(i) + ".js";
+ }
+ // add the list of html files
+ i++;
+ scriptsarray[i] = "..\/search" + "\/" + htmlfileList;
+
+ //debug
+ for (var t in scriptsarray) {
+ //alert (scriptsarray[t]);
+ }
+
+ tab = new ScriptLoader();
+ for (t in scriptsarray) {
+ tab.add(scriptsarray[t]);
+ }
+ tab.load();
+ //alert ("scripts loaded");
+ return (scriptsarray);
+}
+
+/* ScriptLoader: to load the scripts and wait that it's finished */
+function ScriptLoader() {
+ this.cpt = 0;
+ this.scriptTab = new Array();
+ this.add = addAScriptInTheList;
+ this.load = loadTheScripts;
+ this.onScriptLoaded = onScriptLoadedFunc;
+}
+
+function addAScriptInTheList(scriptPath) {
+ this.scriptTab.push(scriptPath);
+}
+
+function loadTheScripts() {
+ var script;
+ var head;
+
+ head = document.getElementsByTagName('head').item(0);
+
+ //script = document.createElement('script');
+
+ for (var el in this.scriptTab) {
+ //alert (el+this.scriptTab[el]);
+ script = document.createElement('script');
+ script.src = this.scriptTab[el];
+ script.type = 'text/javascript';
+ script.defer = false;
+
+ head.appendChild(script);
+ }
+
+}
+
+function onScriptLoadedFunc(e) {
+ e = e || window.event;
+ var target = e.target || e.srcElement;
+ var isComplete = true;
+ if (typeof target.readyState != undefined) {
+
+ isComplete = (target.readyState == "complete" || target.readyState == "loaded");
+ }
+ if (isComplete) {
+ ScriptLoader.cpt++;
+ if (ScriptLoader.cpt == ScriptLoader.scripts.length) {
+ ScriptLoader.onLoadComplete();
+ }
+ }
+}
+
+/*
+function onLoadComplete() {
+ alert("loaded !!");
+} */
+
+/* End of scriptloader functions */
+
+// Array.unique( strict ) - Remove duplicate values
+function unique(tab) {
+ var a = new Array();
+ var i;
+ var l = tab.length;
+
+ if (tab[0] != undefined) {
+ a[0] = tab[0];
+ }
+ else {
+ return -1
+ }
+
+ for (i = 1; i < l; i++) {
+ if (indexof(a, tab[i], 0) < 0) {
+ a.push(tab[i]);
+ }
+ }
+ return a;
+}
+function indexof(tab, element, begin) {
+ for (var i = begin; i < tab.length; i++) {
+ if (tab[i] == element) {
+ return i;
+ }
+ }
+ return -1;
+
+}
+/* end of Array functions */
+
+
+/*
+ Param: mots= list of words to look for.
+ This function creates an hashtable:
+ - The key is the index of a html file which contains a word to look for.
+ - The value is the list of all words contained in the html file.
+
+ Return value: the hashtable fileAndWordList
+ */
+function SortResults(mots) {
+
+ var fileAndWordList = new Object();
+ if (mots.length == 0) {
+ return null;
+ }
+
+ for (var t in mots) {
+ // get the list of the indices of the files.
+ var listNumerosDesFicStr = w[mots[t].toString()];
+ //alert ("listNumerosDesFicStr "+listNumerosDesFicStr);
+ var tab = listNumerosDesFicStr.split(",");
+
+ //for each file (file's index):
+ for (var t2 in tab) {
+ var temp = tab[t2].toString();
+ if (fileAndWordList[temp] == undefined) {
+
+ fileAndWordList[temp] = "" + mots[t];
+ } else {
+
+ fileAndWordList[temp] += "," + mots[t];
+ }
+ }
+ }
+
+ var fileAndWordListValuesOnly = new Array();
+
+ // sort results according to values
+ var temptab = new Array();
+ for (t in fileAndWordList) {
+ tab = fileAndWordList[t].split(',');
+
+ var tempDisplay = new Array();
+ for (var x in tab) {
+ if(stemQueryMap[tab[x]] != undefined){
+ tempDisplay.push(stemQueryMap[tab[x]]); //get the original word from the stem word.
+ } else {
+ tempDisplay.push(tab[x]); //no stem is available. (probably a CJK language)
+ }
+ }
+ var tempDispString = tempDisplay.join(", ");
+
+ temptab.push(new resultPerFile(t, fileAndWordList[t], tab.length, tempDispString));
+ fileAndWordListValuesOnly.push(fileAndWordList[t]);
+ }
+
+
+ //alert("t"+fileAndWordListValuesOnly.toString());
+
+ fileAndWordListValuesOnly = unique(fileAndWordListValuesOnly);
+ fileAndWordListValuesOnly = fileAndWordListValuesOnly.sort(compare_nbMots);
+ //alert("t: "+fileAndWordListValuesOnly.join(';'));
+
+ var listToOutput = new Array();
+
+ for (var j in fileAndWordListValuesOnly) {
+ for (t in temptab) {
+ if (temptab[t].motsliste == fileAndWordListValuesOnly[j]) {
+ if (listToOutput[j] == undefined) {
+ listToOutput[j] = new Array(temptab[t]);
+ } else {
+ listToOutput[j].push(temptab[t]);
+ }
+ }
+ }
+ }
+ return listToOutput;
+}
+
+function resultPerFile(filenb, motsliste, motsnb, motslisteDisplay) {
+ this.filenb = filenb;
+ this.motsliste = motsliste;
+ this.motsnb = motsnb;
+ this.motslisteDisplay= motslisteDisplay;
+}
+
+function compare_nbMots(s1, s2) {
+ var t1 = s1.split(',');
+ var t2 = s2.split(',');
+ //alert ("s1:"+t1.length + " " +t2.length)
+ if (t1.length == t2.length) {
+ return 0;
+ } else if (t1.length > t2.length) {
+ return 1;
+ } else {
+ return -1;
+ }
+ //return t1.length - t2.length);
+}
\ No newline at end of file diff --git a/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/stemmers/en_stemmer.js b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/stemmers/en_stemmer.js new file mode 100644 index 000000000..f58012f2b --- /dev/null +++ b/src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1/webhelp/docs/content/search/stemmers/en_stemmer.js @@ -0,0 +1,187 @@ +// Porter stemmer in Javascript. Few comments, but it's easy to follow against the rules in the original +// paper, in +// +// Porter, 1980, An algorithm for suffix stripping, Program, Vol. 14, +// no. 3, pp 130-137, +// +// see also http://www.tartarus.org/~martin/PorterStemmer + +// Release 1 be 'andargor', Jul 2004 +// Release 2 (substantially revised) by Christopher McKenzie, Aug 2009 + + +var stemmer = (function(){ + var step2list = { + "ational" : "ate", + "tional" : "tion", + "enci" : "ence", + "anci" : "ance", + "izer" : "ize", + "bli" : "ble", + "alli" : "al", + "entli" : "ent", + "eli" : "e", + "ousli" : "ous", + "ization" : "ize", + "ation" : "ate", + "ator" : "ate", + "alism" : "al", + "iveness" : "ive", + "fulness" : "ful", + "ousness" : "ous", + "aliti" : "al", + "iviti" : "ive", + "biliti" : "ble", + "logi" : "log" + }, + + step3list = { + "icate" : "ic", + "ative" : "", + "alize" : "al", + "iciti" : "ic", + "ical" : "ic", + "ful" : "", + "ness" : "" + }, + + c = "[^aeiou]", // consonant + v = "[aeiouy]", // vowel + C = c + "[^aeiouy]*", // consonant sequence + V = v + "[aeiou]*", // vowel sequence + + mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0 + meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1 + mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1 + s_v = "^(" + C + ")?" + v; // vowel in stem + + return function (w) { + var stem, + suffix, + firstch, + re, + re2, + re3, + re4, + origword = w; + + if (w.length < 3) { return w; } + + firstch = w.substr(0,1); + if (firstch == "y") { + w = firstch.toUpperCase() + w.substr(1); + } + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) { w = w.replace(re,"$1$2"); } + else if (re2.test(w)) { w = w.replace(re2,"$1$2"); } + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) { w = w + "e"; } + else if (re3.test(w)) { re = /.$/; w = w.replace(re,""); } + else if (re4.test(w)) { w = w + "e"; } + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) { w = stem + "i"; } + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) { + w = stem + step2list[suffix]; + } + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) { + w = stem + step3list[suffix]; + } + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) { + w = stem; + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) { + w = stem; + } + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) { + w = stem; + } + } + + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + + if (firstch == "y") { + w = firstch.toLowerCase() + w.substr(1); + } + + return w; + } +})();
\ No newline at end of file |