Add breadcrumbs to search results

Author: ksuess

docs/_static/searchtools.js

@@ -9,6 +9,7 @@
  *
  */
 
+var title_documentation = 'Plone Documentation';
 
 if (!Scorer) {
   /**
@@ -199,10 +200,6 @@ var Search = {
     }
     var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
 
-    // console.debug('SEARCH: searching for:');
-    // console.info('required: ', searchterms);
-    // console.info('excluded: ', excluded);
-
     // prepare search
     var terms = this._index.terms;
     var titleterms = this._index.titleterms;
@@ -257,8 +254,28 @@ var Search = {
       }
     });
 
+    function _getBreadcrumbs(item, linkUrl) {
+      let path = item[0];
+      let parentTitles = item[6];
+      let markup = path.split('/')
+        .slice(0, -1);
+      markup = markup.map((el, index) => {
+        return {
+          "path": markup.slice(0, index+1).join('/'),
+          "title": parentTitles[index]
+        }
+      })
+      markup = markup
+        .map((el) => {
+            let foo = `<a href="/${el.path}"> ${el.title}</a>`
+            return foo;
+          })
+      markup.push(`<span class="lastbreadcrumb">${item[1]}</span>`)
+      markup = markup.join('<span class="pathseparator">&gt;</span>');
+      return markup
+    }
 
-    // print the results
+    // Print the results.
     var resultCount = results.length;
     function displayNextItem() {
       // results left, load the summary and display it
@@ -283,11 +300,16 @@ var Search = {
           requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
           linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
         }
-        listItem.append($('<a/>').attr('href',
-            linkUrl +
-            highlightstring + item[2]).html(item[1]));
+        let breadcrumbs = _getBreadcrumbs(item, linkUrl);
+        breadcrumbs = $("<div class='breadcrumbs'>" + breadcrumbs + "</div>");
+        listItem.append(breadcrumbs);
+        let headline = $('<h3/>');
+        headline.append($('<a/>').attr('href',
+          linkUrl +
+          highlightstring + item[2]).html(item[1]));
 
-        listItem.append($('<span class="title_doc_section">' + item[6] + '</span>'));
+        // headline.append($('<span class="title_doc_section">' + item[6] + '</span>'));
+        listItem.append(headline);
 
         if (item[3]) {
           listItem.append($('<span> (' + item[3] + ')</span>'));
@@ -321,9 +343,9 @@ var Search = {
         Search.stopPulse();
         Search.title.text(_('Search Results'));
         if (!resultCount)
-          Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
+          Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly. Searching for multiple words only shows matches that contain all words.'));
         else
-            Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
+            Search.status.text(_('Found %s page(s) matching the search query.').replace('%s', resultCount));
         Search.status.fadeIn(500);
       }
     }
@@ -344,7 +366,9 @@ var Search = {
     var results = [];
 
     for (var prefix in objects) {
-      for (var name in objects[prefix]) {
+      for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
+        var match = objects[prefix][iMatch];
+        var name = match[4];
         var fullname = (prefix ? prefix + '.' : '') + name;
         var fullnameLower = fullname.toLowerCase()
         if (fullnameLower.indexOf(object) > -1) {
@@ -358,7 +382,6 @@ var Search = {
           } else if (parts[parts.length - 1].indexOf(object) > -1) {
             score += Scorer.objPartialMatch;
           }
-          var match = objects[prefix][name];
           var objname = objnames[match[1]][2];
           var title = titles[match[0]];
           // If more than one term searched for, we require other words to be
@@ -496,19 +519,41 @@ var Search = {
           break;
         }
       }
-
       // if we have still a valid result we can add it to the result list
       if (valid) {
+        /**
+         * file: index
+         * docnames: array of paths
+         * titles: array of titles
+         */
+
         // select one (max) score for the file.
         // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
         var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
-        function getParentTitle(f) {
+
+        function get1stLevelAncestor(f) {
           let parentdocname = docnames[f].split('/')[0] + '/index';
           let parentID = docnames.indexOf(parentdocname);
-          let title = parentID === -1 ? 'Plone Documentation' : titles[parentID];
+          let title = parentID === -1 ? title_documentation : titles[parentID];
           return title
         }
-        results.push([docnames[file], titles[file], '', null, score, filenames[file], getParentTitle(file)]);
+        function getParentTitles(idx) {
+          let path = docnames[idx]
+
+          let foo = path.split('/').slice(0, -1);
+          foo = foo.map((el, index) => {
+            return `${foo.slice(0, index+1).join('/')}/index`
+          })
+      
+          let parentTitles = foo.map(el => {
+            let parentId = docnames.indexOf(el);
+            let title = parentId === -1 ? title_documentation : titles[parentId];
+            return title
+          })
+          return parentTitles
+        }
+
+        results.push([docnames[file], titles[file], '', null, score, filenames[file], getParentTitles(file)]);
       }
     }
     return results;