Diff for /bookmarktools/www/documentation.html between versions 1.17 and 1.18

version 1.17, 2009/02/06 15:53:16 version 1.18, 2009/02/28 07:41:45
Line 1 Line 1
<html><?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
         <head>          <head>
                <link rel="stylesheet" href="./project.css" type="text/css" />                <link rel="stylesheet" href="project.css" type="text/css" />
                                   
                <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />                <meta http-equiv="Content-Type" content="text/html" />
                 <meta content="text/css" http-equiv="Content-Style-Type" />                  <meta content="text/css" http-equiv="Content-Style-Type" />
                                   
                 <script type="text/javascript" src="js/prototype.js"></script>  
                 <script type="text/javascript" src="js/scriptaculous.js?load=effects,builder"></script>  
                 <script type="text/javascript" src="js/lightbox.js"></script>  
                   
                 <script type="text/javascript" src="scripts/shCore.js"></script>                  <script type="text/javascript" src="scripts/shCore.js"></script>
                 <script type="text/javascript" src="scripts/shBrushBash.js"></script>                  <script type="text/javascript" src="scripts/shBrushBash.js"></script>
                 <script type="text/javascript" src="scripts/shBrushCpp.js"></script>                  <script type="text/javascript" src="scripts/shBrushCpp.js"></script>
Line 31 Line 30
                 <script type="text/javascript" src="scripts/shBrushVb.js"></script>                  <script type="text/javascript" src="scripts/shBrushVb.js"></script>
                 <script type="text/javascript" src="scripts/shBrushXml.js"></script>                  <script type="text/javascript" src="scripts/shBrushXml.js"></script>
                                   
                 <link rel="stylesheet" href="css/lightbox.css" type="text/css" media="screen" />  
                 <link type="text/css" rel="stylesheet" href="styles/shCore.css"/>                  <link type="text/css" rel="stylesheet" href="styles/shCore.css"/>
                 <link type="text/css" rel="stylesheet" href="styles/shThemeDefault.css"/>                  <link type="text/css" rel="stylesheet" href="styles/shThemeDefault.css"/>
                                   
Line 41 Line 39
                 </script>                  </script>
         </head>          </head>
         <body>          <body>
                        <table style="width: 100%;">
                <div id="main">                        <tbody>
                                                <tr>
                        <div id="menu-container">                                        <td>
                                <ul id="simple-menu">                                                <div id="main">
                                        <li><a id="home" href="./index.html" title="Home">Home</a></li>                                                        <div id="menu-container">
                                        <li><a id="download" href="./installation.html" title="Home">Download</a></li>                                                                <a href="http://www.mozdev.org" title="mozdev.org - free project hosting for the mozilla community">
                                        <li><a id="docu" href="./documentation.html" title="Home" class="current">Documentation</a></li>                                                                        <img src="http://www.mozdev.org/sharedimages/mozdev_tiny.png" width="80" height="15" alt="mozdev.org" />
                                        <li><a id="src" href="./source.html" title="Home">Source Code</a></li>                                                                </a>
                                        <li><a id="bugs" href="./bugs.html" title="Home">Bugs</a></li>                                                                <div id="project-head">Bookmark Tools</div>
                                        <li><a id="screenshots" href="./screenshots.html" title="Home">Screenshots</a></li>                                                                <div id="project-desc">Developer <a class="simpleLink" href="mailto:maik.gollnick@gmx.de">Maik Gollnick</a></div>
                                </ul>                                                                <ul id="simple-menu">
                        </div>                                                                        <li><a href="index.html" title="Home">Home</a></li>
                                                                                                <li><a href="installation.html" title="Download">Download</a></li>
                        <div id="content">                                                                        <li><a href="documentation.html" title="Documentation" class="current">Documentation</a></li>
                                                                                                <li><a href="source.html" title="Source Code">Source Code</a></li>
                                <div>                                                                        <li><a href="bugs.html" title="Bugs">Bugs</a></li>
                                        <h3><a name="Content">Content:</a></h3>                                                                        <li><a href="screenshots.html" title="Screenshots">Screenshots</a></li>
                                        <ul>                                                                </ul>
                                                <li><strong>USER GUIDE</strong></li>                                                        </div>
                                                <li><strong>XPCOM</strong>                                                        <div id="menu-line"></div>
                                                        <ul> 
                                                                <li><a href="#HowToIndex">HowTo use the index component</a></li> 
                                                                <li><a href="#HowToTidy">HowTo use the tidy component</a></li> 
                                                        </ul> 
                                                </li> 
                                                <li><strong>OTHER</strong></li> 
                                        </ul> 
                                        <br /> 
                                </div> 
 
                                <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> 
                                <h4>Writing::</h4> 
                                <pre class="brush: js font-size: 80%"> 
 
                                        //initialize file object (location: profile directory) 
                                        var file = Components.classes["@mozilla.org/file/directory_service;1"] 
                                                                .getService(Components.interfaces.nsIProperties) 
                                                                .get("ProfD", Components.interfaces.nsIFile); 
 
                                        file.append("index"); //folder named 'index' 
                                         
                                        if(!file.exists() || !file.isDirectory())  
                                                file.create(Components.interfaces.nsIFile.DIRECTORY_TYPE, 0777); 
 
                                        //initialize xpcom 
                                        var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance(); 
                                        writer = writer.QueryInterface(Components.interfaces.ICLWriter); 
                                         
                                        //set path 
                                        writer.setPath(file.path); 
                                         
                                        //create index document 
                                        var cl_document = new Object(); 
                                        cl_document.primaryKey = "key0";                                                //this shoud be a unique key 
                                        cl_document.name = "CLucene Indexer";                                   //document name 
                                        cl_document.lastModifiedDate = new Date().getTime();    //date in millis 
                                        cl_document.content = "Hello World!";                                   //some content 
                                         
                                        //append document 
                                        writer.appendDocument( 
                                                cl_document.primaryKey, 
                                                cl_document.name, 
                                                cl_document.lastModifiedDate, 
                                                cl_document.content 
                                        ); 
                                         
                                        //optimize data 
                                        writer.optimize(); 
                                         
                                </pre> 
 
                                <h4>Searching::</h4> 
                                <pre class="brush: js font-size: 80%"> 
 
                                        //initialize xpcom 
                                        var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance(); 
                                        reader = reader.QueryInterface(Components.interfaces.ICLReader); 
                                         
                                        //set path 
                                        reader.setPath(file.path); //see section 'Writing' 
                                         
                                        if(reader.exists()){ //check for index data 
                                                 
                                                var query = "Hell*"; 
                                                var results = Components.classes["@mozilla.org/array;1"] 
                                                                                .createInstance(Components.interfaces.nsIMutableArray); 
                                                reader.search(query, results); 
                                                 
                                                var e = results.enumerate(); 
                                                while (e.hasMoreElements()) { 
                                                        var resultNode = e.getNext().QueryInterface(Components.interfaces.IResultNode); 
                                                                                                                   
                                                        //Object: resultNode                                                        <div id="content">
                                                        //-> resultNode.primaryKey                                                                
                                                        //-> resultNode.score                                                                <div>
                                                        alert(resultNode.primaryKey + "\n" + resultNode.score);                                                                        <h3><a name="Content">Content:</a></h3>
                                                }                                                                        <ul>
                                                                                                                                <li><strong>USER GUIDE</strong></li>
                                        }else {                                                                                <li><strong>XPCOM</strong>
                                                //display message or do nothing                                                                                        <ul>
                                        }                                                                                                <li><a href="#HowToIndex">HowTo use the index component</a></li>
                                                                                                                                        <li><a href="#HowToTidy">HowTo use the tidy component</a></li>
                                </pre>                                                                                        </ul>
                                                                                </li>
                                <h4>Lookup::</h4>                                                                                <li><strong>OTHER</strong></li>
                                <pre class="brush: js font-size: 80%">                                                                        </ul>
                                                                        <br />
                                        //initialize xpcom                                                                </div>
                                        var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
                                        reader = reader.QueryInterface(Components.interfaces.ICLReader);                                                                <div class="separator"></div>
                                                                                                                
                                        //set path                                                                        <br />
                                        reader.setPath(file.path); //see section 'Writing'
                                                                                                                <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>
                                        var results = Components.classes["@mozilla.org/array;1"]                                                                        <h4>Writing::</h4>
                                                                        .createInstance(Components.interfaces.nsIMutableArray);                                                                        <pre class="brush: js font-size: 80%">
                                        reader.lookup(results);
                                                                                                                        //initialize file object (location: profile directory)
                                        var e = results.enumerate();                                                                                var file = Components.classes["@mozilla.org/file/directory_service;1"]
                                        while (e.hasMoreElements()) {                                                                                                        .getService(Components.interfaces.nsIProperties)
                                                var lookupNode = e.getNext().QueryInterface(Components.interfaces.ILookupNode);                                                                                                        .get("ProfD", Components.interfaces.nsIFile);
                                                
                                                //Object: lookupNode                                                                                file.append("index"); //folder named 'index'
                                                //-> lookupNode.primaryKey                                                                                
                                                //-> lookupNode.name                                                                                if(!file.exists() || !file.isDirectory()) 
                                                alert(lookupNode.primaryKey + "\n" + lookupNode.name);                                                                                        file.create(Components.interfaces.nsIFile.DIRECTORY_TYPE, 0777);
                                        }
                                                                                //initialize xpcom
                                </pre>                                                                                var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();
                                                                                writer = writer.QueryInterface(Components.interfaces.ICLWriter);
                                <h4>Delete documents::</h4>                                                                                
                                <pre class="brush: js font-size: 80%">                                                                                //set path
                                                                                writer.setPath(file.path);
                                        //initialize xpcom                                                                                
                                        var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();                                                                                //create index document
                                        writer = writer.QueryInterface(Components.interfaces.ICLWriter);                                                                                var cl_document = new Object();
                                                                                                                        cl_document.primaryKey = "key0";                                                //this shoud be a unique key
                                        //set path                                                                                cl_document.name = "CLucene Indexer";                                   //document name
                                        writer.setPath(file.path); //see section 'Writing'                                                                                cl_document.lastModifiedDate = new Date().getTime();    //date in millis
                                                                                                                        cl_document.content = "Hello World!";                                   //some content
                                        //delete documents with index 0, 5 and 2                                                                                
                                        var docs = [0, 5, 2];                                                                                //append document
                                        writer.deleteDocument(docs, docs.length);                                                                                writer.appendDocument(
                                                                                        cl_document.primaryKey,
                                </pre>                                                                                        cl_document.name,
                                                                                        cl_document.lastModifiedDate,
                                <br />                                                                                        cl_document.content
                                                                                );
                                <div class="separator"></div>                                                                                
                                                                                                                //optimize data
                                <h3><a href="#Content"><img src="./images/back.png" alt="back" title="back" /></a><a name="HowToTidy">HowTo use the tidy component (uses ctidy version 060405)</a></h3>                                                                                writer.optimize();
                                <h4>Cleanup::</h4>                                                                                
                                <pre class="brush: js font-size: 80%">                                                                        </pre>
                                        //initialize xpcom                                                                        <h4>Searching::</h4>
                                        var tidy = Components.classes["@bookmarktools.mozdev.org/repair/tidy;1"].createInstance();                                                                        <pre class="brush: js font-size: 80%">
                                        tidy = tidy.QueryInterface(Components.interfaces.ITidy);
                                                                                                                        //initialize xpcom
                                        var src = "                                                                                var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
                                        &lt;html&gt;                                                                                reader = reader.QueryInterface(Components.interfaces.ICLReader);
                                                &lt;head&gt;&lt;/head&gt;                                                                                
                                                &lt;body                                                                                //set path
                                                        broken body tag & no entity                                                                                reader.setPath(file.path); //see section 'Writing'
                                                &lt;/body&gt;                                                                                
                                        &lt;/html>";                                                                                if(reader.exists()){ //check for index data
                                                                                                                                
                                        //result contains the repaired html/xhtml/xml source                                                                                        var query = "Hell*";
                                        //otherwise a error message returned                                                                                        var results = Components.classes["@mozilla.org/array;1"]
                                        var result = tidy.cleanup(src);                                                                                                                        .createInstance(Components.interfaces.nsIMutableArray);
                                                                                                                                reader.search(query, results);
                                        if(result == "Tidy: no output"){                                                                                        
                                                alert("error returned");                                                                                        var e = results.enumerate();
                                        }else {                                                                                        while (e.hasMoreElements()) {
                                                alert(src);                                                                                                var resultNode = e.getNext().QueryInterface(Components.interfaces.IResultNode);
                                        }                                                                                                
                                                                                                                                        //Object: resultNode
                                </pre>                                                                                                //-> resultNode.primaryKey
                        </div>                                                                                                //-> resultNode.score
                                                                                                                        alert(resultNode.primaryKey + "\n" + resultNode.score);
                </div>                                                                                        }
                                                                                                                
                <div id="footer">                                                                                }else {
                                <div style="text-align: center;">                                                                                        //display message or do nothing
                    Project hosted on <a href="http://www.mozdev.org/">mozdev.org</a>.<br/> <a href="http://www.mozdev.org/copyright.html">Copyright</a> &copy; 2004. All rights reserved. <a href="http://www.mozdev.org/community/terms.html">Terms of Use</a>.                                                                                }
                </div>                                                                                
                </div>                                                                        </pre>
 
                                                                         <h4>Lookup::</h4>
                                                                         <pre class="brush: js font-size: 80%">
 
                                                                                 //initialize xpcom
                                                                                 var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
                                                                                 reader = reader.QueryInterface(Components.interfaces.ICLReader);
                                                                                 
                                                                                 //set path
                                                                                 reader.setPath(file.path); //see section 'Writing'
                                                                                 
                                                                                 var results = Components.classes["@mozilla.org/array;1"]
                                                                                                                 .createInstance(Components.interfaces.nsIMutableArray);
                                                                                 reader.lookup(results);
                                                                                 
                                                                                 var e = results.enumerate();
                                                                                 while (e.hasMoreElements()) {
                                                                                         var lookupNode = e.getNext().QueryInterface(Components.interfaces.ILookupNode);
                                                                                         
                                                                                         //Object: lookupNode
                                                                                         //-> lookupNode.primaryKey
                                                                                         //-> lookupNode.name
                                                                                         alert(lookupNode.primaryKey + "\n" + lookupNode.name);
                                                                                 }
 
                                                                         </pre>
 
                                                                         <h4>Delete documents::</h4>
                                                                         <pre class="brush: js font-size: 80%">
 
                                                                                 //initialize xpcom
                                                                                 var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();
                                                                                 writer = writer.QueryInterface(Components.interfaces.ICLWriter);
                                                                                 
                                                                                 //set path
                                                                                 writer.setPath(file.path); //see section 'Writing'
                                                                                 
                                                                                 //delete documents with index 0, 5 and 2
                                                                                 var docs = [0, 5, 2];
                                                                                 writer.deleteDocument(docs, docs.length);
 
                                                                         </pre>
 
                                                                         <br />
 
                                                                         <div class="separator"></div>
                                                                         
                                                                         <h3><a href="#Content"><img src="./images/back.png" alt="back" title="back" /></a><a name="HowToTidy">HowTo use the tidy component (uses ctidy version 060405)</a></h3>
                                                                         <h4>Cleanup::</h4>
                                                                         <pre class="brush: js font-size: 80%">
 
                                                                                 //initialize xpcom
                                                                                 var tidy = Components.classes["@bookmarktools.mozdev.org/repair/tidy;1"].createInstance();
                                                                                 tidy = tidy.QueryInterface(Components.interfaces.ITidy);
                                                                                 
                                                                                 var src = "
                                                                                 &lt;html&gt;
                                                                                         &lt;head&gt;&lt;/head&gt;
                                                                                         &lt;body
                                                                                                 broken body tag & no entity
                                                                                         &lt;/body&gt;
                                                                                 &lt;/html>";
                                                                                 
                                                                                 //result contains the repaired html/xhtml/xml source
                                                                                 //otherwise a error message returned
                                                                                 var result = tidy.cleanup(src);
                                                                                 
                                                                                 if(result == "Tidy: no output"){
                                                                                         alert("error returned");
                                                                                 }else {
                                                                                         alert(src);
                                                                                 }
                                                                                 
                                                                         </pre>
                                                                 </div>
                                                                 
                                                         </div>
                                                 </div>
                                         </td>
                                 </tr>
                                 <tr>
                                         <td>
                                                 <div id="footer">
                                                         <table>
                                                                 <tr>
                                                                         <td>
                                                                                 <a href="http://validator.w3.org/check?uri=referer">
                                                                                         <img src="http://www.w3.org/Icons/valid-xhtml10-blue"
                                                                                         alt="Valid XHTML 1.0 Strict" height="31" width="88" />
                                                                                 </a>
                                                                         </td>
                                                                         <td style="width: 100%;">
                                                                                 <div style="text-align: center;">
                                                                                         Project hosted on <a class="simpleLink" href="http://www.mozdev.org/">mozdev.org</a>.<br/> <a class="simpleLink" href="http://www.mozdev.org/copyright.html">Copyright</a> &copy; 2004. All rights reserved. <a class="simpleLink" href="http://www.mozdev.org/community/terms.html">Terms of Use</a>.
                                                                                 </div>
                                                                         </td>
                                                                         <td>
                                                                                 <a href="http://jigsaw.w3.org/css-validator/check/referer">
                                                                                         <img style="border:0;width:88px;height:31px"
                                                                                         src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
                                                                                         alt="Valid CSS!" />
                                                                                 </a>
                                                                         </td>
                                                                 </tr>
                                                         </table>
                                                 </div>
                                         </td>
                                 </tr>
                         </tbody>
                 </table>
         </body>          </body>
 </html>  
   
   </html>

Removed from v.1.17  
changed lines
  Added in v.1.18


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