svn commit: r1395298 [31/42] - in /ofbiz/trunk/applications/cont
Locked
svn commit: r1395298 [31/42] - in /ofbiz/trunk/applications/cont
 
|
Added: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch01.html
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch01.html?rev=1395298&view=auto ============================================================================== --- ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch01.html (added) +++ ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch01.html Sun Oct 7 13:31:52 2012 @@ -0,0 +1,109 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7"></meta> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta> +<title>Introduction</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></meta><meta name="description" content="Overview of the package."></meta><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="up" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="prev" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="next" href="ch02.html" title="Using the package"></link><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-1055"; + var language = "en"; + var w = new Object(); + //Localization + txt_filesfound = 'Results'; + txt_enter_at_least_1_char = "You must enter at least one character."; + txt_browser_not_supported = "JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"></link><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"></link><style type="text/css"> +noscript{ + font-weight:bold; +} +input { + margin-bottom: 5px; + margin-top: 2px; +} +.folder { + display: block; + height: 22px; + padding-left: 20px; + background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat; +} +span.contentsTab { + padding-left: 20px; + background: url(../common/images/toc-icon.png) no-repeat 0 center; +} +span.searchTab { + padding-left: 20px; + background: url(../common/images/search-icon.png) no-repeat 0 center; +} + +/* Overide jquery treeview's defaults for ul. */ +.treeview ul { + background-color: transparent; + margin-top: 4px; +} +#webhelp-currentid { + background-color: #D8D8D8 !important; +} +.treeview .hover { color: black; } +.filetree li span a { text-decoration: none; font-size: 12px; color: #517291; } + +/* Override jquery-ui's default css customizations. These are supposed to take precedence over those.*/ +.ui-widget-content { + border: 0px; + background: none; + color: none; +} +.ui-widget-header { + color: #e9e8e9; + border-left: 1px solid #e5e5e5; + border-right: 1px solid #e5e5e5; + border-bottom: 1px solid #bbc4c5; + border-top: 4px solid #e5e5e5; + border: medium none; + background: #F4F4F4; /* old browsers */ + background: -moz-linear-gradient(top, #F4F4F4 0%, #E6E4E5 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#F4F4F4), color-stop(100%,#E6E4E5)); /* webkit */ + font-weight: none; +} +.ui-widget-header a { color: none; } +.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { +border: none; background: none; font-weight: none; color: none; } +.ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: black; text-decoration: none; } +.ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: none; background: none; font-weight: none; color: none; } + +.ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: none; background: none; font-weight: none; color: none; } +.ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { + color: black; text-decoration: none; + background: #C6C6C6; /* old browsers */ + background: -moz-linear-gradient(top, #C6C6C6 0%, #D8D8D8 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#C6C6C6), color-stop(100%,#D8D8D8)); /* webkit */ + -webkit-border-radius:15px; -moz-border-radius:10px; + border: 1px solid #f1f1f1; +} +.ui-corner-all { border-radius: 0 0 0 0; } + +.ui-tabs { padding: .2em;} +.ui-tabs .ui-tabs-nav li { top: 0px; margin: -2px 0 1px; text-transform: uppercase; font-size: 10.5px;} +.ui-tabs .ui-tabs-nav li a { padding: .25em 2em .25em 1em; margin: .5em; text-shadow: 0 1px 0 rgba(255,255,255,.5); } + </style><script type="text/javascript" src="../common/browserDetect.js"></script><script type="text/javascript" src="../common/jquery/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"></script><script type="text/javascript" src="search/l10n.js"></script><script type="text/javascript" src="search/htmlFileInfoList.js"></script><script type="text/javascript" src="search/nwSearchFnt.js"></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"></script><script type="text/javascript" src="search/index-2.js"></script><script type="text/javascript" src="search/index-3.js"></script></head><body><div id="he ader"><a target="_blank" href="#"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt=" Documentation"></img></a><h1>README: Web-based Help from DocBook XML<br></br>Introduction</h1><div id="navheader"><table class="navLinks"><tr><td><a id="showHideButton" href="javascript:showHideToc();" class="pointLeft" tabindex="5" title="Hide TOC tree">Sidebar + </a></td><td><a accesskey="p" class="navLinkPrevious" tabindex="5" href="index.html">Prev</a> + | + <a accesskey="n" class="navLinkNext" tabindex="5" href="ch02.html">Next</a></td></tr></table></div></div><div id="content"><noscript>JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.</noscript><div class="chapter"><div xmlns="" class="titlepage"><div><div><h1 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id375622"></a>Introduction</h1></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="id375647" class="indexterm"></a> + </p><div class="itemizedlist"><p class="title"><strong>Features</strong></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Sophisticated CSS-based page layout</p></li><li class="listitem"><p>Client-side search.<a id="id375673" class="indexterm"></a></p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>Provides full content search of the documentation. Shows the search results with + links to chunked pages, and a small description.</p></li><li class="listitem"><p>Search results scoring/rating - The results are weighted according to how many + times the words in search query appears in it, is it bold or not, is in index terms + etc. The score out of 5 is shown by small colored boxes after each + search-result.</p></li><li class="listitem"><p>Search results can include brief descriptions of the target.<a id="id375711" class="indexterm"></a></p></li><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="id375732" class="indexterm"></a></p></li><li class="listitem"><p>Support for Chinese, Japanese, and Korean languages using code from the Lucene search + engine.</p></li><li class="listitem"><p>Search highlighting shows where the searched term appears in the results. + <a id="id375759" class="indexterm"></a></p></li></ul></div></li><li class="listitem"><p>Table of contents (TOC) pane with collapsible toc tree.</p></li><li class="listitem"><p>Auto-synchronization of content pane and TOC.</p></li><li class="listitem"><p>Nicely placed small forward, backward, top links</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 script 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. Alternatively, you can use this Ant script + as a template for creating your own build script or you + can use the <a class="ulink" href="http://docbkx-tools.sourceforge.net/docbkx-samples/manual.html" target="_top">Docbkx Maven plugin</a>.</p></li></ul></div></div><script type="text/javascript" src="../common/main.js"></script><div class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><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 id="sidebar"><div id="leftnavigation" style="padding-top:3px;"><div id="tabs"><ul><li><a href="#treeDiv" style="outline:0;" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="#searchDiv" style="outline:0;" tabindex="1" onclick="doSearch()"><span class="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"></img><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li id="webhelp-currentid"><span class="file"><a href="ch01.html" tabindex="1">Introduction</a></span></li><li><span class="file"><a href="ch02.html" tabindex="1">Using the package</a></span><ul><li><span class="file"><a href="ch02s01.html" tabindex="1">Generating webhelp output</a></span></li><li><span class="file"><a href="ch02s02.html" tabindex="1">Using and customizing the output</a></span><ul><li><span class="file"><a href="ch02s02s01.html" tabindex="1">Recommended Apache configurations</a></span></li></ul></li><li><span class="file"><a href="ch02s03.html" tabindex="1">Search indexing</a></span></li><li><span class="file"><a href="ch02s04.html" tabindex="1">Adding support for other (non-CJKV) languages</a></span></li><li><span class="file"><a href="ch02s05.html" tabindex="1">Adding images</a></span></li></ul></li><li><span class="file"><a href="ch03.html" tabindex="1">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html" tabindex="1">Design</a></span></li><li><span class="file"><a href="ch03s02.html" tabindex="1">Search</a></span><ul><li><span class="file"><a href="ch03s02s01.html" tabindex="1">New Stemmers</a></span></li></ul></li></ul></li><li><span class="file"><a href="ch04.html" tabindex="1">FAQ</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(searchForm);return false" name="searchForm" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="search" class="searchText" tabindex="1"></input> <input onclick="Verifie(searchForm)" type="button" class="searchButton" value="Go" id="doSearch" tabindex="1"></input></ce nter></fieldset></form></div><div id="searchResults"><center></center></div><p class="searchHighlight"><a href="#" onclick="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div></body></html> Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch01.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch01.html ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch01.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02.html URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02.html?rev=1395298&view=auto ============================================================================== --- ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02.html (added) +++ ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02.html Sun Oct 7 13:31:52 2012 @@ -0,0 +1,93 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7"></meta> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta> +<title>Using the package</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></meta><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="up" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="prev" href="ch01.html" title="Introduction"></link><link rel="next" href="ch02s01.html" title="Generating webhelp output"></link><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-1055"; + var language = "en"; + var w = new Object(); + //Localization + txt_filesfound = 'Results'; + txt_enter_at_least_1_char = "You must enter at least one character."; + txt_browser_not_supported = "JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"></link><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"></link><style type="text/css"> +noscript{ + font-weight:bold; +} +input { + margin-bottom: 5px; + margin-top: 2px; +} +.folder { + display: block; + height: 22px; + padding-left: 20px; + background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat; +} +span.contentsTab { + padding-left: 20px; + background: url(../common/images/toc-icon.png) no-repeat 0 center; +} +span.searchTab { + padding-left: 20px; + background: url(../common/images/search-icon.png) no-repeat 0 center; +} + +/* Overide jquery treeview's defaults for ul. */ +.treeview ul { + background-color: transparent; + margin-top: 4px; +} +#webhelp-currentid { + background-color: #D8D8D8 !important; +} +.treeview .hover { color: black; } +.filetree li span a { text-decoration: none; font-size: 12px; color: #517291; } + +/* Override jquery-ui's default css customizations. These are supposed to take precedence over those.*/ +.ui-widget-content { + border: 0px; + background: none; + color: none; +} +.ui-widget-header { + color: #e9e8e9; + border-left: 1px solid #e5e5e5; + border-right: 1px solid #e5e5e5; + border-bottom: 1px solid #bbc4c5; + border-top: 4px solid #e5e5e5; + border: medium none; + background: #F4F4F4; /* old browsers */ + background: -moz-linear-gradient(top, #F4F4F4 0%, #E6E4E5 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#F4F4F4), color-stop(100%,#E6E4E5)); /* webkit */ + font-weight: none; +} +.ui-widget-header a { color: none; } +.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { +border: none; background: none; font-weight: none; color: none; } +.ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: black; text-decoration: none; } +.ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: none; background: none; font-weight: none; color: none; } + +.ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: none; background: none; font-weight: none; color: none; } +.ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { + color: black; text-decoration: none; + background: #C6C6C6; /* old browsers */ + background: -moz-linear-gradient(top, #C6C6C6 0%, #D8D8D8 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#C6C6C6), color-stop(100%,#D8D8D8)); /* webkit */ + -webkit-border-radius:15px; -moz-border-radius:10px; + border: 1px solid #f1f1f1; +} +.ui-corner-all { border-radius: 0 0 0 0; } + +.ui-tabs { padding: .2em;} +.ui-tabs .ui-tabs-nav li { top: 0px; margin: -2px 0 1px; text-transform: uppercase; font-size: 10.5px;} +.ui-tabs .ui-tabs-nav li a { padding: .25em 2em .25em 1em; margin: .5em; text-shadow: 0 1px 0 rgba(255,255,255,.5); } + </style><script type="text/javascript" src="../common/browserDetect.js"></script><script type="text/javascript" src="../common/jquery/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"></script><script type="text/javascript" src="search/l10n.js"></script><script type="text/javascript" src="search/htmlFileInfoList.js"></script><script type="text/javascript" src="search/nwSearchFnt.js"></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"></script><script type="text/javascript" src="search/index-2.js"></script><script type="text/javascript" src="search/index-3.js"></script></head><body><div id="he ader"><a target="_blank" href="#"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt=" Documentation"></img></a><h1>README: Web-based Help from DocBook XML<br></br>Using the package</h1><div id="navheader"><table class="navLinks"><tr><td><a id="showHideButton" href="javascript:showHideToc();" class="pointLeft" tabindex="5" title="Hide TOC tree">Sidebar + </a></td><td><a accesskey="p" class="navLinkPrevious" tabindex="5" href="ch01.html">Prev</a> + | + <a accesskey="n" class="navLinkNext" tabindex="5" href="ch02s01.html">Next</a></td></tr></table></div></div><div id="content"><noscript>JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.</noscript><div class="chapter"><div xmlns="" class="titlepage"><div><div><h1 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id375821"></a>Using the package</h1></div></div></div> +<div class="toc"><p><strong>Table of 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="ch02s02s01.html">Recommended Apache configurations</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s03.html">Search indexing</a></span></dt><dt><span class="section"><a href="ch02s04.html">Adding support for other (non-CJKV) languages</a></span></dt><dt><span class="section"><a href="ch02s05.html">Adding images</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></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 id="sidebar"><div id="leftnavigation" style="padding-top:3px;"><div id="tabs"><ul><li><a href="#treeDiv" style="outline:0;" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="#searchDiv" style="outline:0;" tabindex="1" onclick="doSearch()"><span class="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images /loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"></img><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li><span class="file"><a href="ch01.html" tabindex="1">Introduction</a></span></li><li id="webhelp-currentid"><span class="file"><a href="ch02.html" tabindex="1">Using the package</a></span><ul><li><span class="file"><a href="ch02s01.html" tabindex="1">Generating webhelp output</a></span></li><li><span class="file"><a href="ch02s02.html" tabindex="1">Using and customizing the output</a></span><ul><li><span class="file"><a href="ch02s02s01.html" tabindex="1">Recommended Apache configurations</a></span></li></ul></li><li><span class="file"><a href="ch02s03.html" tabindex="1">Search indexing</a></span></li><li><span class="file"><a href="ch02s04.html" tabindex="1">Adding support for other (non-CJKV) languages</a></span></li><li><span class="file"><a href="ch02s05.html" tabindex="1">Adding images</a></span></li></u l></li><li><span class="file"><a href="ch03.html" tabindex="1">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html" tabindex="1">Design</a></span></li><li><span class="file"><a href="ch03s02.html" tabindex="1">Search</a></span><ul><li><span class="file"><a href="ch03s02s01.html" tabindex="1">New Stemmers</a></span></li></ul></li></ul></li><li><span class="file"><a href="ch04.html" tabindex="1">FAQ</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(searchForm);return false" name="searchForm" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="search" class="searchText" tabindex="1"></input> <input onclick="Verifie(searchForm)" type="button" class="searchButton" value="Go" id="doSearch" tabindex="1"></input></center></fieldset></form></div><div id="searchResults"><center></center></div><p class="searchHighlight"><a href="#" on click="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div></body></html> Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02.html ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s01.html URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s01.html?rev=1395298&view=auto ============================================================================== --- ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s01.html (added) +++ ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s01.html Sun Oct 7 13:31:52 2012 @@ -0,0 +1,199 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7"></meta> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta> +<title>Generating webhelp output</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></meta><meta name="description" content="Installation instructions"></meta><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="up" href="ch02.html" title="Using the package"></link><link rel="prev" href="ch02.html" title="Using the package"></link><link rel="next" href="ch02s02.html" title="Using and customizing the output"></link><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-1055"; + var language = "en"; + var w = new Object(); + //Localization + txt_filesfound = 'Results'; + txt_enter_at_least_1_char = "You must enter at least one character."; + txt_browser_not_supported = "JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"></link><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"></link><style type="text/css"> +noscript{ + font-weight:bold; +} +input { + margin-bottom: 5px; + margin-top: 2px; +} +.folder { + display: block; + height: 22px; + padding-left: 20px; + background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat; +} +span.contentsTab { + padding-left: 20px; + background: url(../common/images/toc-icon.png) no-repeat 0 center; +} +span.searchTab { + padding-left: 20px; + background: url(../common/images/search-icon.png) no-repeat 0 center; +} + +/* Overide jquery treeview's defaults for ul. */ +.treeview ul { + background-color: transparent; + margin-top: 4px; +} +#webhelp-currentid { + background-color: #D8D8D8 !important; +} +.treeview .hover { color: black; } +.filetree li span a { text-decoration: none; font-size: 12px; color: #517291; } + +/* Override jquery-ui's default css customizations. These are supposed to take precedence over those.*/ +.ui-widget-content { + border: 0px; + background: none; + color: none; +} +.ui-widget-header { + color: #e9e8e9; + border-left: 1px solid #e5e5e5; + border-right: 1px solid #e5e5e5; + border-bottom: 1px solid #bbc4c5; + border-top: 4px solid #e5e5e5; + border: medium none; + background: #F4F4F4; /* old browsers */ + background: -moz-linear-gradient(top, #F4F4F4 0%, #E6E4E5 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#F4F4F4), color-stop(100%,#E6E4E5)); /* webkit */ + font-weight: none; +} +.ui-widget-header a { color: none; } +.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { +border: none; background: none; font-weight: none; color: none; } +.ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: black; text-decoration: none; } +.ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: none; background: none; font-weight: none; color: none; } + +.ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: none; background: none; font-weight: none; color: none; } +.ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { + color: black; text-decoration: none; + background: #C6C6C6; /* old browsers */ + background: -moz-linear-gradient(top, #C6C6C6 0%, #D8D8D8 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#C6C6C6), color-stop(100%,#D8D8D8)); /* webkit */ + -webkit-border-radius:15px; -moz-border-radius:10px; + border: 1px solid #f1f1f1; +} +.ui-corner-all { border-radius: 0 0 0 0; } + +.ui-tabs { padding: .2em;} +.ui-tabs .ui-tabs-nav li { top: 0px; margin: -2px 0 1px; text-transform: uppercase; font-size: 10.5px;} +.ui-tabs .ui-tabs-nav li a { padding: .25em 2em .25em 1em; margin: .5em; text-shadow: 0 1px 0 rgba(255,255,255,.5); } + </style><script type="text/javascript" src="../common/browserDetect.js"></script><script type="text/javascript" src="../common/jquery/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"></script><script type="text/javascript" src="search/l10n.js"></script><script type="text/javascript" src="search/htmlFileInfoList.js"></script><script type="text/javascript" src="search/nwSearchFnt.js"></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"></script><script type="text/javascript" src="search/index-2.js"></script><script type="text/javascript" src="search/index-3.js"></script></head><body><div id="he ader"><a target="_blank" href="#"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt=" Documentation"></img></a><h1>README: Web-based Help from DocBook XML<br></br>Using the package</h1><div id="navheader"><table class="navLinks"><tr><td><a id="showHideButton" href="javascript:showHideToc();" class="pointLeft" tabindex="5" title="Hide TOC tree">Sidebar + </a></td><td><a accesskey="p" class="navLinkPrevious" tabindex="5" href="ch02.html">Prev</a> + | + <a accesskey="u" class="navLinkUp" tabindex="5" href="ch02.html">Up</a> + | + <a accesskey="n" class="navLinkNext" tabindex="5" href="ch02s02.html">Next</a></td></tr></table></div></div><div id="content"><noscript>JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.</noscript><div class="section"><div xmlns="" class="titlepage"><div><div><h2 xmlns="http://www.w3.org/1999/xhtml" class="title" style="clear: both"><a id="id375833"></a>Generating webhelp output</h2></div></div></div> +<div class="procedure"><a id="id375868"></a><p class="title"><strong>Procedure 1. To install the package on Windows</strong></p><div class="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><p>In addition to using the ant + <code class="filename">build.xml</code> provided, you can also + use the <a class="ulink" href="http://docbkx-tools.sourceforge.net/docbkx-samples/manual.html" target="_top">Docbkx Maven plugin</a> to generate + webhelp.</p></div><ol class="procedure" type="1"><li class="step"><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"><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" 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"><p>If necessary, install <a class="ulink" href="http://ant.apache.org/bindownload.cgi" target="_top">Apache + Ant</a> 1.8.0 or higher. See <a class="ulink" href="http://ant.apache.org/manual/install.html" target="_top">Ant installation instructions</a>.</p><ol type="a" class="substeps"><li class="step"><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"><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.8.0</code>. </p><div class="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"><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.8.0\bin</code></p></li><li class="step"><p>Confirm that Ant is installed by typing the following at a command prompt: + </p><pre class="programlisting">ant -version</pre><div class="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"><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" 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"><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><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>You must set appropriate values for + <code class="code">xslt-processor-classpath</code>, + <code class="code">xercesImpl.jar</code>, and + <code class="code">xml-apis.jar</code>.</p></div><p>See the DocBook <a class="ulink" href="../../../doc/html/webhelp.html" target="_top">reference + documentation</a> for detailed information about the + available webhelp and other parameters. Note that not all + DocBook parameters are passed in to the xsls by the + <code class="filename">build.xml</code> by default. You may need + to modify the <code class="filename">build.xml</code> to pass in + some DocBook + parameters.</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 the follosing so that they point to your local +# copy of the jars indicated: +# * Saxon 6.5 jar +# * Xerces 2: xercesImpl.jar +# * xml-commons: xml-apis.jar +xslt-processor-classpath=/usr/share/java/saxon-6.5.5.jar +xercesImpl.jar=/usr/share/java/xercesImpl.jar +xml-apis.jar=/usr/share/java/xml-apis.jar + +# For non-ns version only, this validates the document +# against a dtd. +validate-against-dtd=true + +# The extension for files to be indexed (html/htm/xhtml etc.) +html.extension=html + +# 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 + +# Enables/Disables stemming +# Stemming allows better querying for the search +enable.stemming=true + +# Set admon.graphics to 1 to user graphics for note, tip, etc. +admon.graphics=0 +suppress.footer.navigation=0</pre></li><li class="step"><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" 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"><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"><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"><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></li></ol></li></ol></div></div><script type="text/javascript" src="../common/main.js"></script><div class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><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 id="sidebar"><div id="leftnavigation" style="padding-top:3px;"><div id="tabs"><ul><li><a href="#treeDiv" style="outline:0;" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="#searchDiv" style="outline:0;" tabindex="1" onclick="doS earch()"><span class="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"></img><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li><span class="file"><a href="ch01.html" tabindex="1">Introduction</a></span></li><li><span class="file"><a href="ch02.html" tabindex="1">Using the package</a></span><ul><li id="webhelp-currentid"><span class="file"><a href="ch02s01.html" tabindex="1">Generating webhelp output</a></span></li><li><span class="file"><a href="ch02s02.html" tabindex="1">Using and customizing the output</a></span><ul><li><span class="file"><a href="ch02s02s01.html" tabindex="1">Recommended Apache configurations</a></span></li></ul></li><li><span class="file"><a href="ch02s03.html" tabindex="1">Search indexing</a></span></li><li><span class="file"><a href="ch02s04.html" tabindex="1">Adding support for other (non-CJKV) languages</a ></span></li><li><span class="file"><a href="ch02s05.html" tabindex="1">Adding images</a></span></li></ul></li><li><span class="file"><a href="ch03.html" tabindex="1">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html" tabindex="1">Design</a></span></li><li><span class="file"><a href="ch03s02.html" tabindex="1">Search</a></span><ul><li><span class="file"><a href="ch03s02s01.html" tabindex="1">New Stemmers</a></span></li></ul></li></ul></li><li><span class="file"><a href="ch04.html" tabindex="1">FAQ</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(searchForm);return false" name="searchForm" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="search" class="searchText" tabindex="1"></input> <input onclick="Verifie(searchForm)" type="button" class="searchButton" value="Go" id="doSearch" tabindex="1"></input></center></fields et></form></div><div id="searchResults"><center></center></div><p class="searchHighlight"><a href="#" onclick="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div></body></html> Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s01.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s01.html ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s01.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02.html URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02.html?rev=1395298&view=auto ============================================================================== --- ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02.html (added) +++ ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02.html Sun Oct 7 13:31:52 2012 @@ -0,0 +1,112 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7"></meta> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta> +<title>Using and customizing the output</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></meta><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="up" href="ch02.html" title="Using the package"></link><link rel="prev" href="ch02s01.html" title="Generating webhelp output"></link><link rel="next" href="ch02s02s01.html" title="Recommended Apache configurations"></link><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-1055"; + var language = "en"; + var w = new Object(); + //Localization + txt_filesfound = 'Results'; + txt_enter_at_least_1_char = "You must enter at least one character."; + txt_browser_not_supported = "JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"></link><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"></link><style type="text/css"> +noscript{ + font-weight:bold; +} +input { + margin-bottom: 5px; + margin-top: 2px; +} +.folder { + display: block; + height: 22px; + padding-left: 20px; + background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat; +} +span.contentsTab { + padding-left: 20px; + background: url(../common/images/toc-icon.png) no-repeat 0 center; +} +span.searchTab { + padding-left: 20px; + background: url(../common/images/search-icon.png) no-repeat 0 center; +} + +/* Overide jquery treeview's defaults for ul. */ +.treeview ul { + background-color: transparent; + margin-top: 4px; +} +#webhelp-currentid { + background-color: #D8D8D8 !important; +} +.treeview .hover { color: black; } +.filetree li span a { text-decoration: none; font-size: 12px; color: #517291; } + +/* Override jquery-ui's default css customizations. These are supposed to take precedence over those.*/ +.ui-widget-content { + border: 0px; + background: none; + color: none; +} +.ui-widget-header { + color: #e9e8e9; + border-left: 1px solid #e5e5e5; + border-right: 1px solid #e5e5e5; + border-bottom: 1px solid #bbc4c5; + border-top: 4px solid #e5e5e5; + border: medium none; + background: #F4F4F4; /* old browsers */ + background: -moz-linear-gradient(top, #F4F4F4 0%, #E6E4E5 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#F4F4F4), color-stop(100%,#E6E4E5)); /* webkit */ + font-weight: none; +} +.ui-widget-header a { color: none; } +.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { +border: none; background: none; font-weight: none; color: none; } +.ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: black; text-decoration: none; } +.ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: none; background: none; font-weight: none; color: none; } + +.ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: none; background: none; font-weight: none; color: none; } +.ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { + color: black; text-decoration: none; + background: #C6C6C6; /* old browsers */ + background: -moz-linear-gradient(top, #C6C6C6 0%, #D8D8D8 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#C6C6C6), color-stop(100%,#D8D8D8)); /* webkit */ + -webkit-border-radius:15px; -moz-border-radius:10px; + border: 1px solid #f1f1f1; +} +.ui-corner-all { border-radius: 0 0 0 0; } + +.ui-tabs { padding: .2em;} +.ui-tabs .ui-tabs-nav li { top: 0px; margin: -2px 0 1px; text-transform: uppercase; font-size: 10.5px;} +.ui-tabs .ui-tabs-nav li a { padding: .25em 2em .25em 1em; margin: .5em; text-shadow: 0 1px 0 rgba(255,255,255,.5); } + </style><script type="text/javascript" src="../common/browserDetect.js"></script><script type="text/javascript" src="../common/jquery/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"></script><script type="text/javascript" src="search/l10n.js"></script><script type="text/javascript" src="search/htmlFileInfoList.js"></script><script type="text/javascript" src="search/nwSearchFnt.js"></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"></script><script type="text/javascript" src="search/index-2.js"></script><script type="text/javascript" src="search/index-3.js"></script></head><body><div id="he ader"><a target="_blank" href="#"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt=" Documentation"></img></a><h1>README: Web-based Help from DocBook XML<br></br>Using the package</h1><div id="navheader"><table class="navLinks"><tr><td><a id="showHideButton" href="javascript:showHideToc();" class="pointLeft" tabindex="5" title="Hide TOC tree">Sidebar + </a></td><td><a accesskey="p" class="navLinkPrevious" tabindex="5" href="ch02s01.html">Prev</a> + | + <a accesskey="u" class="navLinkUp" tabindex="5" href="ch02.html">Up</a> + | + <a accesskey="n" class="navLinkNext" tabindex="5" href="ch02s02s01.html">Next</a></td></tr></table></div></div><div id="content"><noscript>JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.</noscript><div class="section"><div xmlns="" class="titlepage"><div><div><h2 xmlns="http://www.w3.org/1999/xhtml" class="title" style="clear: both"><a id="id376328"></a>Using and customizing the output</h2></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="ch02s02s01.html">Recommended Apache configurations</a></span></dt></dl></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" 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" style="list-style-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" style="list-style-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><script type="text/javascript" src="../common/main.js"></script><div class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><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="ch02s02s01.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 id="sidebar"><div id="leftnavigation" style="padding-top:3px;"><div id="tabs"><ul><li><a href="#treeDiv" style="outline:0;" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="#searchDiv" style="outline:0;" tabindex="1" onclick="doSearch()"><span class ="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"></img><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li><span class="file"><a href="ch01.html" tabindex="1">Introduction</a></span></li><li><span class="file"><a href="ch02.html" tabindex="1">Using the package</a></span><ul><li><span class="file"><a href="ch02s01.html" tabindex="1">Generating webhelp output</a></span></li><li id="webhelp-currentid"><span class="file"><a href="ch02s02.html" tabindex="1">Using and customizing the output</a></span><ul><li><span class="file"><a href="ch02s02s01.html" tabindex="1">Recommended Apache configurations</a></span></li></ul></li><li><span class="file"><a href="ch02s03.html" tabindex="1">Search indexing</a></span></li><li><span class="file"><a href="ch02s04.html" tabindex="1">Adding support for other (non-CJKV) languages</a></span></li><li><sp an class="file"><a href="ch02s05.html" tabindex="1">Adding images</a></span></li></ul></li><li><span class="file"><a href="ch03.html" tabindex="1">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html" tabindex="1">Design</a></span></li><li><span class="file"><a href="ch03s02.html" tabindex="1">Search</a></span><ul><li><span class="file"><a href="ch03s02s01.html" tabindex="1">New Stemmers</a></span></li></ul></li></ul></li><li><span class="file"><a href="ch04.html" tabindex="1">FAQ</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(searchForm);return false" name="searchForm" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="search" class="searchText" tabindex="1"></input> <input onclick="Verifie(searchForm)" type="button" class="searchButton" value="Go" id="doSearch" tabindex="1"></input></center></fieldset></form></div><div id="searchResults"><center></center></div><p class="searchHighlight"><a href="#" onclick="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div></body></html> Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02.html ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02s01.html URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02s01.html?rev=1395298&view=auto ============================================================================== --- ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02s01.html (added) +++ ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02s01.html Sun Oct 7 13:31:52 2012 @@ -0,0 +1,135 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7"></meta> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta> +<title>Recommended Apache configurations</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></meta><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="up" href="ch02s02.html" title="Using and customizing the output"></link><link rel="prev" href="ch02s02.html" title="Using and customizing the output"></link><link rel="next" href="ch02s03.html" title="Search indexing"></link><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-1055"; + var language = "en"; + var w = new Object(); + //Localization + txt_filesfound = 'Results'; + txt_enter_at_least_1_char = "You must enter at least one character."; + txt_browser_not_supported = "JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"></link><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"></link><style type="text/css"> +noscript{ + font-weight:bold; +} +input { + margin-bottom: 5px; + margin-top: 2px; +} +.folder { + display: block; + height: 22px; + padding-left: 20px; + background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat; +} +span.contentsTab { + padding-left: 20px; + background: url(../common/images/toc-icon.png) no-repeat 0 center; +} +span.searchTab { + padding-left: 20px; + background: url(../common/images/search-icon.png) no-repeat 0 center; +} + +/* Overide jquery treeview's defaults for ul. */ +.treeview ul { + background-color: transparent; + margin-top: 4px; +} +#webhelp-currentid { + background-color: #D8D8D8 !important; +} +.treeview .hover { color: black; } +.filetree li span a { text-decoration: none; font-size: 12px; color: #517291; } + +/* Override jquery-ui's default css customizations. These are supposed to take precedence over those.*/ +.ui-widget-content { + border: 0px; + background: none; + color: none; +} +.ui-widget-header { + color: #e9e8e9; + border-left: 1px solid #e5e5e5; + border-right: 1px solid #e5e5e5; + border-bottom: 1px solid #bbc4c5; + border-top: 4px solid #e5e5e5; + border: medium none; + background: #F4F4F4; /* old browsers */ + background: -moz-linear-gradient(top, #F4F4F4 0%, #E6E4E5 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#F4F4F4), color-stop(100%,#E6E4E5)); /* webkit */ + font-weight: none; +} +.ui-widget-header a { color: none; } +.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { +border: none; background: none; font-weight: none; color: none; } +.ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: black; text-decoration: none; } +.ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: none; background: none; font-weight: none; color: none; } + +.ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: none; background: none; font-weight: none; color: none; } +.ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { + color: black; text-decoration: none; + background: #C6C6C6; /* old browsers */ + background: -moz-linear-gradient(top, #C6C6C6 0%, #D8D8D8 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#C6C6C6), color-stop(100%,#D8D8D8)); /* webkit */ + -webkit-border-radius:15px; -moz-border-radius:10px; + border: 1px solid #f1f1f1; +} +.ui-corner-all { border-radius: 0 0 0 0; } + +.ui-tabs { padding: .2em;} +.ui-tabs .ui-tabs-nav li { top: 0px; margin: -2px 0 1px; text-transform: uppercase; font-size: 10.5px;} +.ui-tabs .ui-tabs-nav li a { padding: .25em 2em .25em 1em; margin: .5em; text-shadow: 0 1px 0 rgba(255,255,255,.5); } + </style><script type="text/javascript" src="../common/browserDetect.js"></script><script type="text/javascript" src="../common/jquery/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"></script><script type="text/javascript" src="search/l10n.js"></script><script type="text/javascript" src="search/htmlFileInfoList.js"></script><script type="text/javascript" src="search/nwSearchFnt.js"></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"></script><script type="text/javascript" src="search/index-2.js"></script><script type="text/javascript" src="search/index-3.js"></script></head><body><div id="he ader"><a target="_blank" href="#"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt=" Documentation"></img></a><h1>README: Web-based Help from DocBook XML<br></br>Using and customizing the output</h1><div id="navheader"><table class="navLinks"><tr><td><a id="showHideButton" href="javascript:showHideToc();" class="pointLeft" tabindex="5" title="Hide TOC tree">Sidebar + </a></td><td><a accesskey="p" class="navLinkPrevious" tabindex="5" href="ch02s02.html">Prev</a> + | + <a accesskey="u" class="navLinkUp" tabindex="5" href="ch02s02.html">Up</a> + | + <a accesskey="n" class="navLinkNext" tabindex="5" href="ch02s03.html">Next</a></td></tr></table></div></div><div id="content"><noscript>JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.</noscript><div class="section"><div xmlns="" class="titlepage"><div><div><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id376463"></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><span><img src="../common/images/callouts/1.png" alt="1" border="0"></img></span> + + # 480 weeks + <FilesMatch "\.(ico|pdf|flv|jpg|jpeg|png|gif|js|css|swf)$"> # <a id="CachingSettings"></a><span><img src="../common/images/callouts/2.png" alt="2" border="0"></img></span> + 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><span><img src="../common/images/callouts/3.png" alt="3" border="0"></img></span> + 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"><span><img src="../common/images/callouts/1.png" alt="1" border="0"></img></span></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"><span><img src="../common/images/callouts/2.png" alt="2" border="0"></img></span></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"><span><img src="../common/images/callouts/3.png" alt="3" border="0"></img></span></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><script type="text/javascript" src="../common/main.js"></script><div class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02s02.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 id="sidebar"><div id="leftnavigation" style="padding-top:3px;"><div id="tabs"><ul><li><a href="#treeDiv" style="outline:0;" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="#searchDiv" style="outline:0;" tabindex="1" onclick="doSearch( )"><span class="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"></img><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li><span class="file"><a href="ch01.html" tabindex="1">Introduction</a></span></li><li><span class="file"><a href="ch02.html" tabindex="1">Using the package</a></span><ul><li><span class="file"><a href="ch02s01.html" tabindex="1">Generating webhelp output</a></span></li><li><span class="file"><a href="ch02s02.html" tabindex="1">Using and customizing the output</a></span><ul><li id="webhelp-currentid"><span class="file"><a href="ch02s02s01.html" tabindex="1">Recommended Apache configurations</a></span></li></ul></li><li><span class="file"><a href="ch02s03.html" tabindex="1">Search indexing</a></span></li><li><span class="file"><a href="ch02s04.html" tabindex="1">Adding support for other (non-CJKV) languages</a></spa n></li><li><span class="file"><a href="ch02s05.html" tabindex="1">Adding images</a></span></li></ul></li><li><span class="file"><a href="ch03.html" tabindex="1">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html" tabindex="1">Design</a></span></li><li><span class="file"><a href="ch03s02.html" tabindex="1">Search</a></span><ul><li><span class="file"><a href="ch03s02s01.html" tabindex="1">New Stemmers</a></span></li></ul></li></ul></li><li><span class="file"><a href="ch04.html" tabindex="1">FAQ</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(searchForm);return false" name="searchForm" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="search" class="searchText" tabindex="1"></input> <input onclick="Verifie(searchForm)" type="button" class="searchButton" value="Go" id="doSearch" tabindex="1"></input></center></fieldset></f orm></div><div id="searchResults"><center></center></div><p class="searchHighlight"><a href="#" onclick="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div></body></html> Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02s01.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02s01.html ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s02s01.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s03.html URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s03.html?rev=1395298&view=auto ============================================================================== --- ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s03.html (added) +++ ofbiz/trunk/applications/content/template/docbook/webhelp/docs/content/ch02s03.html Sun Oct 7 13:31:52 2012 @@ -0,0 +1,119 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head> +<meta http-equiv="X-UA-Compatible" content="IE=7"></meta> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta> +<title>Search indexing</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></meta><link rel="home" href="index.html" title="README: Web-based Help from DocBook XML"></link><link rel="up" href="ch02.html" title="Using the package"></link><link rel="prev" href="ch02s02s01.html" title="Recommended Apache configurations"></link><link rel="next" href="ch02s04.html" title="Adding support for other (non-CJKV) languages"></link><script type="text/javascript"> + //The id for tree cookie + var treeCookieId = "treeview-1055"; + var language = "en"; + var w = new Object(); + //Localization + txt_filesfound = 'Results'; + txt_enter_at_least_1_char = "You must enter at least one character."; + txt_browser_not_supported = "JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site."; + txt_please_wait = "Please wait. Search in progress..."; + txt_results_for = "Results for: "; + </script><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"></link><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"></link><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"></link><style type="text/css"> +noscript{ + font-weight:bold; +} +input { + margin-bottom: 5px; + margin-top: 2px; +} +.folder { + display: block; + height: 22px; + padding-left: 20px; + background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat; +} +span.contentsTab { + padding-left: 20px; + background: url(../common/images/toc-icon.png) no-repeat 0 center; +} +span.searchTab { + padding-left: 20px; + background: url(../common/images/search-icon.png) no-repeat 0 center; +} + +/* Overide jquery treeview's defaults for ul. */ +.treeview ul { + background-color: transparent; + margin-top: 4px; +} +#webhelp-currentid { + background-color: #D8D8D8 !important; +} +.treeview .hover { color: black; } +.filetree li span a { text-decoration: none; font-size: 12px; color: #517291; } + +/* Override jquery-ui's default css customizations. These are supposed to take precedence over those.*/ +.ui-widget-content { + border: 0px; + background: none; + color: none; +} +.ui-widget-header { + color: #e9e8e9; + border-left: 1px solid #e5e5e5; + border-right: 1px solid #e5e5e5; + border-bottom: 1px solid #bbc4c5; + border-top: 4px solid #e5e5e5; + border: medium none; + background: #F4F4F4; /* old browsers */ + background: -moz-linear-gradient(top, #F4F4F4 0%, #E6E4E5 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#F4F4F4), color-stop(100%,#E6E4E5)); /* webkit */ + font-weight: none; +} +.ui-widget-header a { color: none; } +.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { +border: none; background: none; font-weight: none; color: none; } +.ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: black; text-decoration: none; } +.ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: none; background: none; font-weight: none; color: none; } + +.ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: none; background: none; font-weight: none; color: none; } +.ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { + color: black; text-decoration: none; + background: #C6C6C6; /* old browsers */ + background: -moz-linear-gradient(top, #C6C6C6 0%, #D8D8D8 100%); /* firefox */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#C6C6C6), color-stop(100%,#D8D8D8)); /* webkit */ + -webkit-border-radius:15px; -moz-border-radius:10px; + border: 1px solid #f1f1f1; +} +.ui-corner-all { border-radius: 0 0 0 0; } + +.ui-tabs { padding: .2em;} +.ui-tabs .ui-tabs-nav li { top: 0px; margin: -2px 0 1px; text-transform: uppercase; font-size: 10.5px;} +.ui-tabs .ui-tabs-nav li a { padding: .25em 2em .25em 1em; margin: .5em; text-shadow: 0 1px 0 rgba(255,255,255,.5); } + </style><script type="text/javascript" src="../common/browserDetect.js"></script><script type="text/javascript" src="../common/jquery/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"></script><script type="text/javascript" src="search/l10n.js"></script><script type="text/javascript" src="search/htmlFileInfoList.js"></script><script type="text/javascript" src="search/nwSearchFnt.js"></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"></script><script type="text/javascript" src="search/index-2.js"></script><script type="text/javascript" src="search/index-3.js"></script></head><body><div id="he ader"><a target="_blank" href="#"><img style="margin-right: 2px; height: 59px; padding-right: 25px; padding-top: 8px" align="right" src="../common/images/logo.png" alt=" Documentation"></img></a><h1>README: Web-based Help from DocBook XML<br></br>Using the package</h1><div id="navheader"><table class="navLinks"><tr><td><a id="showHideButton" href="javascript:showHideToc();" class="pointLeft" tabindex="5" title="Hide TOC tree">Sidebar + </a></td><td><a accesskey="p" class="navLinkPrevious" tabindex="5" href="ch02s02s01.html">Prev</a> + | + <a accesskey="u" class="navLinkUp" tabindex="5" href="ch02.html">Up</a> + | + <a accesskey="n" class="navLinkNext" tabindex="5" href="ch02s04.html">Next</a></td></tr></table></div></div><div id="content"><noscript>JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.</noscript><div class="section"><div xmlns="" class="titlepage"><div><div><h2 xmlns="http://www.w3.org/1999/xhtml" class="title" style="clear: both"><a id="id376572"></a>Search indexing</h2></div></div></div> +<p>Run <span class="command"><strong>ant index</strong></span> in the webhelp directory to index the content. Running + <span class="command"><strong>ant webhelp</strong></span> will do the indexing as part of the process as well.</p><p>Here's some detailed information about invoking the indexer. The indexing process is + pretty smooth, so probably you doesn't need to be concerned with following details. Webhelp + Ant script does all the needed bits.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Following should be in the CLASSPATH.</p><p> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p><code class="filename">webhelpindexer.jar</code>, + <code class="filename">lucene-analyzers-3.0.0.jar</code>, + <code class="filename">lucene-core-3.0.0.jar</code> - These three are available in the + extensions/ directory of docsbook-xsl-1.76.1, and is automatically fetched to the + webhelp's Ant script. Go for a XSL snapshot if you can which contains the latest + version http://docbook.sourceforge.net/snapshot/</p></li><li class="listitem"><p><code class="filename">xercesImpl.jar</code>, <code class="filename"> xml-apis.jar</code> - + These two comes by default with Ant 1.8.0 or prior versions. These are available + under /usr/share/java directory of Linux distributions as well. Else, you may have + to download, and put them to <code class="filename">jre/lib/endorsed</code>.</p></li></ul></div><p> + </p></li><li class="listitem"><p>The main class is <code class="classname">com.nexwave.nquindexer.IndexerMain</code> for the + version 1.76.1+. It's <code class="classname">com.nexwave.nquindexer.IndexerTask</code> for the + versions 1.76.0 and 1.76.1.</p><p> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>Needs two parameters as command-line arguments:</p><p> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: square; "><li class="listitem"><p>The folder where the files to be indexed reside</p></li></ul></div><p> + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: square; "><li class="listitem"><p>(Optional) language. defaults to "en". See build.properties for + details</p></li></ul></div><p> + </p></li></ul></div><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>We have changed the way we invoke the webhelp indexer from the Ant Task to + <code class="code">indexertask</code> to direct invocation. This seems to have remove the + <code class="envar">CLASSPATH</code> issue some people were having.</p></div><p> + </p></li></ul></div><a id="id376733" class="indexterm"></a><a id="id376745" class="indexterm"></a><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. </p><a id="id376768" class="indexterm"></a><a id="id376777" class="indexterm"></a></div><script type="text/javascript" src="../common/main.js"></script><div class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s02s01.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 id="sidebar"><div id="leftnavigation" style="padding-top:3px;"><div id="tabs"><ul><li><a href="#treeDiv" style="outline:0;" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="# searchDiv" style="outline:0;" tabindex="1" onclick="doSearch()"><span class="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"></img><div id="ulTreeDiv" style="display:none"><ul id="tree" class="filetree"><li><span class="file"><a href="ch01.html" tabindex="1">Introduction</a></span></li><li><span class="file"><a href="ch02.html" tabindex="1">Using the package</a></span><ul><li><span class="file"><a href="ch02s01.html" tabindex="1">Generating webhelp output</a></span></li><li><span class="file"><a href="ch02s02.html" tabindex="1">Using and customizing the output</a></span><ul><li><span class="file"><a href="ch02s02s01.html" tabindex="1">Recommended Apache configurations</a></span></li></ul></li><li id="webhelp-currentid"><span class="file"><a href="ch02s03.html" tabindex="1">Search indexing</a></span></li><li><span class="file"><a href="ch02s04.html" tabind ex="1">Adding support for other (non-CJKV) languages</a></span></li><li><span class="file"><a href="ch02s05.html" tabindex="1">Adding images</a></span></li></ul></li><li><span class="file"><a href="ch03.html" tabindex="1">Developer Docs</a></span><ul><li><span class="file"><a href="ch03s01.html" tabindex="1">Design</a></span></li><li><span class="file"><a href="ch03s02.html" tabindex="1">Search</a></span><ul><li><span class="file"><a href="ch03s02s01.html" tabindex="1">New Stemmers</a></span></li></ul></li></ul></li><li><span class="file"><a href="ch04.html" tabindex="1">FAQ</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(searchForm);return false" name="searchForm" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="search" class="searchText" tabindex="1"></input> <input onclick="Verifie(searchForm)" type="button" class="searchButton" value="G o" id="doSearch" tabindex="1"></input></center></fieldset></form></div><div id="searchResults"><center></center></div><p class="searchHighlight"><a href="#" onclick="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div></body></html> |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |