Diff for /bookmarktools/www/documentation.html between versions 1.20 and 1.23

version 1.20, 2009/02/28 08:30:54 version 1.23, 2009/11/01 14:32:17
Line 58 Line 58
                                                                         <li><a href="source.html" title="Source Code">Source Code</a></li>                                                                          <li><a href="source.html" title="Source Code">Source Code</a></li>
                                                                         <li><a href="bugs.html" title="Bugs">Bugs</a></li>                                                                          <li><a href="bugs.html" title="Bugs">Bugs</a></li>
                                                                         <li><a href="screenshots.html" title="Screenshots">Screenshots</a></li>                                                                          <li><a href="screenshots.html" title="Screenshots">Screenshots</a></li>
                                                                        <li style="float: right;"><div style="color: black;">Hits: <?php include ('counter.php'); ?></div></li>                                                                        <!--<li style="float: right;"><div style="color: black;">Hits: </div></li>-->
                                                                 </ul>                                                                  </ul>
                                                         </div>                                                          </div>
                                                         <div id="menu-line"></div>                                                          <div id="menu-line"></div>
Line 68 Line 68
                                                                 <div>                                                                  <div>
                                                                         <h3><a name="Content">Content:</a></h3>                                                                          <h3><a name="Content">Content:</a></h3>
                                                                         <ul>                                                                          <ul>
                                                                                <li><strong>USER GUIDE</strong></li>                                                                                <li><strong>USER GUIDE</strong>
                                                                                         <ul>
                                                                                                 <li><a class="simpleLink" href="#">Searching</a></li>
                                                                                                 <li><a class="simpleLink" href="#">Indexing</a></li>
                                                                                         </ul>
                                                                                 </li>
                                                                                 <li><strong>XPCOM</strong>                                                                                  <li><strong>XPCOM</strong>
                                                                                         <ul>                                                                                          <ul>
                                                                                                 <li><a class="simpleLink" href="#HowToIndex">HowTo use the index component</a></li>                                                                                                  <li><a class="simpleLink" href="#HowToIndex">HowTo use the index component</a></li>
Line 84 Line 89
                                                                                                                                                   
                                                                 <br />                                                                  <br />
   
                                                                   <h3><a href="#Content"><img src="./images/back.png" alt="back" title="back" /></a><a>User Guide: Searching</a></h3>
                                                                   <ul>
                                                                           <li>
                                                                                   <h4>General</h4>
                                                                                   <div>
                                                                                           Not every search pattern is accepted by clucene. In case of invalid queries an
                                                                                           error will be thrown. To avoid this situation the following rules should be maintained:
                                                                                           <ul>
                                                                                                   <li>queries don't starts with wildcards</li>
                                                                                                   <li>query length should be greater then 2</li>
                                                                                                   <li>only us-ascii characters (8-bit) supported</li>
                                                                                           </ul>
                                                                                   </div>
                                                                           </li>
                                                                           <li>
                                                                                   <h4>Queries</h4>
                                                                                   <div>
                                                                                           The indexer is based on the c++ port of apaches lucene project. Therefore it
                                                                                           supports the whole query syntax, too. Mostly following wildcards are useful:
                                                                                           
                                                                                           <br /><br />
                                                                                           '*': Looks for terms with 0 or more characters.
                                                                                           <div class="example">
                                                                                           
                                                                                                   <h4>Example (works):</h4>
                                                                                                           eigenf* or eigenf*s
                                                                                                   <h4>Example (don't works):</h4>
                                                                                                           *faces or *
                                                                                           </div>
                                                                                           <br />
                                                                                           '?': Looks for terms that match that with the single character replaced.
                                                                                           <div class="example">
                                                                                                   <h4>Example (works):</h4>
                                                                                                           eigenf?ces or eigenface?
                                                                                                   <h4>Example (don't works):</h4>
                                                                                                           ?igenfaces or ?
                                                                                           </div>
                                                                                           The query parser includes a lot of useful wildcards to create a
                                                                                           efficient search request. For more details see <a class="simpleLink" href="http://lucene.apache.org/java/2_3_2/queryparsersyntax.html">query parser</a>.
                                                                                   </div>
                                                                           </li>
                                                                           <li>
                                                                                   <h4>Address Bar Support</h4>
                                                                                   <div>
                                                                                           From version 1.05 bookmark tools supports searching via address bar. Practically, this means that
                                                                                           you can enter every pattern (see section above) directly into the urlbar text field. Note, index
                                                                                           results are marked with a magnifier.
                                                                                   </div>
                                                                                   <h4>Example</h4>
                                                                                   <img src="./tutorial/tut_urlbar.png" alt="back" title="back" style="border: 1px solid black; margin-bottom: 20px;" />
                                                                           </li>
                                                                           <li style="clear: both;">
                                                                                   <h4>Finding relevant results</h4>
                                                                                   <div>
                                                                                           Each query returns a descending sorted list of search results. The sort property <strong>score</strong> is a factor
                                                                                           that describes the relevance of a clucene document. In other words, each returned bookmark is characterized
                                                                                           by a value that specifies how interesting is a result related to a query. Normally this value has data type float in range of
                                                                                           [0..1] but the extension displays a score with 0 to 100 as integer. Therefore a number like e.g. 0.0012312 results
                                                                                           in a score value 0 and isn't shown.
                                                                                           <br /><br />
                                                                                           Note, the urlbar hides every score value by default.
                                                                                   </div>                                                                  
                                                                           </li>
                                                                           <li style="clear: both;">
                                                                                   <h4>Sidebar features</h4>
                                                                                   <div>
                                                                                           The extended sidebar helps you to find bookmarks in your folder tree. If a search result is selected it is
                                                                                           displayed in the book tab below. Remember, in case of duplicates the first entry, that equals the selected
                                                                                           bookmark, will be shown.
                                                                                   </div>                                                                  
                                                                           </li>
                                                                   </ul>
                                                                   
                                                                   <br />
                                                                   <br />
                                                                   <!--
                                                                   <h3><a href="#Content"><img src="./images/back.png" alt="back" title="back" /></a><a name="">User Guide: Indexing</a></h3>
                                                                   <ul>
                                                                           <li>
                                                                                   <h4>Best Practice</h4>
                                                                                   <div>
                                                                                           It doesnt matter in which way you index bookmarks, but the following process
                                                                                           helps to setup the index as fast as possible. After install you should enter
                                                                                           the option panel under 'Extras/BookmarkTools/Configure..' and activate 'manual'
                                                                                           as build type. Now switch to the manage panel and push build to start indexing. 
                                                                                           After this the list labeled with 'Index' should display all successfully indexed 
                                                                                           bookmarks. Now return to the option panel and set build type 'automatically' to
                                                                                           force an index update every week(default).
                                                                                           <br /><br />
                                                                                           Note, restarting firefox is required.
                                                                                   </div>
                                                                           </li>
                                                                           <li>
                                                                                   <h4>Update Index Data</h4>
                                                                                   <div>
                                                                                           
                                                                                   </div>
                                                                           </li>
                                                                           <li>
                                                                                   <h4>Which kind of bookmarks are added to the index?</h4>
                                                                                   <div>
                                                                                           
                                                                                   </div>
                                                                           </li>
                                                                   </ul>-->
                                                                   
                                                                   
                                                                   
                                                                   <br style="clear: both; margin-top: 10px;" />
                                                                   <div class="separator"></div>
                                                                   <br />
                                                                   
                                                                 <h3><a href="#Content"><img src="./images/back.png" alt="back" title="back" /></a><a name="HowToIndex">HowTo use the index component (uses clucene-core-0.9.20)</a></h3>                                                                  <h3><a href="#Content"><img src="./images/back.png" alt="back" title="back" /></a><a name="HowToIndex">HowTo use the index component (uses clucene-core-0.9.20)</a></h3>
                                                                 <h4>Writing::</h4>                                                                  <h4>Writing::</h4>
                                                                 <pre class="brush: js font-size: 80%">                                                                  <pre class="brush: js font-size: 80%">
Line 225 Line 342
                                                                         if(result == "Tidy: no output"){                                                                          if(result == "Tidy: no output"){
                                                                                 alert("error returned");                                                                                  alert("error returned");
                                                                         }else {                                                                          }else {
                                                                                alert(src);                                                                                alert(result);
                                                                         }                                                                          }
                                                                                                                                                   
                                                                 </pre>                                                                  </pre>

Removed from v.1.20  
changed lines
  Added in v.1.23


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>