Merge pull request #5932 from dojutsu-user/fix-spacing-bw-results

Fix spacing between the results and add highlight url param

Author: ericholscher

media/css/readthedocs-doc-embed.css

@@ -286,3 +286,8 @@ div.ethical-footer {
     font-size: 14px;
     line-height: 20px;
 }
+
+/* Margin between the search results */
+.rtd_search_hits_spacing {
+    margin: 10px 0;
+}

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

@@ -50,10 +50,9 @@ function attach_elastic_search_query(data) {
                         }
 
                         // Creating the result from elements
-                        var link = doc.link + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
-                        var highlight_link = link + "?highlight=" + $.urlencode(query);
+                        var link = doc.link + DOCUMENTATION_OPTIONS.FILE_SUFFIX + "?highlight=" + $.urlencode(query);
 
-                        var item = $('<a>', {'href': highlight_link});
+                        var item = $('<a>', {'href': link});
                         item.html(title);
                         item.find('em').addClass('highlighted');
                         list_item.append(item);
@@ -170,7 +169,12 @@ function attach_elastic_search_query(data) {
 
                             contents.find('em').addClass('highlighted');
                             list_item.append(contents);
-                            list_item.append($("<br>"));
+
+                            // Create some spacing between the results.
+                            // Also, don't add this spacing in the last hit.
+                            if (j !== inner_hits.length - 1) {
+                                list_item.append($("<div class='rtd_search_hits_spacing'></div>"));
+                            }
                         }
 
                         Search.output.append(list_item);

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

@@ -186,7 +186,7 @@ <h3>
                     {% for inner_hit in result.meta.inner_hits %}
                       {% if inner_hit.type == 'domains' %}
                         <p>
-                          <a href="{% doc_url result.project|get_project result.version inner_hit.source.doc_name %}#{{ inner_hit.source.anchor }}">
+                          <a href="{% doc_url result.project|get_project result.version inner_hit.source.doc_name %}?highlight= {{ query }}#{{ inner_hit.source.anchor }}">
 
                             {% if inner_hit.source.display_name|length >= 1 %}
                               ({{ inner_hit.source.role_name }}) {{ inner_hit.source.display_name}}
@@ -207,7 +207,7 @@ <h3>
 
                       {% elif inner_hit.type == 'sections' %}
                         <p>
-                          <a href="{% doc_url result.project|get_project result.version result.full_path %}#{{ inner_hit.source.id }}">
+                          <a href="{% doc_url result.project|get_project result.version result.full_path %}?highlight={{ query }}#{{ inner_hit.source.id }}">
                             {% if inner_hit.highlight|get_key_or_none:"sections.title" %}
                               {% with section_title=inner_hit.highlight|get_key_or_none:"sections.title" %}
                                 {{ section_title.0|safe }}