improve tooltip readability and add opt-in tooltip for footnotes

R/mini-document.R

@@ -25,6 +25,7 @@
 #' @param results_folding Setup results folding by a string, `"none"`, `"show"`,
 #'  or `"hide"`. This feature will fold entire results, including side effects
 #'  such as figures and tables.
+#' @param footenote_tooltip `TRUE` let footnotes to be also shown as tooltips.
 #' @param tabset `TRUE` converts sections to tabs if they belong to the
 #'  `tabset`-class section. The tabs inherit names from the corresponding
 #'  sections. Unlike `rmarkdown::html_document`, the tabs can be navigated by
@@ -59,6 +60,7 @@ mini_document <- function(framework = "sakura",
                           section_divs = TRUE,
                           code_folding = c("none", "show", "hide"),
                           results_folding = c("none", "show", "hide"),
+                          footnote_tooltip = FALSE,
                           tabset = FALSE,
                           code_download = FALSE,
                           self_contained = TRUE,
@@ -81,7 +83,9 @@ mini_document <- function(framework = "sakura",
 
   fmt <- rmarkdown::html_document(
     theme = if (html5) NULL else theme,
-    pandoc_args = spec_pandoc_args(pandoc_args, html5, katex),
+    pandoc_args = spec_pandoc_args(
+        pandoc_args, html5, katex, footnote_tooltip
+    ),
     extra_dependencies = spec_dependencies(
         extra_dependencies,
         html5 = html5,

R/spec-dependencies.R

@@ -25,7 +25,6 @@ spec_dependencies <- function(extra_dependencies = NULL,
           paste0(`if`(all_frameworks, default_framework, framework), ".css")
         },
         "common.css",
-        if (with_framework && framework != "mini") "feat-tooltip.css",
         if (toc_float) "feat-toc-float.css"
       ),
       meta = if (all_frameworks) {

R/spec-pandoc-args.R

@@ -2,16 +2,17 @@
 #' @noRd
 spec_pandoc_args <- function(pandoc_args = NULL,
                              html5 = TRUE,
-                             katex = TRUE) {
-
+                             katex = TRUE,
+                             footnote_tooltip = FALSE) {
   lua <- if (check_pandoc_version(minimum = "2.0.0", recommend = "2.7.2")) {
-    if (html5) {
-      dir(path_mini_resources("lua"), pattern = "\\.lua$", full.names = TRUE)
-    } else {
-      path_mini_resources("lua", "code-folding.lua")
-    }
-  } else {
-    character(0L)
+    path_mini_resources(
+      "lua",
+      c(
+        if (html5) "tooltip.lua",
+        if (footnote_tooltip) "footnote-tooltip.lua",
+        "code-folding.lua"
+      )
+    )
   }
 
   c(
@@ -20,3 +21,4 @@ spec_pandoc_args <- function(pandoc_args = NULL,
     if (katex) "--mathjax"
   )
 }
+

docs/index.Rmd

@@ -15,6 +15,7 @@ output:
     toc: true
     toc_float: true
     toc_highlight: true
+    footnote_tooltip: true
     tabset: true
     number_sections: true
     anchor_sections: false

inst/rmarkdown/lua/footnote-tooltip.lua

@@ -0,0 +1,4 @@
+function Note(note)
+  return pandoc.Span(note, {title = pandoc.utils.stringify(note.content)})
+end
+

inst/rmarkdown/lua/tooltip.lua

@@ -1,14 +1,17 @@
---wip: remove elem.attr.attributes.tooltip
-
 function Span(elem)
   local tooltip = elem.attributes and elem.attributes.tooltip
   if tooltip then
-    return {
-      pandoc.RawInline(
-        "html", '<span class=tooltip aria-label="' .. tooltip .. '">'
-      ),
-      elem,
-      pandoc.RawInline("html", "</span>")
-    }
+    local tooltip_str = pandoc.utils.stringify(tooltip)
+    local attributes = {}
+    attributes["aria-label"] = tooltip_str
+    attributes["title"] = tooltip_str
+    for k,v in pairs(elem.attributes) do
+      if k ~= "tooltip" then
+        attributes[k] = v
+      end
+    end
+    elem.attributes = attributes
+    return elem
   end
 end
+