Pandoc 3.2.1 will now URL encode the link id for HTML 4 (#1505)

cderv · web-flow · commit a9400dee1760 · 2025-09-22T22:07:41.000-05:00
* Pandoc 3.2.1 will now URL encode the link id for HTML 4

gitbook TOC processing needs to account  for that.

* Adding test to check the TOC does get processed correctly by gitbook() logic
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
 # CHANGES IN bookdown VERSION 0.45
 
+- `gitbook()` TOC now works again with Pandoc 3.2.1 and above (thanks, @privefl, #1503).
+
 
 # CHANGES IN bookdown VERSION 0.44
 
diff --git a/R/html.R b/R/html.R
@@ -965,7 +965,7 @@ restore_links = function(segment, full, lines, filenames) {
     if (length(x) == 0) return(x)
     links = gsub(r, '\\1', x)
     for (i in seq_along(links)) {
-      a = grep(sprintf(' id="%s"', links[i]), full, fixed = TRUE)
+      a = grep(sprintf(' id="%s"', URLdecode(links[i])), full, fixed = TRUE)
       if (length(a) == 0) next
       a = a[1]
       x[i] = sprintf(
diff --git a/tests/testthat/test-gitbook.R b/tests/testthat/test-gitbook.R
@@ -38,6 +38,30 @@ test_that("gitbook_toc correctly process pandoc html with anchor section", {
   expect_true(all(xml2::xml_find_lgl(TOC, "not(boolean(./a/span[count(node()) = 0]))")))
 })
 
+test_that("gitbook_toc correctly process pandoc html with non-ascii character", {
+  skip_on_cran()
+  skip_if_not_pandoc()
+  skip_if_not_installed("xml2")
+  book <- local_book()
+  # add a file with non-ascii
+  xfun::in_dir(book, xfun::write_utf8(c("# Entraîneur", "", "some content", "", "## été", "", "Content"), "03-entraineur.Rmd"))
+  res <- .render_book_quiet(book, output_format = gitbook())
+  content <- xml2::read_html(res)
+  TOC <- xml2::xml_find_all(content, "//div[@class='book-summary']/nav/ul/li")
+  expect_equal(xml2::xml_attr(TOC, "class"), rep("chapter", 4))
+  expect_equal(xml2::xml_attr(TOC, "data-path"), c("index.html", "introduction.html", "references.html", "entraîneur.html"))
+  H1 <- xml2::xml_find_all(TOC, "a")
+  expect_equal(xml2::xml_text(H1), c("Preface", "1 Introduction", "# References", "2 Entraîneur"))
+  expect_equal(xml2::xml_attr(H1, "href"), c("index.html", "introduction.html", "references.html", "entraîneur.html"))
+  H2 <- xml2::xml_find_all(TOC, ".//li/a")
+  if (rmarkdown::pandoc_available("3.2.1")) {
+    expect_equal(xml2::xml_attr(H2, "href"), "entraîneur.html#%C3%A9t%C3%A9")
+  } else {
+    expect_equal(xml2::xml_attr(H2, "href"), "entraîneur.html#été")
+  }
+  expect_equal(xml2::xml_text(H2), "2.1 été")
+})
+
 # https://github.com/rstudio/bookdown/pull/1408
 # https://github.com/rstudio/bookdown/issues/1101
 test_that("gitbook() correctly handles extra_dependency after its own", {
