A semantic search engine for source code https://bitshift.benkurtovic.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

119 lines
5.2 KiB

  1. = extends "layout.html"
  2. = block title
  3. docs
  4. = endblock
  5. = block head
  6. {{ assets.tag("docs.css") }}
  7. = endblock
  8. = block body
  9. <ul>
  10. <li>
  11. <h1><span>&raquo;</span> Usage</h1>
  12. <p>
  13. <span id="title">bitshift</span> is a search-engine optimized for source code: beyond supporting searches with the full range of ASCII
  14. symbols, the engine <em>understands</em> code, allowing users to query for metadata, like time of creation/last
  15. modification, programming language, and even symbols like function names and variables. Basic use boils down to
  16. general and advanced searches.
  17. <ul>
  18. <li>
  19. <h2>general search</h2>
  20. <p>
  21. To perform a "general search," simply place your cursor in the search bar on our home page and begin
  22. entering text; when you stop typing for a short period of time, we'll automatically execute the query for you.
  23. As you scroll down the results page, new codelets will be seamlessly downloaded from our server and
  24. appended to the end.
  25. </p>
  26. </li>
  27. <li>
  28. <h2>advanced search</h2>
  29. <p>
  30. General searches, though, are limited. To allow users to make the best of our engine, we created an advanced
  31. search form that allows the creation of complex queries with the following specifiers:
  32. <ul>
  33. <li>
  34. <h3>search fields</h3>
  35. <ul id="search-fields">
  36. <li>
  37. <span id="code">languages</span> : The programming languages to search for.
  38. </li>
  39. <li>
  40. <span id="code">authors</span> : Search for code written/modified by a specific person.
  41. </li>
  42. <li>
  43. <span id="code">date last modified</span> : Search for code last modified on a specific date (<span
  44. id="code">mm/dd/yy</span> format).
  45. </li>
  46. <li>
  47. <span id="code">date created</span> : Search for code created on a specific date (<span
  48. id="code">mm/dd/yy</span> format).
  49. </li>
  50. <li>
  51. <span id="code">symbols</span> : Search for specific symbols.
  52. </li>
  53. <li>
  54. <span id="code">functions</span> : Search for functions with specific names.
  55. </li>
  56. <li>
  57. <span id="code">classes</span> : Search for classes with specific names.
  58. </li>
  59. <li>
  60. <span id="code">variables</span> : Search for variables with specific names.
  61. </li>
  62. </ul>
  63. <p>
  64. Each of the search fields allows for numerous values; just separate them with spaces. If you'd like
  65. to search for a multi-word, space-delimited string, on the other hand, enclose it in double quotes.
  66. A query for <span id="code">foo bar</span> will search for occurrences of both <span
  67. id="string">"foo"</span> and <span id="string">"bar"</span>, while <span id="code">"foo bar"</span>
  68. will search for occurrences of <span id="string">"foo bar"</span>.
  69. </p>
  70. </li>
  71. <li>
  72. <h3>search groups</h3>
  73. <p>
  74. Search groups facilitate even more robust queries: they're like a bunch of individual searches
  75. grouped into one. A user searching for occurrenes of symbol <span id="string">"curses"</span> in the
  76. language <span id="string">"Python"</span>, and <span id="string">"ncurses"</span> in <span
  77. id="string">"C"</span>, won't get away with: <span id="code">symbols: "curses ncurses"</span> and
  78. <span id="code">languages: "Python C"</span>. The engine might return results <span
  79. id="string">"curses"</span> in <span id="string">"C"</span> and <span id="string">"ncurses"</span> in
  80. <span id="string">"Python"</span>!
  81. To work around that, you can use two search groups: one for <span id="string">"curses"</span> in
  82. <span id="string">"Python"</span>, and another for <span id="string">"curses"</span> in <span
  83. id="string">"C"</span>. <span id="title">bitshift</span> will return the union of both sets of search results.
  84. </p>
  85. </li>
  86. </ul>
  87. </p>
  88. </li>
  89. </ul>
  90. </p>
  91. </li>
  92. <li>
  93. <h1><span>&raquo;</span> Handwritten Queries</h1>
  94. <p>
  95. No content, yet.
  96. </p>
  97. </li>
  98. <li id="sec3">
  99. <h1><span>&raquo;</span> Get involved</h1>
  100. <p>
  101. <span id="title">bitshift</span> is <span id="gasp">(gasp)</span> open-source! The project is hosted on
  102. <a href="https://github.com/earwig/bitshift">GitHub</a>; feel free to file an issue or submit a pull request!
  103. </p>
  104. </li>
  105. </ul>
  106. = endblock