Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix minor search summary issues #10548

Merged
merged 3 commits into from Jul 12, 2022
Merged

Fix minor search summary issues #10548

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d61c2b3
Fix search summary element type
shiftinv Jun 13, 2022
7671d60
Fix search summary capitalization
shiftinv Jun 13, 2022
fe6658e
Fix removal of header links in search summary
shiftinv Jun 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions sphinx/themes/basic/static/searchtools.js
View file
Open in desktop
Expand Up @@ -158,7 +158,7 @@ const Search = {
const htmlElement = document
.createRange()
.createContextualFragment(htmlString);
_removeChildren(htmlElement.querySelectorAll(".headerlink"));
htmlElement.querySelectorAll(".headerlink").forEach((el) => el.parentNode.removeChild(el));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the functional change here?

Copy link
Contributor Author

@shiftinv shiftinv Jun 13, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This previously used jQuery's htmlElement.find('.headerlink').remove(), which would remove the .headerlinks themselves.
As far as I can tell, _removeChildren is meant to be a replacement for .empty() - it only takes a single element instead of a NodeList as returned by querySelectorAll, and would only remove child elements instead of the element itself; as it stands right now I'm fairly sure this particular call is effectively a no-op.

The functional change here is just getting rid of the glyphs in the output as intended.

const docContent = htmlElement.querySelector('[role="main"]');
if (docContent !== undefined) return docContent.textContent;
console.warn(
Expand Down Expand Up @@ -504,19 +504,20 @@ const Search = {
* latter for highlighting it.
*/
makeSearchSummary: (htmlText, keywords, highlightWords) => {
const text = Search.htmlToText(htmlText).toLowerCase();
const text = Search.htmlToText(htmlText);
if (text === "") return null;

const textLower = text.toLowerCase();
const actualStartPosition = [...keywords]
.map((k) => text.indexOf(k.toLowerCase()))
.map((k) => textLower.indexOf(k.toLowerCase()))
.filter((i) => i > -1)
.slice(-1)[0];
const startWithContext = Math.max(actualStartPosition - 120, 0);

const top = startWithContext === 0 ? "" : "...";
const tail = startWithContext + 240 < text.length ? "..." : "";

let summary = document.createElement("div");
let summary = document.createElement("p");
summary.classList.add("context");
summary.innerText = top + text.substr(startWithContext, 240).trim() + tail;

Expand Down