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

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

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