Fixed search for languages without stemmers

2024-12-18 02:15:56 +01:00 · 2018-02-01 23:47:00 +01:00 · 2018-02-01 23:47:00 +01:00 · c002cc2881
commit c002cc2881
parent 9b717440cc
42 changed files with 39 additions and 44 deletions
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@ -375,7 +375,7 @@ Pull Request.

 #### Text direction

-> Default: `ltr`
+> Default: best match for given theme language, automatically set

 Material supports both, left-to-right (`ltr`) and right-to-left (`rtl`) text
 direction. This enables more languages like Arabic, Hebrew, Syriac and others
--- a/material/assets/javascripts/application.cb27f861.js
+++ b/material/assets/javascripts/application.cb27f861.js
--- a/material/base.html
+++ b/material/base.html
@ -26,6 +26,8 @@
        "clipboard.copy",
        "clipboard.copied",
        "search.language",
+        "search.pipeline.stopwords",
+        "search.pipeline.trimmer",
        "search.result.none",
        "search.result.one",
        "search.result.other",
@ -166,7 +168,7 @@
      {% endblock %}
    </div>
    {% block scripts %}
-      <script src="{{ base_url }}/assets/javascripts/application.cb27f861.js"></script>
+      <script src="{{ base_url }}/assets/javascripts/application.ababfdab.js"></script>
      {% if lang.t("search.language") != "en" %}
        {% set languages = lang.t("search.language").split(",") %}
        {% if languages | length and languages[0] != "" %}
--- a/material/mkdocs_theme.yml
+++ b/material/mkdocs_theme.yml
@ -22,7 +22,7 @@
 language: en

 # Text direction (can be ltr or rtl)
-direction: ltr
+direction:

 # Feature flags for functionality that alters behavior significantly, and thus
 # may be a matter of taste
--- a/material/partials/language/da.html
+++ b/material/partials/language/da.html
@ -13,7 +13,6 @@
  "search.result.none": "Ingen resultater fundet",
  "search.result.one": "1 resultat",
  "search.result.other": "# resultater",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Gå til indholdet",
  "source.link.title": "Åbn arkiv",
  "toc.title": "Indholdsfortegnelse"
--- a/material/partials/language/de.html
+++ b/material/partials/language/de.html
@ -13,7 +13,6 @@
  "search.result.none": "Keine Suchergebnisse",
  "search.result.one": "1 Suchergebnis",
  "search.result.other": "# Suchergebnisse",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Zum Inhalt",
  "source.link.title": "Quellcode",
  "toc.title": "Inhaltsverzeichnis"
--- a/material/partials/language/en.html
+++ b/material/partials/language/en.html
@ -1,5 +1,6 @@
 {% macro t(key) %}{{ {
  "language": "en",
+  "direction": "ltr",
  "clipboard.copy": "Copy to clipboard",
  "clipboard.copied": "Copied to clipboard",
  "edit.link.title": "Edit this page",
@ -8,6 +9,8 @@
  "meta.comments": "Comments",
  "meta.source": "Source",
  "search.language": "en",
+  "search.pipeline.stopwords": true,
+  "search.pipeline.trimmer": true,
  "search.placeholder": "Search",
  "search.result.placeholder": "Type to start searching",
  "search.result.none": "No matching documents",
--- a/material/partials/language/es.html
+++ b/material/partials/language/es.html
@ -13,7 +13,6 @@
  "search.result.none": "No se encontraron documentos",
  "search.result.one": "1 documento encontrado",
  "search.result.other": "# documentos encontrados",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Saltar a contenido",
  "source.link.title": "Ir al repositorio",
  "toc.title": "Tabla de contenidos"
--- a/material/partials/language/fa.html
+++ b/material/partials/language/fa.html
@ -8,13 +8,14 @@
  "footer.next": "بعدی",
  "meta.comments": "نظرات",
  "meta.source": "منبع",
-  "search.language": "en",
+  "search.language": "",
+  "search.pipeline.stopwords": false,
+  "search.pipeline.trimmer": false,
  "search.placeholder": "جستجو",
  "search.result.placeholder": "برای شروع جستجو تایپ کنید",
  "search.result.none": "سندی یافت نشد",
  "search.result.one": "1 سند یافت شد",
  "search.result.other": "# سند یافت شد",
-  "search.tokenizer": "[\s]+",
  "skip.link.title": "پرش به محتویات",
  "source.link.title": "رفتن به مخزن",
  "toc.title": "فهرست موضوعات"
--- a/material/partials/language/fr.html
+++ b/material/partials/language/fr.html
@ -13,7 +13,6 @@
  "search.result.none": "Aucun document trouvé",
  "search.result.one": "1 document trouvé",
  "search.result.other": "# documents trouvés",
-  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Aller au dépôt",
  "toc.title": "Table des matières"
 }[key] }}{% endmacro %}
--- a/material/partials/language/hu.html
+++ b/material/partials/language/hu.html
@ -13,7 +13,6 @@
  "search.result.none": "Nincs találat",
  "search.result.one": "1 egyező dokumentum",
  "search.result.other": "# egyező dokumentum",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Kihagyás",
  "source.link.title": "Főoldalra ugrás",
  "toc.title": "Tartalomjegyzék"
--- a/material/partials/language/it.html
+++ b/material/partials/language/it.html
@ -13,7 +13,6 @@
  "search.result.none": "Nessun documento trovato",
  "search.result.one": "1 documento trovato",
  "search.result.other": "# documenti trovati",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Vai al contenuto",
  "source.link.title": "Apri repository",
  "toc.title": "Indice"
--- a/material/partials/language/kr.html
+++ b/material/partials/language/kr.html
@ -13,7 +13,6 @@
  "search.result.none": "검색어와 일치하는 문서가 없습니다",
  "search.result.one": "1개의 일치하는 문서",
  "search.result.other": "#개의 일치하는 문서",
-  "search.tokenizer": "[\s\-]+",
  "source.link.title": "저장소로 이동",
  "toc.title": "목차"
 }[key] }}{% endmacro %}
--- a/material/partials/language/nl.html
+++ b/material/partials/language/nl.html
@ -13,7 +13,6 @@
  "search.result.none": "Geen overeenkomende documenten",
  "search.result.one": "1 overeenkomende document",
  "search.result.other": "# overeenkomende documenten",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Ga naar inhoud",
  "source.link.title": "Ga naar repository",
  "toc.title": "Inhoudstafel"
--- a/material/partials/language/no.html
+++ b/material/partials/language/no.html
@ -13,7 +13,6 @@
  "search.result.none": "Ingen treff",
  "search.result.one": "1 treff",
  "search.result.other": "# treff",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Gå til innhold",
  "source.link.title": "Gå til kilde",
  "toc.title": "Innholdsfortegnelse"
--- a/material/partials/language/pl.html
+++ b/material/partials/language/pl.html
@ -7,12 +7,14 @@
  "footer.next": "Następna strona",
  "meta.comments": "Komentarze",
  "meta.source": "Kod źródłowy",
+  "search.language": "",
+  "search.pipeline.stopwords": false,
+  "search.pipeline.trimmer": false,
  "search.placeholder": "Szukaj",
  "search.result.placeholder": "Zacznij pisać, aby szukać",
  "search.result.none": "Brak wyników wyszukiwania",
  "search.result.one": "Wyniki wyszukiwania: 1",
  "search.result.other": "Wyniki wyszukiwania: #",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Przejdź do treści",
  "source.link.title": "Idź do repozytorium",
  "toc.title": "Spis treści"
--- a/material/partials/language/pt.html
+++ b/material/partials/language/pt.html
@ -13,7 +13,6 @@
  "search.result.none": "Nenhum resultado encontrado",
  "search.result.one": "1 resultado encontrado",
  "search.result.other": "# resultados encontrados",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Ir para o conteúdo",
  "source.link.title": "Ir ao repositório",
  "toc.title": "Índice"
--- a/material/partials/language/ru.html
+++ b/material/partials/language/ru.html
@ -13,7 +13,6 @@
  "search.result.none": "Совпадений не найдено",
  "search.result.one": "Найдено 1 совпадение",
  "search.result.other": "Найдено # совпадений",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Перейти к содержанию",
  "source.link.title": "Перейти к репозиторию",
  "toc.title": "Содержание"
--- a/material/partials/language/sv.html
+++ b/material/partials/language/sv.html
@ -13,7 +13,6 @@
  "search.result.none": "Inga sökresultat",
  "search.result.one": "1 sökresultat",
  "search.result.other": "# sökresultat",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Gå till innehållet",
  "source.link.title": "Gå till datakatalog",
  "toc.title": "Innehållsförteckning"
--- a/material/partials/language/tr.html
+++ b/material/partials/language/tr.html
@ -13,7 +13,6 @@
  "search.result.none": "Eşleşen doküman bulunamadı",
  "search.result.one": "1 doküman bulundu",
  "search.result.other": "# doküman bulundu",
-  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Depoya git",
  "toc.title": "İçindekiler"
 }[key] }}{% endmacro %}
--- a/material/partials/language/uk.html
+++ b/material/partials/language/uk.html
@ -13,7 +13,6 @@
  "search.result.none": "Збігів не знайдено",
  "search.result.one": "Знайдено 1 збіг",
  "search.result.other": "Знайдено # збігів",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Перейти до змісту",
  "source.link.title": "Перейти до репозиторію",
  "toc.title": "Зміст"
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -47,7 +47,6 @@ theme:

  # Default values, taken from mkdocs_theme.yml
  language: en
-  direction: ltr
  feature:
    tabs: true
  palette:
--- a/src/assets/javascripts/components/Material/Search/Result.jsx
+++ b/src/assets/javascripts/components/Material/Search/Result.jsx
@ -170,13 +170,22 @@ export default class Result {
        /* Create stack and index */
        this.stack_ = []
        this.index_ = lunr(function() {
+          const filters = {
+            "search.pipeline.trimmer": lunr.trimmer,
+            "search.pipeline.stopwords": lunr.stopWordFilter
+          }
+
+          /* Disable stop words filter and trimmer, if desired */
+          const pipeline = Object.keys(filters).reduce((result, name) => {
+            if (!translate(name).match(/^false$/i))
+              result.push(filters[name])
+            return result
+          }, [])

          /* Remove stemmer, as it cripples search experience */
          this.pipeline.reset()
-          this.pipeline.add(
-            lunr.trimmer,
-            lunr.stopWordFilter
-          )
+          if (pipeline)
+            this.pipeline.add(...pipeline)

          /* Set up alternate search languages */
          if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) {
--- a/src/base.html
+++ b/src/base.html
@ -64,6 +64,8 @@
        "clipboard.copy",
        "clipboard.copied",
        "search.language",
+        "search.pipeline.stopwords",
+        "search.pipeline.trimmer",
        "search.result.none",
        "search.result.one",
        "search.result.other",
--- a/src/mkdocs_theme.yml
+++ b/src/mkdocs_theme.yml
@ -22,7 +22,7 @@
 language: en

 # Text direction (can be ltr or rtl)
-direction: ltr
+direction:

 # Feature flags for functionality that alters behavior significantly, and thus
 # may be a matter of taste
--- a/src/partials/language/da.html
+++ b/src/partials/language/da.html
@ -36,7 +36,6 @@
  "search.result.none": "Ingen resultater fundet",
  "search.result.one": "1 resultat",
  "search.result.other": "# resultater",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Gå til indholdet",
  "source.link.title": "Åbn arkiv",
  "toc.title": "Indholdsfortegnelse"
--- a/src/partials/language/de.html
+++ b/src/partials/language/de.html
@ -36,7 +36,6 @@
  "search.result.none": "Keine Suchergebnisse",
  "search.result.one": "1 Suchergebnis",
  "search.result.other": "# Suchergebnisse",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Zum Inhalt",
  "source.link.title": "Quellcode",
  "toc.title": "Inhaltsverzeichnis"
--- a/src/partials/language/en.html
+++ b/src/partials/language/en.html
@ -23,6 +23,7 @@
 <!-- Translations: English -->
 {% macro t(key) %}{{ {
  "language": "en",
+  "direction": "ltr",
  "clipboard.copy": "Copy to clipboard",
  "clipboard.copied": "Copied to clipboard",
  "edit.link.title": "Edit this page",
@ -31,6 +32,8 @@
  "meta.comments": "Comments",
  "meta.source": "Source",
  "search.language": "en",
+  "search.pipeline.stopwords": true,
+  "search.pipeline.trimmer": true,
  "search.placeholder": "Search",
  "search.result.placeholder": "Type to start searching",
  "search.result.none": "No matching documents",
--- a/src/partials/language/es.html
+++ b/src/partials/language/es.html
@ -36,7 +36,6 @@
  "search.result.none": "No se encontraron documentos",
  "search.result.one": "1 documento encontrado",
  "search.result.other": "# documentos encontrados",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Saltar a contenido",
  "source.link.title": "Ir al repositorio",
  "toc.title": "Tabla de contenidos"
--- a/src/partials/language/fa.html
+++ b/src/partials/language/fa.html
@ -31,13 +31,14 @@
  "footer.next": "بعدی",
  "meta.comments": "نظرات",
  "meta.source": "منبع",
-  "search.language": "en",
+  "search.language": "",
+  "search.pipeline.stopwords": false,
+  "search.pipeline.trimmer": false,
  "search.placeholder": "جستجو",
  "search.result.placeholder": "برای شروع جستجو تایپ کنید",
  "search.result.none": "سندی یافت نشد",
  "search.result.one": "1 سند یافت شد",
  "search.result.other": "# سند یافت شد",
-  "search.tokenizer": "[\s]+",
  "skip.link.title": "پرش به محتویات",
  "source.link.title": "رفتن به مخزن",
  "toc.title": "فهرست موضوعات"
--- a/src/partials/language/fr.html
+++ b/src/partials/language/fr.html
@ -36,7 +36,6 @@
  "search.result.none": "Aucun document trouvé",
  "search.result.one": "1 document trouvé",
  "search.result.other": "# documents trouvés",
-  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Aller au dépôt",
  "toc.title": "Table des matières"
 }[key] }}{% endmacro %}
--- a/src/partials/language/hu.html
+++ b/src/partials/language/hu.html
@ -36,7 +36,6 @@
  "search.result.none": "Nincs találat",
  "search.result.one": "1 egyező dokumentum",
  "search.result.other": "# egyező dokumentum",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Kihagyás",
  "source.link.title": "Főoldalra ugrás",
  "toc.title": "Tartalomjegyzék"
--- a/src/partials/language/it.html
+++ b/src/partials/language/it.html
@ -36,7 +36,6 @@
  "search.result.none": "Nessun documento trovato",
  "search.result.one": "1 documento trovato",
  "search.result.other": "# documenti trovati",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Vai al contenuto",
  "source.link.title": "Apri repository",
  "toc.title": "Indice"
--- a/src/partials/language/kr.html
+++ b/src/partials/language/kr.html
@ -36,7 +36,6 @@
  "search.result.none": "검색어와 일치하는 문서가 없습니다",
  "search.result.one": "1개의 일치하는 문서",
  "search.result.other": "#개의 일치하는 문서",
-  "search.tokenizer": "[\s\-]+",
  "source.link.title": "저장소로 이동",
  "toc.title": "목차"
 }[key] }}{% endmacro %}
--- a/src/partials/language/nl.html
+++ b/src/partials/language/nl.html
@ -36,7 +36,6 @@
  "search.result.none": "Geen overeenkomende documenten",
  "search.result.one": "1 overeenkomende document",
  "search.result.other": "# overeenkomende documenten",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Ga naar inhoud",
  "source.link.title": "Ga naar repository",
  "toc.title": "Inhoudstafel"
--- a/src/partials/language/no.html
+++ b/src/partials/language/no.html
@ -36,7 +36,6 @@
  "search.result.none": "Ingen treff",
  "search.result.one": "1 treff",
  "search.result.other": "# treff",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Gå til innhold",
  "source.link.title": "Gå til kilde",
  "toc.title": "Innholdsfortegnelse"
--- a/src/partials/language/pl.html
+++ b/src/partials/language/pl.html
@ -30,12 +30,14 @@
  "footer.next": "Następna strona",
  "meta.comments": "Komentarze",
  "meta.source": "Kod źródłowy",
+  "search.language": "",
+  "search.pipeline.stopwords": false,
+  "search.pipeline.trimmer": false,
  "search.placeholder": "Szukaj",
  "search.result.placeholder": "Zacznij pisać, aby szukać",
  "search.result.none": "Brak wyników wyszukiwania",
  "search.result.one": "Wyniki wyszukiwania: 1",
  "search.result.other": "Wyniki wyszukiwania: #",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Przejdź do treści",
  "source.link.title": "Idź do repozytorium",
  "toc.title": "Spis treści"
--- a/src/partials/language/pt.html
+++ b/src/partials/language/pt.html
@ -36,7 +36,6 @@
  "search.result.none": "Nenhum resultado encontrado",
  "search.result.one": "1 resultado encontrado",
  "search.result.other": "# resultados encontrados",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Ir para o conteúdo",
  "source.link.title": "Ir ao repositório",
  "toc.title": "Índice"
--- a/src/partials/language/ru.html
+++ b/src/partials/language/ru.html
@ -36,7 +36,6 @@
  "search.result.none": "Совпадений не найдено",
  "search.result.one": "Найдено 1 совпадение",
  "search.result.other": "Найдено # совпадений",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Перейти к содержанию",
  "source.link.title": "Перейти к репозиторию",
  "toc.title": "Содержание"
--- a/src/partials/language/sv.html
+++ b/src/partials/language/sv.html
@ -36,7 +36,6 @@
  "search.result.none": "Inga sökresultat",
  "search.result.one": "1 sökresultat",
  "search.result.other": "# sökresultat",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Gå till innehållet",
  "source.link.title": "Gå till datakatalog",
  "toc.title": "Innehållsförteckning"
--- a/src/partials/language/tr.html
+++ b/src/partials/language/tr.html
@ -36,7 +36,6 @@
  "search.result.none": "Eşleşen doküman bulunamadı",
  "search.result.one": "1 doküman bulundu",
  "search.result.other": "# doküman bulundu",
-  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Depoya git",
  "toc.title": "İçindekiler"
 }[key] }}{% endmacro %}
--- a/src/partials/language/uk.html
+++ b/src/partials/language/uk.html
@ -36,7 +36,6 @@
  "search.result.none": "Збігів не знайдено",
  "search.result.one": "Знайдено 1 збіг",
  "search.result.other": "Знайдено # збігів",
-  "search.tokenizer": "[\s\-]+",
  "skip.link.title": "Перейти до змісту",
  "source.link.title": "Перейти до репозиторію",
  "toc.title": "Зміст"