Merge pull request #2414 from notriddle/on2
Load the sidebar toc from a shared JS file or iframe
This commit is contained in:
commit
271bbba7dd
9 changed files with 272 additions and 122 deletions
|
|
@ -528,6 +528,11 @@ impl Renderer for HtmlHandlebars {
|
||||||
debug!("Register the header handlebars template");
|
debug!("Register the header handlebars template");
|
||||||
handlebars.register_partial("header", String::from_utf8(theme.header.clone())?)?;
|
handlebars.register_partial("header", String::from_utf8(theme.header.clone())?)?;
|
||||||
|
|
||||||
|
debug!("Register the toc handlebars template");
|
||||||
|
handlebars.register_template_string("toc_js", String::from_utf8(theme.toc_js.clone())?)?;
|
||||||
|
handlebars
|
||||||
|
.register_template_string("toc_html", String::from_utf8(theme.toc_html.clone())?)?;
|
||||||
|
|
||||||
debug!("Register handlebars helpers");
|
debug!("Register handlebars helpers");
|
||||||
self.register_hbs_helpers(&mut handlebars, &html_config);
|
self.register_hbs_helpers(&mut handlebars, &html_config);
|
||||||
|
|
||||||
|
|
@ -583,6 +588,18 @@ impl Renderer for HtmlHandlebars {
|
||||||
debug!("Creating print.html ✓");
|
debug!("Creating print.html ✓");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
debug!("Render toc");
|
||||||
|
{
|
||||||
|
let rendered_toc = handlebars.render("toc_js", &data)?;
|
||||||
|
utils::fs::write_file(destination, "toc.js", rendered_toc.as_bytes())?;
|
||||||
|
debug!("Creating toc.js ✓");
|
||||||
|
data.insert("is_toc_html".to_owned(), json!(true));
|
||||||
|
let rendered_toc = handlebars.render("toc_html", &data)?;
|
||||||
|
utils::fs::write_file(destination, "toc.html", rendered_toc.as_bytes())?;
|
||||||
|
debug!("Creating toc.html ✓");
|
||||||
|
data.remove("is_toc_html");
|
||||||
|
}
|
||||||
|
|
||||||
debug!("Copy static files");
|
debug!("Copy static files");
|
||||||
self.copy_static_files(destination, &theme, &html_config)
|
self.copy_static_files(destination, &theme, &html_config)
|
||||||
.with_context(|| "Unable to copy across static files")?;
|
.with_context(|| "Unable to copy across static files")?;
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,7 @@
|
||||||
use std::path::Path;
|
use std::path::Path;
|
||||||
use std::{cmp::Ordering, collections::BTreeMap};
|
use std::{cmp::Ordering, collections::BTreeMap};
|
||||||
|
|
||||||
use crate::utils;
|
use crate::utils::special_escape;
|
||||||
use crate::utils::bracket_escape;
|
|
||||||
|
|
||||||
use handlebars::{
|
use handlebars::{
|
||||||
Context, Handlebars, Helper, HelperDef, Output, RenderContext, RenderError, RenderErrorReason,
|
Context, Handlebars, Helper, HelperDef, Output, RenderContext, RenderError, RenderErrorReason,
|
||||||
|
|
@ -32,21 +31,6 @@ impl HelperDef for RenderToc {
|
||||||
RenderErrorReason::Other("Could not decode the JSON data".to_owned()).into()
|
RenderErrorReason::Other("Could not decode the JSON data".to_owned()).into()
|
||||||
})
|
})
|
||||||
})?;
|
})?;
|
||||||
let current_path = rc
|
|
||||||
.evaluate(ctx, "@root/path")?
|
|
||||||
.as_json()
|
|
||||||
.as_str()
|
|
||||||
.ok_or_else(|| {
|
|
||||||
RenderErrorReason::Other("Type error for `path`, string expected".to_owned())
|
|
||||||
})?
|
|
||||||
.replace('\"', "");
|
|
||||||
|
|
||||||
let current_section = rc
|
|
||||||
.evaluate(ctx, "@root/section")?
|
|
||||||
.as_json()
|
|
||||||
.as_str()
|
|
||||||
.map(str::to_owned)
|
|
||||||
.unwrap_or_default();
|
|
||||||
|
|
||||||
let fold_enable = rc
|
let fold_enable = rc
|
||||||
.evaluate(ctx, "@root/fold_enable")?
|
.evaluate(ctx, "@root/fold_enable")?
|
||||||
|
|
@ -64,31 +48,27 @@ impl HelperDef for RenderToc {
|
||||||
RenderErrorReason::Other("Type error for `fold_level`, u64 expected".to_owned())
|
RenderErrorReason::Other("Type error for `fold_level`, u64 expected".to_owned())
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
|
// If true, then this is the iframe and we need target="_parent"
|
||||||
|
let is_toc_html = rc
|
||||||
|
.evaluate(ctx, "@root/is_toc_html")?
|
||||||
|
.as_json()
|
||||||
|
.as_bool()
|
||||||
|
.unwrap_or(false);
|
||||||
|
|
||||||
out.write("<ol class=\"chapter\">")?;
|
out.write("<ol class=\"chapter\">")?;
|
||||||
|
|
||||||
let mut current_level = 1;
|
let mut current_level = 1;
|
||||||
// The "index" page, which has this attribute set, is supposed to alias the first chapter in
|
|
||||||
// the book, i.e. the first link. There seems to be no easy way to determine which chapter
|
|
||||||
// the "index" is aliasing from within the renderer, so this is used instead to force the
|
|
||||||
// first link to be active. See further below.
|
|
||||||
let mut is_first_chapter = ctx.data().get("is_index").is_some();
|
|
||||||
|
|
||||||
for item in chapters {
|
for item in chapters {
|
||||||
let (section, level) = if let Some(s) = item.get("section") {
|
let (_section, level) = if let Some(s) = item.get("section") {
|
||||||
(s.as_str(), s.matches('.').count())
|
(s.as_str(), s.matches('.').count())
|
||||||
} else {
|
} else {
|
||||||
("", 1)
|
("", 1)
|
||||||
};
|
};
|
||||||
|
|
||||||
let is_expanded =
|
// Expand if folding is disabled, or if levels that are larger than this would not
|
||||||
if !fold_enable || (!section.is_empty() && current_section.starts_with(section)) {
|
// be folded.
|
||||||
// Expand if folding is disabled, or if the section is an
|
let is_expanded = !fold_enable || level - 1 < (fold_level as usize);
|
||||||
// ancestor or the current section itself.
|
|
||||||
true
|
|
||||||
} else {
|
|
||||||
// Levels that are larger than this would be folded.
|
|
||||||
level - 1 < fold_level as usize
|
|
||||||
};
|
|
||||||
|
|
||||||
match level.cmp(¤t_level) {
|
match level.cmp(¤t_level) {
|
||||||
Ordering::Greater => {
|
Ordering::Greater => {
|
||||||
|
|
@ -121,7 +101,7 @@ impl HelperDef for RenderToc {
|
||||||
// Part title
|
// Part title
|
||||||
if let Some(title) = item.get("part") {
|
if let Some(title) = item.get("part") {
|
||||||
out.write("<li class=\"part-title\">")?;
|
out.write("<li class=\"part-title\">")?;
|
||||||
out.write(&bracket_escape(title))?;
|
out.write(&special_escape(title))?;
|
||||||
out.write("</li>")?;
|
out.write("</li>")?;
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
@ -139,16 +119,12 @@ impl HelperDef for RenderToc {
|
||||||
.replace('\\', "/");
|
.replace('\\', "/");
|
||||||
|
|
||||||
// Add link
|
// Add link
|
||||||
out.write(&utils::fs::path_to_root(¤t_path))?;
|
|
||||||
out.write(&tmp)?;
|
out.write(&tmp)?;
|
||||||
out.write("\"")?;
|
out.write(if is_toc_html {
|
||||||
|
"\" target=\"_parent\">"
|
||||||
if path == ¤t_path || is_first_chapter {
|
} else {
|
||||||
is_first_chapter = false;
|
"\">"
|
||||||
out.write(" class=\"active\"")?;
|
})?;
|
||||||
}
|
|
||||||
|
|
||||||
out.write(">")?;
|
|
||||||
path_exists = true;
|
path_exists = true;
|
||||||
}
|
}
|
||||||
_ => {
|
_ => {
|
||||||
|
|
@ -167,7 +143,7 @@ impl HelperDef for RenderToc {
|
||||||
}
|
}
|
||||||
|
|
||||||
if let Some(name) = item.get("name") {
|
if let Some(name) = item.get("name") {
|
||||||
out.write(&bracket_escape(name))?
|
out.write(&special_escape(name))?
|
||||||
}
|
}
|
||||||
|
|
||||||
if path_exists {
|
if path_exists {
|
||||||
|
|
|
||||||
|
|
@ -420,6 +420,22 @@ ul#searchresults span.teaser em {
|
||||||
background-color: var(--sidebar-bg);
|
background-color: var(--sidebar-bg);
|
||||||
color: var(--sidebar-fg);
|
color: var(--sidebar-fg);
|
||||||
}
|
}
|
||||||
|
.sidebar-iframe-inner {
|
||||||
|
background-color: var(--sidebar-bg);
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
padding: 10px 10px;
|
||||||
|
margin: 0;
|
||||||
|
font-size: 1.4rem;
|
||||||
|
}
|
||||||
|
.sidebar-iframe-outer {
|
||||||
|
border: none;
|
||||||
|
height: 100%;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
left: 0;
|
||||||
|
right: 0;
|
||||||
|
}
|
||||||
[dir=rtl] .sidebar { left: unset; right: 0; }
|
[dir=rtl] .sidebar { left: unset; right: 0; }
|
||||||
.sidebar-resizing {
|
.sidebar-resizing {
|
||||||
-moz-user-select: none;
|
-moz-user-select: none;
|
||||||
|
|
|
||||||
|
|
@ -106,35 +106,17 @@
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||||||
<div class="sidebar-scrollbox">
|
<!-- populated by js -->
|
||||||
{{#toc}}{{/toc}}
|
<div class="sidebar-scrollbox"></div>
|
||||||
</div>
|
<noscript>
|
||||||
|
<iframe class="sidebar-iframe-outer" src="{{ path_to_root }}toc.html"></iframe>
|
||||||
|
</noscript>
|
||||||
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||||||
<div class="sidebar-resize-indicator"></div>
|
<div class="sidebar-resize-indicator"></div>
|
||||||
</div>
|
</div>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
<!-- Track and set sidebar scroll position -->
|
<script async src="{{ path_to_root }}toc.js"></script>
|
||||||
<script>
|
|
||||||
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
|
||||||
sidebarScrollbox.addEventListener('click', function(e) {
|
|
||||||
if (e.target.tagName === 'A') {
|
|
||||||
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
|
||||||
}
|
|
||||||
}, { passive: true });
|
|
||||||
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
|
||||||
sessionStorage.removeItem('sidebar-scroll');
|
|
||||||
if (sidebarScrollTop) {
|
|
||||||
// preserve sidebar scroll position when navigating via links within sidebar
|
|
||||||
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
|
||||||
} else {
|
|
||||||
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
|
||||||
var activeSection = document.querySelector('#sidebar .active');
|
|
||||||
if (activeSection) {
|
|
||||||
activeSection.scrollIntoView({ block: 'center' });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<div id="page-wrapper" class="page-wrapper">
|
<div id="page-wrapper" class="page-wrapper">
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,8 @@ pub static INDEX: &[u8] = include_bytes!("index.hbs");
|
||||||
pub static HEAD: &[u8] = include_bytes!("head.hbs");
|
pub static HEAD: &[u8] = include_bytes!("head.hbs");
|
||||||
pub static REDIRECT: &[u8] = include_bytes!("redirect.hbs");
|
pub static REDIRECT: &[u8] = include_bytes!("redirect.hbs");
|
||||||
pub static HEADER: &[u8] = include_bytes!("header.hbs");
|
pub static HEADER: &[u8] = include_bytes!("header.hbs");
|
||||||
|
pub static TOC_JS: &[u8] = include_bytes!("toc.js.hbs");
|
||||||
|
pub static TOC_HTML: &[u8] = include_bytes!("toc.html.hbs");
|
||||||
pub static CHROME_CSS: &[u8] = include_bytes!("css/chrome.css");
|
pub static CHROME_CSS: &[u8] = include_bytes!("css/chrome.css");
|
||||||
pub static GENERAL_CSS: &[u8] = include_bytes!("css/general.css");
|
pub static GENERAL_CSS: &[u8] = include_bytes!("css/general.css");
|
||||||
pub static PRINT_CSS: &[u8] = include_bytes!("css/print.css");
|
pub static PRINT_CSS: &[u8] = include_bytes!("css/print.css");
|
||||||
|
|
@ -50,6 +52,8 @@ pub struct Theme {
|
||||||
pub head: Vec<u8>,
|
pub head: Vec<u8>,
|
||||||
pub redirect: Vec<u8>,
|
pub redirect: Vec<u8>,
|
||||||
pub header: Vec<u8>,
|
pub header: Vec<u8>,
|
||||||
|
pub toc_js: Vec<u8>,
|
||||||
|
pub toc_html: Vec<u8>,
|
||||||
pub chrome_css: Vec<u8>,
|
pub chrome_css: Vec<u8>,
|
||||||
pub general_css: Vec<u8>,
|
pub general_css: Vec<u8>,
|
||||||
pub print_css: Vec<u8>,
|
pub print_css: Vec<u8>,
|
||||||
|
|
@ -85,6 +89,8 @@ impl Theme {
|
||||||
(theme_dir.join("head.hbs"), &mut theme.head),
|
(theme_dir.join("head.hbs"), &mut theme.head),
|
||||||
(theme_dir.join("redirect.hbs"), &mut theme.redirect),
|
(theme_dir.join("redirect.hbs"), &mut theme.redirect),
|
||||||
(theme_dir.join("header.hbs"), &mut theme.header),
|
(theme_dir.join("header.hbs"), &mut theme.header),
|
||||||
|
(theme_dir.join("toc.js.hbs"), &mut theme.toc_js),
|
||||||
|
(theme_dir.join("toc.html.hbs"), &mut theme.toc_html),
|
||||||
(theme_dir.join("book.js"), &mut theme.js),
|
(theme_dir.join("book.js"), &mut theme.js),
|
||||||
(theme_dir.join("css/chrome.css"), &mut theme.chrome_css),
|
(theme_dir.join("css/chrome.css"), &mut theme.chrome_css),
|
||||||
(theme_dir.join("css/general.css"), &mut theme.general_css),
|
(theme_dir.join("css/general.css"), &mut theme.general_css),
|
||||||
|
|
@ -174,6 +180,8 @@ impl Default for Theme {
|
||||||
head: HEAD.to_owned(),
|
head: HEAD.to_owned(),
|
||||||
redirect: REDIRECT.to_owned(),
|
redirect: REDIRECT.to_owned(),
|
||||||
header: HEADER.to_owned(),
|
header: HEADER.to_owned(),
|
||||||
|
toc_js: TOC_JS.to_owned(),
|
||||||
|
toc_html: TOC_HTML.to_owned(),
|
||||||
chrome_css: CHROME_CSS.to_owned(),
|
chrome_css: CHROME_CSS.to_owned(),
|
||||||
general_css: GENERAL_CSS.to_owned(),
|
general_css: GENERAL_CSS.to_owned(),
|
||||||
print_css: PRINT_CSS.to_owned(),
|
print_css: PRINT_CSS.to_owned(),
|
||||||
|
|
@ -232,6 +240,8 @@ mod tests {
|
||||||
"head.hbs",
|
"head.hbs",
|
||||||
"redirect.hbs",
|
"redirect.hbs",
|
||||||
"header.hbs",
|
"header.hbs",
|
||||||
|
"toc.js.hbs",
|
||||||
|
"toc.html.hbs",
|
||||||
"favicon.png",
|
"favicon.png",
|
||||||
"favicon.svg",
|
"favicon.svg",
|
||||||
"css/chrome.css",
|
"css/chrome.css",
|
||||||
|
|
@ -263,6 +273,8 @@ mod tests {
|
||||||
head: Vec::new(),
|
head: Vec::new(),
|
||||||
redirect: Vec::new(),
|
redirect: Vec::new(),
|
||||||
header: Vec::new(),
|
header: Vec::new(),
|
||||||
|
toc_js: Vec::new(),
|
||||||
|
toc_html: Vec::new(),
|
||||||
chrome_css: Vec::new(),
|
chrome_css: Vec::new(),
|
||||||
general_css: Vec::new(),
|
general_css: Vec::new(),
|
||||||
print_css: Vec::new(),
|
print_css: Vec::new(),
|
||||||
|
|
|
||||||
43
src/theme/toc.html.hbs
Normal file
43
src/theme/toc.html.hbs
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="{{ language }}" class="{{ default_theme }}" dir="{{ text_direction }}">
|
||||||
|
<head>
|
||||||
|
<!-- sidebar iframe generated using mdBook
|
||||||
|
|
||||||
|
This is a frame, and not included directly in the page, to control the total size of the
|
||||||
|
book. The TOC contains an entry for each page, so if each page includes a copy of the TOC,
|
||||||
|
the total size of the page becomes O(n**2).
|
||||||
|
|
||||||
|
The frame is only used as a fallback when JS is turned off. When it's on, the sidebar is
|
||||||
|
instead added to the main page by `toc.js` instead. The JavaScript mode is better
|
||||||
|
because, when running in a `file:///` URL, the iframed page would not be Same-Origin as
|
||||||
|
the rest of the page, so the sidebar and the main page theme would fall out of sync.
|
||||||
|
-->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="robots" content="noindex">
|
||||||
|
{{#if base_url}}
|
||||||
|
<base href="{{ base_url }}">
|
||||||
|
{{/if}}
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
{{> head}}
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<meta name="theme-color" content="#ffffff">
|
||||||
|
<link rel="stylesheet" href="{{ path_to_root }}css/variables.css">
|
||||||
|
<link rel="stylesheet" href="{{ path_to_root }}css/general.css">
|
||||||
|
<link rel="stylesheet" href="{{ path_to_root }}css/chrome.css">
|
||||||
|
{{#if print_enable}}
|
||||||
|
<link rel="stylesheet" href="{{ path_to_root }}css/print.css" media="print">
|
||||||
|
{{/if}}
|
||||||
|
<!-- Fonts -->
|
||||||
|
<link rel="stylesheet" href="{{ path_to_root }}FontAwesome/css/font-awesome.css">
|
||||||
|
{{#if copy_fonts}}
|
||||||
|
<link rel="stylesheet" href="{{ path_to_root }}fonts/fonts.css">
|
||||||
|
{{/if}}
|
||||||
|
<!-- Custom theme stylesheets -->
|
||||||
|
{{#each additional_css}}
|
||||||
|
<link rel="stylesheet" href="{{ ../path_to_root }}{{ this }}">
|
||||||
|
{{/each}}
|
||||||
|
</head>
|
||||||
|
<body class="sidebar-iframe-inner">
|
||||||
|
{{#toc}}{{/toc}}
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
54
src/theme/toc.js.hbs
Normal file
54
src/theme/toc.js.hbs
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
// Populate the sidebar
|
||||||
|
//
|
||||||
|
// This is a script, and not included directly in the page, to control the total size of the book.
|
||||||
|
// The TOC contains an entry for each page, so if each page includes a copy of the TOC,
|
||||||
|
// the total size of the page becomes O(n**2).
|
||||||
|
var sidebarScrollbox = document.querySelector("#sidebar .sidebar-scrollbox");
|
||||||
|
sidebarScrollbox.innerHTML = '{{#toc}}{{/toc}}';
|
||||||
|
(function() {
|
||||||
|
let current_page = document.location.href.toString();
|
||||||
|
if (current_page.endsWith("/")) {
|
||||||
|
current_page += "index.html";
|
||||||
|
}
|
||||||
|
var links = sidebarScrollbox.querySelectorAll("a");
|
||||||
|
var l = links.length;
|
||||||
|
for (var i = 0; i < l; ++i) {
|
||||||
|
var link = links[i];
|
||||||
|
var href = link.getAttribute("href");
|
||||||
|
if (href && !href.startsWith("#") && !/^(?:[a-z+]+:)?\/\//.test(href)) {
|
||||||
|
link.href = path_to_root + href;
|
||||||
|
}
|
||||||
|
// The "index" page is supposed to alias the first chapter in the book.
|
||||||
|
if (link.href === current_page || (i === 0 && path_to_root === "" && current_page.endsWith("/index.html"))) {
|
||||||
|
link.classList.add("active");
|
||||||
|
var parent = link.parentElement;
|
||||||
|
while (parent) {
|
||||||
|
if (parent.tagName === "LI" && parent.previousElementSibling) {
|
||||||
|
if (parent.previousElementSibling.classList.contains("chapter-item")) {
|
||||||
|
parent.previousElementSibling.classList.add("expanded");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
parent = parent.parentElement;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|
||||||
|
// Track and set sidebar scroll position
|
||||||
|
sidebarScrollbox.addEventListener('click', function(e) {
|
||||||
|
if (e.target.tagName === 'A') {
|
||||||
|
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
||||||
|
}
|
||||||
|
}, { passive: true });
|
||||||
|
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
||||||
|
sessionStorage.removeItem('sidebar-scroll');
|
||||||
|
if (sidebarScrollTop) {
|
||||||
|
// preserve sidebar scroll position when navigating via links within sidebar
|
||||||
|
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
||||||
|
} else {
|
||||||
|
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
||||||
|
var activeSection = document.querySelector('#sidebar .active');
|
||||||
|
if (activeSection) {
|
||||||
|
activeSection.scrollIntoView({ block: 'center' });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -265,6 +265,25 @@ pub fn log_backtrace(e: &Error) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub(crate) fn special_escape(mut s: &str) -> String {
|
||||||
|
let mut escaped = String::with_capacity(s.len());
|
||||||
|
let needs_escape: &[char] = &['<', '>', '\'', '\\', '&'];
|
||||||
|
while let Some(next) = s.find(needs_escape) {
|
||||||
|
escaped.push_str(&s[..next]);
|
||||||
|
match s.as_bytes()[next] {
|
||||||
|
b'<' => escaped.push_str("<"),
|
||||||
|
b'>' => escaped.push_str(">"),
|
||||||
|
b'\'' => escaped.push_str("'"),
|
||||||
|
b'\\' => escaped.push_str("\"),
|
||||||
|
b'&' => escaped.push_str("&"),
|
||||||
|
_ => unreachable!(),
|
||||||
|
}
|
||||||
|
s = &s[next + 1..];
|
||||||
|
}
|
||||||
|
escaped.push_str(s);
|
||||||
|
escaped
|
||||||
|
}
|
||||||
|
|
||||||
pub(crate) fn bracket_escape(mut s: &str) -> String {
|
pub(crate) fn bracket_escape(mut s: &str) -> String {
|
||||||
let mut escaped = String::with_capacity(s.len());
|
let mut escaped = String::with_capacity(s.len());
|
||||||
let needs_escape: &[char] = &['<', '>'];
|
let needs_escape: &[char] = &['<', '>'];
|
||||||
|
|
@ -283,7 +302,7 @@ pub(crate) fn bracket_escape(mut s: &str) -> String {
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::bracket_escape;
|
use super::{bracket_escape, special_escape};
|
||||||
|
|
||||||
mod render_markdown {
|
mod render_markdown {
|
||||||
use super::super::render_markdown;
|
use super::super::render_markdown;
|
||||||
|
|
@ -506,5 +525,20 @@ more text with spaces
|
||||||
assert_eq!(bracket_escape("<>"), "<>");
|
assert_eq!(bracket_escape("<>"), "<>");
|
||||||
assert_eq!(bracket_escape("<test>"), "<test>");
|
assert_eq!(bracket_escape("<test>"), "<test>");
|
||||||
assert_eq!(bracket_escape("a<test>b"), "a<test>b");
|
assert_eq!(bracket_escape("a<test>b"), "a<test>b");
|
||||||
|
assert_eq!(bracket_escape("'"), "'");
|
||||||
|
assert_eq!(bracket_escape("\\"), "\\");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn escaped_special() {
|
||||||
|
assert_eq!(special_escape(""), "");
|
||||||
|
assert_eq!(special_escape("<"), "<");
|
||||||
|
assert_eq!(special_escape(">"), ">");
|
||||||
|
assert_eq!(special_escape("<>"), "<>");
|
||||||
|
assert_eq!(special_escape("<test>"), "<test>");
|
||||||
|
assert_eq!(special_escape("a<test>b"), "a<test>b");
|
||||||
|
assert_eq!(special_escape("'"), "'");
|
||||||
|
assert_eq!(special_escape("\\"), "\");
|
||||||
|
assert_eq!(special_escape("&"), "&");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ use mdbook::utils::fs::write_file;
|
||||||
use mdbook::MDBook;
|
use mdbook::MDBook;
|
||||||
use pretty_assertions::assert_eq;
|
use pretty_assertions::assert_eq;
|
||||||
use select::document::Document;
|
use select::document::Document;
|
||||||
use select::predicate::{Class, Name, Predicate};
|
use select::predicate::{Attr, Class, Name, Predicate};
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
use std::ffi::OsStr;
|
use std::ffi::OsStr;
|
||||||
use std::fs;
|
use std::fs;
|
||||||
|
|
@ -61,28 +61,6 @@ fn by_default_mdbook_generates_rendered_content_in_the_book_directory() {
|
||||||
assert!(index_file.exists());
|
assert!(index_file.exists());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn make_sure_bottom_level_files_contain_links_to_chapters() {
|
|
||||||
let temp = DummyBook::new().build().unwrap();
|
|
||||||
let md = MDBook::load(temp.path()).unwrap();
|
|
||||||
md.build().unwrap();
|
|
||||||
|
|
||||||
let dest = temp.path().join("book");
|
|
||||||
let links = vec![
|
|
||||||
r#"href="intro.html""#,
|
|
||||||
r#"href="first/index.html""#,
|
|
||||||
r#"href="first/nested.html""#,
|
|
||||||
r#"href="second.html""#,
|
|
||||||
r#"href="conclusion.html""#,
|
|
||||||
];
|
|
||||||
|
|
||||||
let files_in_bottom_dir = vec!["index.html", "intro.html", "second.html", "conclusion.html"];
|
|
||||||
|
|
||||||
for filename in files_in_bottom_dir {
|
|
||||||
assert_contains_strings(dest.join(filename), &links);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn check_correct_cross_links_in_nested_dir() {
|
fn check_correct_cross_links_in_nested_dir() {
|
||||||
let temp = DummyBook::new().build().unwrap();
|
let temp = DummyBook::new().build().unwrap();
|
||||||
|
|
@ -90,19 +68,6 @@ fn check_correct_cross_links_in_nested_dir() {
|
||||||
md.build().unwrap();
|
md.build().unwrap();
|
||||||
|
|
||||||
let first = temp.path().join("book").join("first");
|
let first = temp.path().join("book").join("first");
|
||||||
let links = vec![
|
|
||||||
r#"href="../intro.html""#,
|
|
||||||
r#"href="../first/index.html""#,
|
|
||||||
r#"href="../first/nested.html""#,
|
|
||||||
r#"href="../second.html""#,
|
|
||||||
r#"href="../conclusion.html""#,
|
|
||||||
];
|
|
||||||
|
|
||||||
let files_in_nested_dir = vec!["index.html", "nested.html"];
|
|
||||||
|
|
||||||
for filename in files_in_nested_dir {
|
|
||||||
assert_contains_strings(first.join(filename), &links);
|
|
||||||
}
|
|
||||||
|
|
||||||
assert_contains_strings(
|
assert_contains_strings(
|
||||||
first.join("index.html"),
|
first.join("index.html"),
|
||||||
|
|
@ -265,9 +230,9 @@ fn entry_ends_with(entry: &DirEntry, ending: &str) -> bool {
|
||||||
entry.file_name().to_string_lossy().ends_with(ending)
|
entry.file_name().to_string_lossy().ends_with(ending)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Read the main page (`book/index.html`) and expose it as a DOM which we
|
/// Read the TOC (`book/toc.js`) nested HTML and expose it as a DOM which we
|
||||||
/// can search with the `select` crate
|
/// can search with the `select` crate
|
||||||
fn root_index_html() -> Result<Document> {
|
fn toc_js_html() -> Result<Document> {
|
||||||
let temp = DummyBook::new()
|
let temp = DummyBook::new()
|
||||||
.build()
|
.build()
|
||||||
.with_context(|| "Couldn't create the dummy book")?;
|
.with_context(|| "Couldn't create the dummy book")?;
|
||||||
|
|
@ -275,15 +240,36 @@ fn root_index_html() -> Result<Document> {
|
||||||
.build()
|
.build()
|
||||||
.with_context(|| "Book building failed")?;
|
.with_context(|| "Book building failed")?;
|
||||||
|
|
||||||
let index_page = temp.path().join("book").join("index.html");
|
let toc_path = temp.path().join("book").join("toc.js");
|
||||||
let html = fs::read_to_string(index_page).with_context(|| "Unable to read index.html")?;
|
let html = fs::read_to_string(toc_path).with_context(|| "Unable to read index.html")?;
|
||||||
|
for line in html.lines() {
|
||||||
|
if let Some(left) = line.strip_prefix("sidebarScrollbox.innerHTML = '") {
|
||||||
|
if let Some(html) = left.strip_suffix("';") {
|
||||||
|
return Ok(Document::from(html));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
panic!("cannot find toc in file")
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read the TOC fallback (`book/toc.html`) HTML and expose it as a DOM which we
|
||||||
|
/// can search with the `select` crate
|
||||||
|
fn toc_fallback_html() -> Result<Document> {
|
||||||
|
let temp = DummyBook::new()
|
||||||
|
.build()
|
||||||
|
.with_context(|| "Couldn't create the dummy book")?;
|
||||||
|
MDBook::load(temp.path())?
|
||||||
|
.build()
|
||||||
|
.with_context(|| "Book building failed")?;
|
||||||
|
|
||||||
|
let toc_path = temp.path().join("book").join("toc.html");
|
||||||
|
let html = fs::read_to_string(toc_path).with_context(|| "Unable to read index.html")?;
|
||||||
Ok(Document::from(html.as_str()))
|
Ok(Document::from(html.as_str()))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn check_second_toc_level() {
|
fn check_second_toc_level() {
|
||||||
let doc = root_index_html().unwrap();
|
let doc = toc_js_html().unwrap();
|
||||||
let mut should_be = Vec::from(TOC_SECOND_LEVEL);
|
let mut should_be = Vec::from(TOC_SECOND_LEVEL);
|
||||||
should_be.sort_unstable();
|
should_be.sort_unstable();
|
||||||
|
|
||||||
|
|
@ -305,7 +291,7 @@ fn check_second_toc_level() {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn check_first_toc_level() {
|
fn check_first_toc_level() {
|
||||||
let doc = root_index_html().unwrap();
|
let doc = toc_js_html().unwrap();
|
||||||
let mut should_be = Vec::from(TOC_TOP_LEVEL);
|
let mut should_be = Vec::from(TOC_TOP_LEVEL);
|
||||||
|
|
||||||
should_be.extend(TOC_SECOND_LEVEL);
|
should_be.extend(TOC_SECOND_LEVEL);
|
||||||
|
|
@ -328,7 +314,7 @@ fn check_first_toc_level() {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn check_spacers() {
|
fn check_spacers() {
|
||||||
let doc = root_index_html().unwrap();
|
let doc = toc_js_html().unwrap();
|
||||||
let should_be = 2;
|
let should_be = 2;
|
||||||
|
|
||||||
let num_spacers = doc
|
let num_spacers = doc
|
||||||
|
|
@ -337,6 +323,39 @@ fn check_spacers() {
|
||||||
assert_eq!(num_spacers, should_be);
|
assert_eq!(num_spacers, should_be);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// don't use target="_parent" in JS
|
||||||
|
#[test]
|
||||||
|
fn check_link_target_js() {
|
||||||
|
let doc = toc_js_html().unwrap();
|
||||||
|
|
||||||
|
let num_parent_links = doc
|
||||||
|
.find(
|
||||||
|
Class("chapter")
|
||||||
|
.descendant(Name("li"))
|
||||||
|
.descendant(Name("a").and(Attr("target", "_parent"))),
|
||||||
|
)
|
||||||
|
.count();
|
||||||
|
assert_eq!(num_parent_links, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
// don't use target="_parent" in IFRAME
|
||||||
|
#[test]
|
||||||
|
fn check_link_target_fallback() {
|
||||||
|
let doc = toc_fallback_html().unwrap();
|
||||||
|
|
||||||
|
let num_parent_links = doc
|
||||||
|
.find(
|
||||||
|
Class("chapter")
|
||||||
|
.descendant(Name("li"))
|
||||||
|
.descendant(Name("a").and(Attr("target", "_parent"))),
|
||||||
|
)
|
||||||
|
.count();
|
||||||
|
assert_eq!(
|
||||||
|
num_parent_links,
|
||||||
|
TOC_TOP_LEVEL.len() + TOC_SECOND_LEVEL.len()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/// Ensure building fails if `create-missing` is false and one of the files does
|
/// Ensure building fails if `create-missing` is false and one of the files does
|
||||||
/// not exist.
|
/// not exist.
|
||||||
#[test]
|
#[test]
|
||||||
|
|
@ -449,18 +468,15 @@ fn by_default_mdbook_use_index_preprocessor_to_convert_readme_to_index() {
|
||||||
let md = MDBook::load_with_config(temp.path(), cfg).unwrap();
|
let md = MDBook::load_with_config(temp.path(), cfg).unwrap();
|
||||||
md.build().unwrap();
|
md.build().unwrap();
|
||||||
|
|
||||||
let first_index = temp.path().join("book").join("first").join("index.html");
|
let first_index = temp.path().join("book").join("toc.js");
|
||||||
let expected_strings = vec![
|
let expected_strings = vec![
|
||||||
r#"href="../first/index.html""#,
|
r#"href="first/index.html""#,
|
||||||
r#"href="../second/index.html""#,
|
r#"href="second/index.html""#,
|
||||||
"First README",
|
"1st README",
|
||||||
|
"2nd README",
|
||||||
];
|
];
|
||||||
assert_contains_strings(&first_index, &expected_strings);
|
assert_contains_strings(&first_index, &expected_strings);
|
||||||
assert_doesnt_contain_strings(&first_index, &["README.html"]);
|
assert_doesnt_contain_strings(&first_index, &["README.html", "Second README"]);
|
||||||
|
|
||||||
let second_index = temp.path().join("book").join("second").join("index.html");
|
|
||||||
let unexpected_strings = vec!["Second README"];
|
|
||||||
assert_doesnt_contain_strings(second_index, &unexpected_strings);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
|
@ -639,11 +655,11 @@ fn summary_with_markdown_formatting() {
|
||||||
let md = MDBook::load_with_config(temp.path(), cfg).unwrap();
|
let md = MDBook::load_with_config(temp.path(), cfg).unwrap();
|
||||||
md.build().unwrap();
|
md.build().unwrap();
|
||||||
|
|
||||||
let rendered_path = temp.path().join("book/formatted-summary.html");
|
let rendered_path = temp.path().join("book/toc.js");
|
||||||
assert_contains_strings(
|
assert_contains_strings(
|
||||||
rendered_path,
|
rendered_path,
|
||||||
&[
|
&[
|
||||||
r#"<a href="formatted-summary.html" class="active"><strong aria-hidden="true">1.</strong> Italic code *escape* `escape2`</a>"#,
|
r#"<a href="formatted-summary.html"><strong aria-hidden="true">1.</strong> Italic code *escape* `escape2`</a>"#,
|
||||||
r#"<a href="soft.html"><strong aria-hidden="true">2.</strong> Soft line break</a>"#,
|
r#"<a href="soft.html"><strong aria-hidden="true">2.</strong> Soft line break</a>"#,
|
||||||
r#"<a href="escaped-tag.html"><strong aria-hidden="true">3.</strong> <escaped tag></a>"#,
|
r#"<a href="escaped-tag.html"><strong aria-hidden="true">3.</strong> <escaped tag></a>"#,
|
||||||
],
|
],
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue