forked from sphinx-doc/sphinx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
163 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /* Highlighting utilities for Sphinx HTML documentation. */ | ||
| "use strict"; | ||
|
|
||
| /** | ||
| * highlight a given string on a node by wrapping it in | ||
| * span elements with the given class name. | ||
| */ | ||
| const _highlight = (node, addItems, text, className) => { | ||
| if (node.nodeType === Node.TEXT_NODE) { | ||
| const val = node.nodeValue; | ||
| const parent = node.parentNode; | ||
| const pos = val.toLowerCase().indexOf(text); | ||
| if ( | ||
| pos >= 0 && | ||
| !parent.classList.contains(className) && | ||
| !parent.classList.contains("nohighlight") | ||
| ) { | ||
| let span; | ||
|
|
||
| const closestNode = parent.closest("body, svg, foreignObject"); | ||
| const isInSVG = closestNode && closestNode.matches("svg"); | ||
| if (isInSVG) { | ||
| span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); | ||
| } else { | ||
| span = document.createElement("span"); | ||
| span.classList.add(className); | ||
| } | ||
|
|
||
| span.appendChild(document.createTextNode(val.substr(pos, text.length))); | ||
| parent.insertBefore( | ||
| span, | ||
| parent.insertBefore( | ||
| document.createTextNode(val.substr(pos + text.length)), | ||
| node.nextSibling | ||
| ) | ||
| ); | ||
| node.nodeValue = val.substr(0, pos); | ||
|
|
||
| if (isInSVG) { | ||
| const rect = document.createElementNS( | ||
| "http://www.w3.org/2000/svg", | ||
| "rect" | ||
| ); | ||
| const bbox = parent.getBBox(); | ||
| rect.x.baseVal.value = bbox.x; | ||
| rect.y.baseVal.value = bbox.y; | ||
| rect.width.baseVal.value = bbox.width; | ||
| rect.height.baseVal.value = bbox.height; | ||
| rect.setAttribute("class", className); | ||
| addItems.push({ parent: parent, target: rect }); | ||
| } | ||
| } | ||
| } else if (node.matches && !node.matches("button, select, textarea")) { | ||
| node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); | ||
| } | ||
| }; | ||
| const _highlightText = (thisNode, text, className) => { | ||
| let addItems = []; | ||
| _highlight(thisNode, addItems, text, className); | ||
| addItems.forEach((obj) => | ||
| obj.parent.insertAdjacentElement("beforebegin", obj.target) | ||
| ); | ||
| }; | ||
|
|
||
| /** | ||
| * Small JavaScript module for the documentation. | ||
| */ | ||
| const SphinxHighlight = { | ||
|
|
||
| /** | ||
| * highlight the search words provided in the url in the text | ||
| */ | ||
| highlightSearchWords: () => { | ||
| const highlight = | ||
| new URLSearchParams(window.location.search).get("highlight") || ""; | ||
| const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); | ||
| if (terms.length === 0) return; // nothing to do | ||
|
|
||
| // There should never be more than one element matching "div.body" | ||
| const divBody = document.querySelectorAll("div.body"); | ||
| const body = divBody.length ? divBody[0] : document.querySelector("body"); | ||
| window.setTimeout(() => { | ||
| terms.forEach((term) => _highlightText(body, term, "highlighted")); | ||
| }, 10); | ||
|
|
||
| const searchBox = document.getElementById("searchbox"); | ||
| if (searchBox === null) return; | ||
| searchBox.appendChild( | ||
| document | ||
| .createRange() | ||
| .createContextualFragment( | ||
| '<p class="highlight-link">' + | ||
| '<a href="javascript:SphinxHighlight.hideSearchWords()">' + | ||
| Documentation.gettext("Hide Search Matches") + | ||
| "</a></p>" | ||
| ) | ||
| ); | ||
| }, | ||
|
|
||
| /** | ||
| * helper function to hide the search marks again | ||
| */ | ||
| hideSearchWords: () => { | ||
| document | ||
| .querySelectorAll("#searchbox .highlight-link") | ||
| .forEach((el) => el.remove()); | ||
| document | ||
| .querySelectorAll("span.highlighted") | ||
| .forEach((el) => el.classList.remove("highlighted")); | ||
| const url = new URL(window.location); | ||
| url.searchParams.delete("highlight"); | ||
| window.history.replaceState({}, "", url); | ||
| }, | ||
|
|
||
| initOnKeyListeners: () => { | ||
| // only install a listener if it is really needed | ||
| if ( | ||
| !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS | ||
| ) | ||
| return; | ||
|
|
||
| const blacklistedElements = new Set([ | ||
| "TEXTAREA", | ||
| "INPUT", | ||
| "SELECT", | ||
| "BUTTON", | ||
| ]); | ||
| document.addEventListener("keydown", (event) => { | ||
| if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements | ||
| if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys | ||
|
|
||
| if (!event.shiftKey) { | ||
| switch (event.key) { | ||
| case "Escape": | ||
| if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; | ||
| SphinxHighlight.hideSearchWords(); | ||
| event.preventDefault(); | ||
| } | ||
| } | ||
| }); | ||
| }, | ||
| }; | ||
|
|
||
| _ready(SphinxHighlight.highlightSearchWords); | ||
| _ready(SphinxHighlight.initOnKeyListeners); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| const DOCUMENTATION_OPTIONS = {}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| const DOCUMENTATION_OPTIONS = {}; | ||
|
|
||
| describe('highlightText', function() { | ||
|
|
||
| const cyrillicTerm = 'шеллы'; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters