Annotation of bookmarktools/www/documentation.html, revision 1.14

1.1       maik        1: <!-- MAIN CONTENT -->
                      2: 
1.13      maik        3: <br /><br />
                      4: 
1.12      maik        5: <div class="content">
                      6:        <h2>Content:</h2>
                      7:        <ul>
                      8:                <li><strong>USER GUIDE</strong></li>
                      9:                <li><strong>XPCOM</strong>
                     10:                        <ul>
                     11:                                <li><a href="#HowToIndex">HowTo use the index component</a></li>
                     12:                                <li><a href="#HowToTidy">HowTo use the tidy component</a></li>
                     13:                        </ul>
                     14:                </li>
                     15:                <li><strong>OTHER</strong></li>
                     16:        </ul>
1.13      maik       17:        <br />
1.12      maik       18: </div>
1.1       maik       19: 
                     20: <br />
                     21: 
1.14    ! maik       22: <h2><a name="HowToIndex" style="text-decoration: underline;">HowTo use the index component (uses clucene-core-0.9.20)</a></h2>
1.1       maik       23: <h3>Writing::</h3>
                     24: <pre class="brush: js">
                     25: 
                     26:        //initialize file object (location: profile directory)
                     27:        var file = Components.classes["@mozilla.org/file/directory_service;1"]
                     28:                                .getService(Components.interfaces.nsIProperties)
                     29:                                .get("ProfD", Components.interfaces.nsIFile);
                     30: 
                     31:        file.append("index"); //folder named 'index'
                     32:        
                     33:        if(!file.exists() || !file.isDirectory()) 
                     34:                file.create(Components.interfaces.nsIFile.DIRECTORY_TYPE, 0777);
                     35: 
                     36:        //initialize xpcom
                     37:        var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();
                     38:        writer = writer.QueryInterface(Components.interfaces.ICLWriter);
                     39:        
                     40:        //set path
                     41:        writer.setPath(file.path);
                     42:        
                     43:        //create index document
                     44:        var cl_document = new Object();
                     45:        cl_document.primaryKey = "key0";                                                //this shoud be a unique key
                     46:        cl_document.name = "CLucene Indexer";                                   //document name
                     47:        cl_document.lastModifiedDate = new Date().getTime();    //date in millis
                     48:        cl_document.content = "Hello World!";                                   //some content
                     49:        
                     50:        //append document
                     51:        writer.appendDocument(
                     52:                cl_document.primaryKey,
                     53:                cl_document.name,
                     54:                cl_document.lastModifiedDate,
                     55:                cl_document.content
                     56:        );
                     57:        
                     58:        //optimize data
                     59:        writer.optimize();
                     60:        
                     61: </pre>
                     62: 
                     63: <h3>Searching::</h3>
                     64: <pre class="brush: js">
                     65: 
                     66:        //initialize xpcom
                     67:        var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
                     68:        reader = reader.QueryInterface(Components.interfaces.ICLReader);
                     69:        
                     70:        //set path
                     71:        reader.setPath(file.path); //see section 'Writing'
                     72:        
                     73:        if(reader.exists()){ //check for index data
                     74:                
                     75:                var query = "Hell*";
                     76:                var results = Components.classes["@mozilla.org/array;1"]
                     77:                                                .createInstance(Components.interfaces.nsIMutableArray);
                     78:                reader.search(query, results);
                     79:                
                     80:                var e = results.enumerate();
                     81:                while (e.hasMoreElements()) {
                     82:                        var resultNode = e.getNext().QueryInterface(Components.interfaces.IResultNode);
                     83:                        
                     84:                        //Object: resultNode
                     85:                        //-> resultNode.primaryKey
                     86:                        //-> resultNode.score
                     87:                        alert(resultNode.primaryKey + "\n" + resultNode.score);
                     88:                }
                     89:                
                     90:        }else {
                     91:                //display message or do nothing
                     92:        }
                     93:        
                     94: </pre>
                     95: 
                     96: <h3>Lookup::</h3>
                     97: <pre class="brush: js">
                     98: 
                     99:        //initialize xpcom
                    100:        var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
                    101:        reader = reader.QueryInterface(Components.interfaces.ICLReader);
                    102:        
                    103:        //set path
                    104:        reader.setPath(file.path); //see section 'Writing'
                    105:        
                    106:        var results = Components.classes["@mozilla.org/array;1"]
                    107:                                        .createInstance(Components.interfaces.nsIMutableArray);
                    108:        reader.lookup(results);
                    109:        
                    110:        var e = results.enumerate();
                    111:        while (e.hasMoreElements()) {
                    112:                var lookupNode = e.getNext().QueryInterface(Components.interfaces.ILookupNode);
                    113:                
                    114:                //Object: lookupNode
                    115:                //-> lookupNode.primaryKey
                    116:                //-> lookupNode.name
                    117:                alert(lookupNode.primaryKey + "\n" + lookupNode.name);
                    118:        }
                    119: 
                    120: </pre>
                    121: 
                    122: <h3>Delete documents::</h3>
                    123: <pre class="brush: js">
                    124: 
                    125:        //initialize xpcom
                    126:        var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();
                    127:        writer = writer.QueryInterface(Components.interfaces.ICLWriter);
                    128:        
                    129:        //set path
                    130:        writer.setPath(file.path); //see section 'Writing'
                    131:        
                    132:        //delete documents with index 0, 5 and 2
                    133:        var docs = [0, 5, 2];
                    134:        writer.deleteDocument(docs, docs.length);
                    135: 
                    136: </pre>
                    137: 
                    138: <br />
                    139: 
1.14    ! maik      140: <h2><a name="HowToTidy" style="text-decoration: underline;">>HowTo use the tidy component (uses ctidy version 060405)</a></h2>
1.1       maik      141: <h3>Cleanup::</h3>
                    142: <pre class="brush: js">
                    143: 
                    144:        //initialize xpcom
                    145:        var tidy = Components.classes["@bookmarktools.mozdev.org/repair/tidy;1"].createInstance();
                    146:        tidy = tidy.QueryInterface(Components.interfaces.ITidy);
                    147:        
                    148:        var src = "
                    149:        &lt;html&gt;
                    150:                &lt;head&gt;&lt;/head&gt;
                    151:                &lt;body
                    152:                        broken body tag & no entity
                    153:                &lt;/body&gt;
                    154:        &lt;/html>";
                    155:        
                    156:        //result contains the repaired html/xhtml/xml source
                    157:        //otherwise a error message returned
                    158:        var result = tidy.cleanup(src);
                    159:        
                    160:        if(result == "Tidy: no output"){
                    161:                alert("error returned");
                    162:        }else {
                    163:                alert(src);
                    164:        }
                    165:        
                    166: </pre>
                    167: 

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