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

1.18    ! maik        1: <?xml version="1.0" encoding="UTF-8"?>
        !             2: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
        !             3: 
        !             4: <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1.16      maik        5:        <head>
1.18    ! maik        6:                <link rel="stylesheet" href="project.css" type="text/css" />
1.16      maik        7:                
1.18    ! maik        8:                <meta http-equiv="Content-Type" content="text/html" />
1.16      maik        9:                <meta content="text/css" http-equiv="Content-Style-Type" />
                     10:                
                     11:                <script type="text/javascript" src="scripts/shCore.js"></script>
                     12:                <script type="text/javascript" src="scripts/shBrushBash.js"></script>
                     13:                <script type="text/javascript" src="scripts/shBrushCpp.js"></script>
                     14: 
                     15:                <script type="text/javascript" src="scripts/shBrushCSharp.js"></script>
                     16:                <script type="text/javascript" src="scripts/shBrushCss.js"></script>
                     17:                <script type="text/javascript" src="scripts/shBrushDelphi.js"></script>
                     18:                <script type="text/javascript" src="scripts/shBrushDiff.js"></script>
                     19:                <script type="text/javascript" src="scripts/shBrushGroovy.js"></script>
                     20:                <script type="text/javascript" src="scripts/shBrushJava.js"></script>
                     21: 
                     22:                <script type="text/javascript" src="scripts/shBrushJScript.js"></script>
                     23:                <script type="text/javascript" src="scripts/shBrushPhp.js"></script>
                     24:                <script type="text/javascript" src="scripts/shBrushPlain.js"></script>
                     25:                <script type="text/javascript" src="scripts/shBrushPython.js"></script>
                     26:                <script type="text/javascript" src="scripts/shBrushRuby.js"></script>
                     27:                <script type="text/javascript" src="scripts/shBrushScala.js"></script>
                     28: 
                     29:                <script type="text/javascript" src="scripts/shBrushSql.js"></script>
                     30:                <script type="text/javascript" src="scripts/shBrushVb.js"></script>
                     31:                <script type="text/javascript" src="scripts/shBrushXml.js"></script>
                     32:                
                     33:                <link type="text/css" rel="stylesheet" href="styles/shCore.css"/>
                     34:                <link type="text/css" rel="stylesheet" href="styles/shThemeDefault.css"/>
                     35:                
                     36:                <script type="text/javascript">
                     37:                        SyntaxHighlighter.config.clipboardSwf = 'scripts/clipboard.swf';
                     38:                        SyntaxHighlighter.all();
                     39:                </script>
                     40:        </head>
                     41:        <body>
1.18    ! maik       42:                <table style="width: 100%;">
        !            43:                        <tbody>
        !            44:                                <tr>
        !            45:                                        <td>
        !            46:                                                <div id="main">
        !            47:                                                        <div id="menu-container">
        !            48:                                                                <a href="http://www.mozdev.org" title="mozdev.org - free project hosting for the mozilla community">
        !            49:                                                                        <img src="http://www.mozdev.org/sharedimages/mozdev_tiny.png" width="80" height="15" alt="mozdev.org" />
        !            50:                                                                </a>
        !            51:                                                                <div id="project-head">Bookmark Tools</div>
        !            52:                                                                <div id="project-desc">Developer <a class="simpleLink" href="mailto:maik.gollnick@gmx.de">Maik Gollnick</a></div>
        !            53:                                                                <ul id="simple-menu">
        !            54:                                                                        <li><a href="index.html" title="Home">Home</a></li>
        !            55:                                                                        <li><a href="installation.html" title="Download">Download</a></li>
        !            56:                                                                        <li><a href="documentation.html" title="Documentation" class="current">Documentation</a></li>
        !            57:                                                                        <li><a href="source.html" title="Source Code">Source Code</a></li>
        !            58:                                                                        <li><a href="bugs.html" title="Bugs">Bugs</a></li>
        !            59:                                                                        <li><a href="screenshots.html" title="Screenshots">Screenshots</a></li>
        !            60:                                                                </ul>
        !            61:                                                        </div>
        !            62:                                                        <div id="menu-line"></div>
1.16      maik       63:                                                        
1.18    ! maik       64:                                                        <div id="content">
        !            65:                                                                
        !            66:                                                                <div>
        !            67:                                                                        <h3><a name="Content">Content:</a></h3>
        !            68:                                                                        <ul>
        !            69:                                                                                <li><strong>USER GUIDE</strong></li>
        !            70:                                                                                <li><strong>XPCOM</strong>
        !            71:                                                                                        <ul>
        !            72:                                                                                                <li><a href="#HowToIndex">HowTo use the index component</a></li>
        !            73:                                                                                                <li><a href="#HowToTidy">HowTo use the tidy component</a></li>
        !            74:                                                                                        </ul>
        !            75:                                                                                </li>
        !            76:                                                                                <li><strong>OTHER</strong></li>
        !            77:                                                                        </ul>
        !            78:                                                                        <br />
        !            79:                                                                </div>
        !            80: 
        !            81:                                                                <div class="separator"></div>
        !            82:                                                                        
        !            83:                                                                        <br />
        !            84: 
        !            85:                                                                        <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>
        !            86:                                                                        <h4>Writing::</h4>
        !            87:                                                                        <pre class="brush: js font-size: 80%">
        !            88: 
        !            89:                                                                                //initialize file object (location: profile directory)
        !            90:                                                                                var file = Components.classes["@mozilla.org/file/directory_service;1"]
        !            91:                                                                                                        .getService(Components.interfaces.nsIProperties)
        !            92:                                                                                                        .get("ProfD", Components.interfaces.nsIFile);
        !            93: 
        !            94:                                                                                file.append("index"); //folder named 'index'
        !            95:                                                                                
        !            96:                                                                                if(!file.exists() || !file.isDirectory()) 
        !            97:                                                                                        file.create(Components.interfaces.nsIFile.DIRECTORY_TYPE, 0777);
        !            98: 
        !            99:                                                                                //initialize xpcom
        !           100:                                                                                var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();
        !           101:                                                                                writer = writer.QueryInterface(Components.interfaces.ICLWriter);
        !           102:                                                                                
        !           103:                                                                                //set path
        !           104:                                                                                writer.setPath(file.path);
        !           105:                                                                                
        !           106:                                                                                //create index document
        !           107:                                                                                var cl_document = new Object();
        !           108:                                                                                cl_document.primaryKey = "key0";                                                //this shoud be a unique key
        !           109:                                                                                cl_document.name = "CLucene Indexer";                                   //document name
        !           110:                                                                                cl_document.lastModifiedDate = new Date().getTime();    //date in millis
        !           111:                                                                                cl_document.content = "Hello World!";                                   //some content
        !           112:                                                                                
        !           113:                                                                                //append document
        !           114:                                                                                writer.appendDocument(
        !           115:                                                                                        cl_document.primaryKey,
        !           116:                                                                                        cl_document.name,
        !           117:                                                                                        cl_document.lastModifiedDate,
        !           118:                                                                                        cl_document.content
        !           119:                                                                                );
        !           120:                                                                                
        !           121:                                                                                //optimize data
        !           122:                                                                                writer.optimize();
        !           123:                                                                                
        !           124:                                                                        </pre>
        !           125: 
        !           126:                                                                        <h4>Searching::</h4>
        !           127:                                                                        <pre class="brush: js font-size: 80%">
        !           128: 
        !           129:                                                                                //initialize xpcom
        !           130:                                                                                var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
        !           131:                                                                                reader = reader.QueryInterface(Components.interfaces.ICLReader);
        !           132:                                                                                
        !           133:                                                                                //set path
        !           134:                                                                                reader.setPath(file.path); //see section 'Writing'
        !           135:                                                                                
        !           136:                                                                                if(reader.exists()){ //check for index data
        !           137:                                                                                        
        !           138:                                                                                        var query = "Hell*";
        !           139:                                                                                        var results = Components.classes["@mozilla.org/array;1"]
        !           140:                                                                                                                        .createInstance(Components.interfaces.nsIMutableArray);
        !           141:                                                                                        reader.search(query, results);
        !           142:                                                                                        
        !           143:                                                                                        var e = results.enumerate();
        !           144:                                                                                        while (e.hasMoreElements()) {
        !           145:                                                                                                var resultNode = e.getNext().QueryInterface(Components.interfaces.IResultNode);
        !           146:                                                                                                
        !           147:                                                                                                //Object: resultNode
        !           148:                                                                                                //-> resultNode.primaryKey
        !           149:                                                                                                //-> resultNode.score
        !           150:                                                                                                alert(resultNode.primaryKey + "\n" + resultNode.score);
        !           151:                                                                                        }
        !           152:                                                                                        
        !           153:                                                                                }else {
        !           154:                                                                                        //display message or do nothing
        !           155:                                                                                }
        !           156:                                                                                
        !           157:                                                                        </pre>
        !           158: 
        !           159:                                                                        <h4>Lookup::</h4>
        !           160:                                                                        <pre class="brush: js font-size: 80%">
        !           161: 
        !           162:                                                                                //initialize xpcom
        !           163:                                                                                var reader = Components.classes["@bookmarktools.mozdev.org/search/indexReader;1"].createInstance();
        !           164:                                                                                reader = reader.QueryInterface(Components.interfaces.ICLReader);
        !           165:                                                                                
        !           166:                                                                                //set path
        !           167:                                                                                reader.setPath(file.path); //see section 'Writing'
        !           168:                                                                                
        !           169:                                                                                var results = Components.classes["@mozilla.org/array;1"]
        !           170:                                                                                                                .createInstance(Components.interfaces.nsIMutableArray);
        !           171:                                                                                reader.lookup(results);
        !           172:                                                                                
        !           173:                                                                                var e = results.enumerate();
        !           174:                                                                                while (e.hasMoreElements()) {
        !           175:                                                                                        var lookupNode = e.getNext().QueryInterface(Components.interfaces.ILookupNode);
        !           176:                                                                                        
        !           177:                                                                                        //Object: lookupNode
        !           178:                                                                                        //-> lookupNode.primaryKey
        !           179:                                                                                        //-> lookupNode.name
        !           180:                                                                                        alert(lookupNode.primaryKey + "\n" + lookupNode.name);
        !           181:                                                                                }
        !           182: 
        !           183:                                                                        </pre>
        !           184: 
        !           185:                                                                        <h4>Delete documents::</h4>
        !           186:                                                                        <pre class="brush: js font-size: 80%">
        !           187: 
        !           188:                                                                                //initialize xpcom
        !           189:                                                                                var writer = Components.classes["@bookmarktools.mozdev.org/search/indexWriter;1"].createInstance();
        !           190:                                                                                writer = writer.QueryInterface(Components.interfaces.ICLWriter);
        !           191:                                                                                
        !           192:                                                                                //set path
        !           193:                                                                                writer.setPath(file.path); //see section 'Writing'
        !           194:                                                                                
        !           195:                                                                                //delete documents with index 0, 5 and 2
        !           196:                                                                                var docs = [0, 5, 2];
        !           197:                                                                                writer.deleteDocument(docs, docs.length);
        !           198: 
        !           199:                                                                        </pre>
        !           200: 
        !           201:                                                                        <br />
        !           202: 
        !           203:                                                                        <div class="separator"></div>
        !           204:                                                                        
        !           205:                                                                        <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>
        !           206:                                                                        <h4>Cleanup::</h4>
        !           207:                                                                        <pre class="brush: js font-size: 80%">
        !           208: 
        !           209:                                                                                //initialize xpcom
        !           210:                                                                                var tidy = Components.classes["@bookmarktools.mozdev.org/repair/tidy;1"].createInstance();
        !           211:                                                                                tidy = tidy.QueryInterface(Components.interfaces.ITidy);
        !           212:                                                                                
        !           213:                                                                                var src = "
        !           214:                                                                                &lt;html&gt;
        !           215:                                                                                        &lt;head&gt;&lt;/head&gt;
        !           216:                                                                                        &lt;body
        !           217:                                                                                                broken body tag & no entity
        !           218:                                                                                        &lt;/body&gt;
        !           219:                                                                                &lt;/html>";
        !           220:                                                                                
        !           221:                                                                                //result contains the repaired html/xhtml/xml source
        !           222:                                                                                //otherwise a error message returned
        !           223:                                                                                var result = tidy.cleanup(src);
        !           224:                                                                                
        !           225:                                                                                if(result == "Tidy: no output"){
        !           226:                                                                                        alert("error returned");
        !           227:                                                                                }else {
        !           228:                                                                                        alert(src);
        !           229:                                                                                }
        !           230:                                                                                
        !           231:                                                                        </pre>
        !           232:                                                                </div>
        !           233:                                                                
        !           234:                                                        </div>
        !           235:                                                </div>
        !           236:                                        </td>
        !           237:                                </tr>
        !           238:                                <tr>
        !           239:                                        <td>
        !           240:                                                <div id="footer">
        !           241:                                                        <table>
        !           242:                                                                <tr>
        !           243:                                                                        <td>
        !           244:                                                                                <a href="http://validator.w3.org/check?uri=referer">
        !           245:                                                                                        <img src="http://www.w3.org/Icons/valid-xhtml10-blue"
        !           246:                                                                                        alt="Valid XHTML 1.0 Strict" height="31" width="88" />
        !           247:                                                                                </a>
        !           248:                                                                        </td>
        !           249:                                                                        <td style="width: 100%;">
        !           250:                                                                                <div style="text-align: center;">
        !           251:                                                                                        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>.
        !           252:                                                                                </div>
        !           253:                                                                        </td>
        !           254:                                                                        <td>
        !           255:                                                                                <a href="http://jigsaw.w3.org/css-validator/check/referer">
        !           256:                                                                                        <img style="border:0;width:88px;height:31px"
        !           257:                                                                                        src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
        !           258:                                                                                        alt="Valid CSS!" />
        !           259:                                                                                </a>
        !           260:                                                                        </td>
        !           261:                                                                </tr>
        !           262:                                                        </table>
        !           263:                                                </div>
        !           264:                                        </td>
        !           265:                                </tr>
        !           266:                        </tbody>
        !           267:                </table>
1.16      maik      268:        </body>
1.18    ! maik      269: </html>

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