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

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

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