Diff for /bookmarktools/www/documentation.html between versions 1.15 and 1.16

version 1.15, 2009/02/06 12:01:00 version 1.16, 2009/02/06 14:26:39
Line 1 Line 1
<!-- MAIN CONTENT --><html>
        <head>
<br /><br />                <link rel="stylesheet" href="./project.css" type="text/css" />
                
<div class="content">                <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
        <h2>Content:</h2>                <meta content="text/css" http-equiv="Content-Style-Type" />
        <ul>                
                <li><strong>USER GUIDE</strong></li>                <script type="text/javascript" src="js/prototype.js"></script>
                <li><strong>XPCOM</strong>                <script type="text/javascript" src="js/scriptaculous.js?load=effects,builder"></script>
                        <ul>                <script type="text/javascript" src="js/lightbox.js"></script>
                                <li><a href="#HowToIndex">HowTo use the index component</a></li>                
                                <li><a href="#HowToTidy">HowTo use the tidy component</a></li>                <script type="text/javascript" src="scripts/shCore.js"></script>
                        </ul>                <script type="text/javascript" src="scripts/shBrushBash.js"></script>
                </li>                <script type="text/javascript" src="scripts/shBrushCpp.js"></script>
                <li><strong>OTHER</strong></li>
        </ul>                <script type="text/javascript" src="scripts/shBrushCSharp.js"></script>
        <br />                <script type="text/javascript" src="scripts/shBrushCss.js"></script>
</div>                <script type="text/javascript" src="scripts/shBrushDelphi.js"></script>
                <script type="text/javascript" src="scripts/shBrushDiff.js"></script>
<br />                <script type="text/javascript" src="scripts/shBrushGroovy.js"></script>
                <script type="text/javascript" src="scripts/shBrushJava.js"></script>
<h2><a name="HowToIndex" style="text-decoration: underline;">HowTo use the index component (uses clucene-core-0.9.20)</a></h2>
<h3>Writing::</h3>                <script type="text/javascript" src="scripts/shBrushJScript.js"></script>
<pre class="brush: js">                <script type="text/javascript" src="scripts/shBrushPhp.js"></script>
                <script type="text/javascript" src="scripts/shBrushPlain.js"></script>
        //initialize file object (location: profile directory)                <script type="text/javascript" src="scripts/shBrushPython.js"></script>
        var file = Components.classes["@mozilla.org/file/directory_service;1"]                <script type="text/javascript" src="scripts/shBrushRuby.js"></script>
                                .getService(Components.interfaces.nsIProperties)                <script type="text/javascript" src="scripts/shBrushScala.js"></script>
                                .get("ProfD", Components.interfaces.nsIFile);
                <script type="text/javascript" src="scripts/shBrushSql.js"></script>
        file.append("index"); //folder named 'index'                <script type="text/javascript" src="scripts/shBrushVb.js"></script>
                        <script type="text/javascript" src="scripts/shBrushXml.js"></script>
        if(!file.exists() || !file.isDirectory())                 
                file.create(Components.interfaces.nsIFile.DIRECTORY_TYPE, 0777);                <link rel="stylesheet" href="css/lightbox.css" type="text/css" media="screen" />
                <link type="text/css" rel="stylesheet" href="styles/shCore.css"/>
        //initialize xpcom                <link type="text/css" rel="stylesheet" href="styles/shThemeDefault.css"/>
        var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();                
        writer = writer.QueryInterface(Components.interfaces.ICLWriter);                <script type="text/javascript">
                                SyntaxHighlighter.config.clipboardSwf = 'scripts/clipboard.swf';
        //set path                        SyntaxHighlighter.all();
        writer.setPath(file.path);                </script>
                </head>
        //create index document        <body>
        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> 
 
<h3>Searching::</h3> 
<pre class="brush: js"> 
 
        //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                <div id="main">
                                   
                var query = "Hell*";                        <div id="menu-container">
                var results = Components.classes["@mozilla.org/array;1"]                                <ul id="simple-menu">
                                                .createInstance(Components.interfaces.nsIMutableArray);                                        <li><a id="home" href="./index.html" title="Home">Home</a></li>
                reader.search(query, results);                                        <li><a id="download" href="./installation.html" title="Home">Download</a></li>
                                                        <li><a id="docu" href="./documentation.html" title="Home" class="current">Documentation</a></li>
                var e = results.enumerate();                                        <li><a id="src" href="./source.html" title="Home">Source Code</a></li>
                while (e.hasMoreElements()) {                                        <li><a id="bugs" href="./bugs.html" title="Home">Bugs</a></li>
                        var resultNode = e.getNext().QueryInterface(Components.interfaces.IResultNode);                                        <li><a id="screenshots" href="./screenshots.html" title="Home">Screenshots</a></li>
                                 </ul>
                         </div>
                                                   
                        //Object: resultNode                        <div id="content">
                        //-> resultNode.primaryKey                        
                        //-> resultNode.score                                <div>
                        alert(resultNode.primaryKey + "\n" + resultNode.score);                                        <h3>Content:</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>
<h3>Lookup::</h3>                                                <li><strong>OTHER</strong></li>
<pre class="brush: js">                                        </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 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);
<h3>Delete documents::</h3>                                        
<pre class="brush: js">                                        //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
                                        );
<h2><a name="HowToTidy" style="text-decoration: underline;">HowTo use the tidy component (uses ctidy version 060405)</a></h2>                                        
<h3>Cleanup::</h3>                                        //optimize data
<pre class="brush: js">                                        writer.optimize();
                                        
        //initialize xpcom                                </pre>
        var tidy = Components.classes["@bookmarktools.mozdev.org/repair/tidy;1"].createInstance();
        tidy = tidy.QueryInterface(Components.interfaces.ITidy);                                <h4>Searching::</h4>
                                        <pre class="brush: js font-size: 80%">
        var src = "
        &lt;html&gt;                                        //initialize xpcom
                &lt;head&gt;&lt;/head&gt;                                        var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
                &lt;body                                        reader = reader.QueryInterface(Components.interfaces.ICLReader);
                        broken body tag & no entity                                        
                &lt;/body&gt;                                        //set path
        &lt;/html>";                                        reader.setPath(file.path); //see section 'Writing'
                                                
        //result contains the repaired html/xhtml/xml source                                        if(reader.exists()){ //check for index data
        //otherwise a error message returned                                                
        var result = tidy.cleanup(src);                                                var query = "Hell*";
                                                        var results = Components.classes["@mozilla.org/array;1"]
        if(result == "Tidy: no output"){                                                                                .createInstance(Components.interfaces.nsIMutableArray);
                alert("error returned");                                                reader.search(query, results);
        }else {                                                
                alert(src);                                                var e = results.enumerate();
        }                                                while (e.hasMoreElements()) {
                                                                var resultNode = e.getNext().QueryInterface(Components.interfaces.IResultNode);
</pre>                                                        
                                                        //Object: resultNode
                                                         //-> resultNode.primaryKey
                                                         //-> resultNode.score
                                                         alert(resultNode.primaryKey + "\n" + resultNode.score);
                                                 }
                                                 
                                         }else {
                                                 //display message or do nothing
                                         }
                                         
                                 </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 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 id="footer">
                                 <div style="text-align: center;">
                     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>
         </body>
 </html>
   

Removed from v.1.15  
changed lines
  Added in v.1.16


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