summaryrefslogtreecommitdiff
path: root/estseek.help
blob: d8f72d1aa103f2196372422db098f6577f4567dc (plain)
  1. <div class="help">
  2. <h1 class="title">Help</h1>
  3. <h2>What is This?</h2>
  4. <p>This is a full-text search system. You can search for documents including some specified words.</p>
  5. <h2>How to Use</h2>
  6. <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>
  7. <pre>computer
  8. </pre>
  9. <p>If you search for documents including both of "network" and "socket", input the following.</p>
  10. <pre>network socket
  11. </pre>
  12. <p>It is the same as the following.</p>
  13. <pre>network &amp; socket
  14. </pre>
  15. <p>If you search for documents including "network" followed by "socket", input the following.</p>
  16. <pre>"network socket"
  17. </pre>
  18. <p>If you search for documents including one or both of "network" and "socket", input the following.</p>
  19. <pre>network | socket
  20. </pre>
  21. <p>If you search for documents including "network" but without "socket", input the following.</p>
  22. <pre>network ! socket
  23. </pre>
  24. <p>Note that the priority of "<code>|</code>" is higher than that of space, "<code>&amp;</code>", and "<code>!</code>". So, the following is to search for documents including one of "F1", "F-1", "Formula One", and including one of "champion" and "victory".</p>
  25. <pre>F1 | F-1 | "Formula One" &amp; champion | victory
  26. </pre>
  27. <p>If you search for documents including some words beginning with "inter", input the following.</p><pre>inter*
  28. </pre>
  29. <p>If you search for documents including some words ending with "sphere", input the following.</p>
  30. <pre>*sphere
  31. </pre>
  32. <p>If you search for documents matching some words matching regular expressions of "^un.*able$", input the following.</p>
  33. <pre>*^un.*able$*
  34. </pre>
  35. <h2>Search with an Attribute</h2>
  36. <p>If you search for documents whose title includes "introduction", input the following into "<code>with [...]</code>" field.</p>
  37. <pre>@title STRINC introduction
  38. </pre>
  39. <p>If you want to ignore case, input the following.</p>
  40. <pre>@title ISTRINC introduction
  41. </pre>
  42. <p>If you search for documents whose size is less than 10000 bytes, input the following.</p>
  43. <pre>@size NUMLT 10000
  44. </pre>
  45. <p>The following attributes are supported.</p>
  46. <ul>
  47. <li>@uri : the URI (URL)</li>
  48. <li>@title : the title, as with "Subject" of mail</li>
  49. <li>@author : the name of the author, as with "From" of mail</li>
  50. <li>@cdate : the creation date, as with "Date" of mail</li>
  51. <li>@mdate : the modification date, as with "Date" of mail</li>
  52. <li>@size : the size (file size)</li>
  53. </ul>
  54. <p>The following operators for attributes are supported.</p>
  55. <ul>
  56. <li>STREQ : is equal to the string</li>
  57. <li>STRNE : is not equal to the string</li>
  58. <li>STRINC : includes the string</li>
  59. <li>STRBW : begins with the string</li>
  60. <li>STREW : ends with the string</li>
  61. <li>STRAND : includes all tokens in the string</li>
  62. <li>STROR : includes at least one token in the string</li>
  63. <li>STROREQ : is equal to at least one token in the string</li>
  64. <li>STRRX : matches regular expressions of the string</li>
  65. <li>NUMEQ : is equal to the number or date</li>
  66. <li>NUMNE : is not equal to the number or date</li>
  67. <li>NUMGT : is greater than the number or date</li>
  68. <li>NUMGE : is greater than or equal to the number or date</li>
  69. <li>NUMLT : is less than the number or date</li>
  70. <li>NUMLE : is less than or equal to the number or date</li>
  71. <li>NUMBT : is between the two numbers or dates</li>
  72. </ul>
  73. <p>If an operator is leaded by "<code>!</code>", the meaning is inverted. If an operator is leaded by "<code>I</code>", case of the value is ignored. If no operator is specified, all documents with the attribute correspond regardless of the value. <code>STRAND</code>, <code>STROR</code>, <code>STROREQ</code>, and <code>NUMBT</code> take plural parameters separated by space. Range of <code>NUMBT</code> is inclusive of border values. Two or more attribute names can be listed with separated by "<code>,</code>" to mean logical addition.</p>
  74. <h2>Order of the Result</h2>
  75. <p>By default, the order of the result is descending by score. If you want ascending order of title, input the following into the "<code>order by [...]</code>" field.</p>
  76. <pre>@title STRA
  77. </pre>
  78. <p>If you want descending order of the size, input the following.</p>
  79. <pre>@size NUMD
  80. </pre>
  81. <p>The following operators for order are supported.</p>
  82. <ul>
  83. <li>STRA : ascending by string</li>
  84. <li>STRD : descending by string</li>
  85. <li>NUMA : ascending by number or date</li>
  86. <li>NUMD : descending by number or date</li>
  87. </ul>
  88. <h2>Other Faculties</h2>
  89. <p>"<code>[...] per page</code>" specifies the number of shown documents per page. If documents over one page correspond, you can move to another page via anchors of "<code>PREV</code>" and "<code>NEXT</code>" at the bottom of the page.</p>
  90. <p>"<code>clip by [...]</code>" specifies strength of clipping similar documents. It is useful if too similar documents occupy the page.</p>
  91. <p>Each of "<code>[detail]</code>" links in the result is to show detail information. Each of "<code>[similar]</code>" links in the result is to search for similar documents. Each of "<code>[include]</code>" links in the result is to include clipped documents.</p>
  92. <h2>Information</h2>
  93. <p>See <a href="http://hyperestraier.sourceforge.net/">the project site</a> for more detail.</p>
  94. </div>