Add section linking for the search result

readthedocs/core/static-src/core/js/doc-embed/search.js

@@ -4,6 +4,7 @@
 
 var rtddata = require('./rtd-data');
 var xss = require('xss/lib/index');
+var MAX_RESULT_PER_SECTION = 3;
 
 
 /*
@@ -35,14 +36,25 @@ function attach_elastic_search_query(data) {
                     for (var i = 0; i < hit_list.length; i += 1) {
                         var doc = hit_list[i];
                         var highlight = doc.highlight;
+                        var inner_hits = doc.inner_hits || [];
                         var list_item = $('<li style="display: none;"></li>');
 
+                        var title = doc.title;
+                        // if highlighted title is present,
+                        // use that.
+                        if (highlight) {
+                            if (highlight.title) {
+                                title = xss(highlight.title[0]);
+                            }
+                        }
+
                         // Creating the result from elements
-                        var link = doc.link + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
-                                   '?highlight=' + $.urlencode(query);
+                        var link = doc.link + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+                        var highlight_link = link + "?highlight=" + $.urlencode(query);
 
-                        var item = $('<a>', {'href': link});
-                        item.html(doc.title);
+                        var item = $('<a>', {'href': highlight_link});
+                        item.html(title);
+                        item.find('em').addClass('highlighted');
                         list_item.append(item);
 
                         // If the document is from subproject, add extra information
@@ -53,20 +65,118 @@ function attach_elastic_search_query(data) {
                             list_item.append(extra);
                         }
 
-                        // Show highlighted texts
-                        if (highlight.content) {
-                            for (var index = 0; index < highlight.content.length; index += 1) {
-                                if (index < 3) {
-                                    // Show up to 3 results for search
-                                    var content = highlight.content[index];
-                                    var content_text = xss(content);
-                                    var contents = $('<div class="context">');
-
-                                    contents.html("..." + content_text + "...");
-                                    contents.find('em').addClass('highlighted');
-                                    list_item.append(contents);
+                        for (var j = 0; j < inner_hits.length; j += 1) {
+
+                            var contents = $('<div class="context">');
+
+                            var section_template = '' +
+                                '<div>' +
+                                    '<a href="<%= section_subtitle_link %>">' +
+                                        '<%= section_subtitle %>' +
+                                    '</a>' +
+                                '</div>' +
+                                '<% for (var i = 0; i < section_content.length; ++i) { %>' +
+                                    '<div>' +
+                                        '<%= section_content[i] %>' +
+                                    '</div>' +
+                                '<% } %>';
+
+                            var domain_template = '' +
+                                '<div>' +
+                                    '<a href="<%= domain_subtitle_link %>">' +
+                                        '<%= domain_subtitle %>' +
+                                    '</a>' +
+                                '</div>' +
+                                '<span>' +
+                                    '<%= domain_content %>' +
+                                '</span>';
+
+                            // if the result is page section
+                            if(inner_hits[j].type === "sections") {
+
+                                var section = inner_hits[j];
+                                var section_subtitle = section._source.title;
+                                var section_subtitle_link = link + "#" + section._source.id;
+                                var section_content = [section._source.content.substring(0, 100) + " ..."];
+
+                                if (section.highlight) {
+                                    if (section.highlight["sections.title"]) {
+                                        section_subtitle = xss(section.highlight["sections.title"][0]);
+                                    }
+
+                                    if (section.highlight["sections.content"]) {
+                                        var content = section.highlight["sections.content"];
+                                        section_content = [];
+                                        for (
+                                            var k = 0;
+                                            k < content.length && k < MAX_RESULT_PER_SECTION;
+                                             k += 1
+                                        ) {
+                                            section_content.push("... " + xss(content[k]) + " ...");
+                                        }
+                                    }
+                                }
+
+                                contents.append(
+                                    $u.template(
+                                        section_template,
+                                        {
+                                            section_subtitle_link: section_subtitle_link,
+                                            section_subtitle: section_subtitle,
+                                            section_content: section_content
+                                        }
+                                    )
+                                );
+                            }
+
+                            // if the result is a sphinx domain object
+                            if (inner_hits[j].type === "domains") {
+
+                                var domain = inner_hits[j];
+                                var domain_subtitle = domain._source.role_name;
+                                var domain_subtitle_link = link + "#" + domain._source.anchor;
+                                var domain_content = "";
+
+                                if (
+                                    typeof domain._source.display_name === "string" &&
+                                    domain._source.display_name.length >= 1
+                                ) {
+                                    domain_subtitle = "(" + domain._source.role_name + ") " + domain._source.display_name;
                                 }
+
+                                // preparing domain_content
+                                // domain_content = type_display --
+                                domain_content = domain._source.type_display + " -- ";
+                                if (domain.highlight) {
+                                    if (domain.highlight["domains.name"]) {
+                                        // domain_content = type_display -- name
+                                        domain_content += xss(domain.highlight["domains.name"][0]);
+                                    } else {
+                                        // domain_content = type_display -- name
+                                        domain_content += domain._source.name;
+                                    }
+                                } else {
+                                    // domain_content = type_display -- name
+                                    domain_content += domain._source.name;
+                                }
+                                // domain_content = type_display -- name -- in doc_display
+                                domain_content += " -- in " + domain._source.doc_display;
+
+                                contents.append(
+                                    $u.template(
+                                        domain_template,
+                                        {
+                                            domain_subtitle_link: domain_subtitle_link,
+                                            domain_subtitle: domain_subtitle,
+                                            domain_content: domain_content
+                                        }
+                                    )
+                                );
                             }
+
+                            contents.find('em').addClass('highlighted');
+                            list_item.append(contents);
+                            list_item.append($("<br>"));
                         }
 
                         Search.output.append(list_item);

readthedocs/core/templatetags/core_tags.py

@@ -109,6 +109,14 @@ def key(d, key_name):
     return d[key_name]
 
 
+@register.filter
+def get_key_or_none(d, key_name):
+    try:
+        return d[key_name]
+    except KeyError:
+        return None
+
+
 @register.simple_tag
 def readthedocs_version():
     return __version__

readthedocs/projects/models.py

@@ -1252,8 +1252,6 @@ def get_processed_json(self):
                 file_path,
             )
         return {
-            'headers': [],
-            'content': '',
             'path': file_path,
             'title': '',
             'sections': [],