Line # Revision Author
1 18 dpavlin <div class="logo">
2 <h1 class="title">Hyper Estraier</h1>
3 <div class="caption">a full-text search system for communities</div>
4 </div>
5 <div class="help">
6 <h2>What is This?</h2>
7 <p>This is a full-text search system. You can search for documents including some specified words.</p>
8 <h2>How to Use</h2>
9 <p>Input search phrase into the field at the top of the page. For example, if you search for documents including "computer", input the following.</p>
10 <pre>computer
11 </pre>
12 <p>If you search for documents including both of "network" and "socket", input the following.</p>
13 <pre>network socket
14 </pre>
15 <p>It is the same as the following.</p>
16 <pre>network &amp; socket
17 </pre>
18 <p>If you search for documents including "network" followed by "socket", input the following.</p>
19 <pre>"network socket"
20 </pre>
21 <p>If you search for documents including one or both of "network" and "socket", input the following.</p>
22 <pre>network | socket
23 </pre>
24 <p>If you search for documents including "network" but without "socket", input the following.</p>
25 <pre>network ! socket
26 </pre>
27 <p>Note that the priority of "<kbd>|</kbd>" is higher than that of space, "<kbd>&amp;</kbd>", and "<kbd>!</kbd>". So, the following is to search for documents including one of "F1", "F-1", "Formula-One", and including one of "champion" and "victory".</p>
28 <pre>F1 | F-1 | "Formula One" &amp; champion | victory
29 </pre>
30 <h2>Search with an Attribute</h2>
31 <p>If you search for documents whose title includes "introduction", input the following into "with [...]" field.</p>
32 <pre>@title STRINC introduction
33 </pre>
34 <p>If you want to ignore case, input the following.</p>
35 <pre>@title ISTRINC introduction
36 </pre>
37 <p>If you search for documents whose size is less than 10000 bytes, input the following.</p>
38 <pre>@size NUMLT 10000
39 </pre>
40 <p>The following attributes are supported.</p>
41 <ul>
42 <li>@uri : the URI (URL)</li>
43 <li>@title : the title, as with "Subject" of mail</li>
44 <li>@author : the name of the author, as with "From" of mail</li>
45 <li>@cdate : the creation date, as with "Date" of mail</li>
46 <li>@mdate : the modification date, as with "Date" of mail</li>
47 <li>@size : the size (file size)</li>
48 </ul>
49 <p>The following operators for attributes are supported.</p>
50 <ul>
51 <li>STREQ : is equal to the string</li>
52 <li>STRNE : is not equal to the string</li>
53 <li>STRINC : includes the string</li>
54 <li>STRBW : begins with the string</li>
55 <li>STREW : ends with the string</li>
56 <li>NUMEQ : is equal to the number</li>
57 <li>NUMNE : is not equal to the number</li>
58 <li>NUMLT : is less than the number</li>
59 <li>NUMLE : is less than or equal to the number or date</li>
60 <li>NUMGT : is greater than the number</li>
61 <li>NUMGE : is greater than or equal to the number or date</li>
62 </ul>
63 <p>If an operator is leaded by "!", the meaning is inverted. If an operator is leaded by "I", case of the value is ignored.</p>
64 <h2>Order of the Result</h2>
65 <p>By default, the order of the result is descending by score. If you want ascending order of title, input the following into the "order by [...]" field.</p>
66 <pre>@title STRA
67 </pre>
68 <p>If you want descending order of the size, input the following.</p>
69 <pre>@size NUMD
70 </pre>
71 <p>The following operators for order are supported.</p>
72 <ul>
73 <li>STRA : ascending by string</li>
74 <li>STRD : descending by string</li>
75 <li>NUMA : ascending by number or date</li>
76 <li>NUMD : descending by number or date</li>
77 </ul>
78 <h2>Information</h2>
79 <p>See <a href="http://hyperestraier.sourceforge.net/">the project site</a> for more detail.</p>
80 </div>