Improvements to search

1. Do not remove stop words, so or/where/from are search searchable 2. When indexing the title, split IDs on dots and slashes 3. Reduce the size of the search sidebar Closes #996.
elixir-lang · Apr 11, 2019 · 37e2e78 · 37e2e78
1 parent 981bc3d
commit 37e2e78
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 15 deletions.
diff --git a/assets/js/search.js b/assets/js/search.js
@@ -116,14 +116,23 @@ function getProjectMeta () {
   return document.head.querySelector('meta[name=project][content]').content
 }
 
+function titleExtractor(document) {
+  var title = document['title']
+
+  if(document['type'] != 'extras') {
+    title = title + ' ' + title.replace(/\.|\//g, ' ')
+  }
+
+  return title
+}
+
 function createIndex () {
   return lunr(function () {
     this.ref('ref')
-    this.field('title')
-    this.field('module')
-    this.field('type')
+    this.field('title', {extractor: titleExtractor})
     this.field('doc')
     this.metadataWhitelist = ['position']
+    this.pipeline.remove(lunr.stopWordFilter)
 
     searchNodes.forEach(function (doc) {
       this.add(doc)

diff --git a/assets/js/templates/search-results.handlebars b/assets/js/templates/search-results.handlebars
@@ -18,7 +18,7 @@
     <p>Invalid search: {{errorMessage}}.</p>
   {{/isArray}}
 
-  <p>Here are some search tips:</p>
+  <p>Here are some tips when performing a full-text search:</p>
 
   <dl>
     <li>Multiple words (such as <code>foo bar</code>) are searched as <code>OR</code></li>
@@ -28,4 +28,6 @@
     <li>Use <code>WORD^NUMBER</code> (such as <code>foo^2</code>) to boost the given word</li>
     <li>Use <code>WORD~NUMBER</code> (such as <code>foo~2</code>) to do a search with edit distance on word</li>
   </dl>
+
+  <p>To quickly go to a module, type, or function, use the autocompletion feature in the sidebar search.</p>
 {{/isNonEmptyArray}}
diff --git a/...s/epub/dist/epub-74eac3282c1e81b5d7b3.css → ...s/epub/dist/epub-38840030e25c18db46c2.css b/...s/epub/dist/epub-74eac3282c1e81b5d7b3.css → ...s/epub/dist/epub-38840030e25c18db46c2.css
diff --git a/...rs/epub/dist/epub-74eac3282c1e81b5d7b3.js → ...rs/epub/dist/epub-38840030e25c18db46c2.js b/...rs/epub/dist/epub-74eac3282c1e81b5d7b3.js → ...rs/epub/dist/epub-38840030e25c18db46c2.js
diff --git a/...s/html/dist/html-10c13bd1deebff65ae37.css → ...s/html/dist/html-78f1ba308158a498a5a4.css b/...s/html/dist/html-10c13bd1deebff65ae37.css → ...s/html/dist/html-78f1ba308158a498a5a4.css
diff --git a/...rs/html/dist/html-10c13bd1deebff65ae37.js → ...rs/html/dist/html-78f1ba308158a498a5a4.js b/...rs/html/dist/html-10c13bd1deebff65ae37.js → ...rs/html/dist/html-78f1ba308158a498a5a4.js
diff --git a/lib/ex_doc/formatter/html/search_items.ex b/lib/ex_doc/formatter/html/search_items.ex
@@ -11,7 +11,7 @@ defmodule ExDoc.Formatter.HTML.SearchItems do
   @header_body_regex ~r/(?<header>.*)<\/h2>(?<body>.*)/s
   defp extra(%{id: id, title: title, content: content}) do
     [intro | sections] = Regex.split(@h2_split_regex, content)
-    intro_json_item = encode("#{id}.html", title, id, :extras, intro)
+    intro_json_item = encode("#{id}.html", title, :extras, intro)
 
     section_json_items =
       sections
@@ -27,14 +27,13 @@ defmodule ExDoc.Formatter.HTML.SearchItems do
     encode(
       "#{id}.html##{HTML.text_to_id(header)}",
       "#{title} - #{header}",
-      id,
       :extras,
       body
     )
   end
 
   defp module_node(node = %ExDoc.ModuleNode{id: id, type: type, rendered_doc: doc}) do
-    module = encode("#{id}.html", id, id, type, doc)
+    module = encode("#{id}.html", id, type, doc)
     functions = Enum.map(node.docs, &node_child(&1, id))
     types = Enum.map(node.typespecs, &node_child(&1, id))
     [module] ++ functions ++ types
@@ -44,20 +43,17 @@ defmodule ExDoc.Formatter.HTML.SearchItems do
     encode(
       "#{module}.html##{HTML.link_id(id, type)}",
       "#{module}.#{id}",
-      module,
       type,
       doc
     )
   end
 
-  defp encode(ref, title, module, type, doc) do
+  defp encode(ref, title, type, doc) do
     [
       "{\"ref\":",
       [?", ref, ?"],
       ",\"title\":",
       [?", title, ?"],
-      ",\"module\":",
-      [?", module, ?"],
       ",\"type\":",
       [?", Atom.to_string(type), ?"],
       ",\"doc\":",