do not escape alt text by default; escaping is only necessary for HTM…

…L output
yihui · Aug 17, 2023 · 4a7512b · 4a7512b
1 parent d56d3ba
commit 4a7512b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/R/hooks-html.R b/R/hooks-html.R
@@ -55,12 +55,15 @@ hook_animation = function(options) {
   paste0(res, if (tag == 'object') '></object>' else ' />')
 }
 
-.img.cap = function(options, alt = FALSE) {
+.img.cap = function(options, alt = FALSE, escape = FALSE) {
   cap = options$fig.cap %n% {
     if (is.null(pandoc_to())) sprintf('plot of chunk %s', options$label) else ''
   }
   if (length(cap) == 0) cap = ''
-  if (alt) return(escape_html(options$fig.alt %n% cap))
+  if (alt) {
+    alt = options$fig.alt %n% cap
+    return(if (escape) escape_html(alt) else alt)
+  }
   if (is_blank(cap)) return(cap)
   paste0(create_label(
     options$fig.lp, options$label,
@@ -140,7 +143,7 @@ hook_ffmpeg = function(x, options, format = 'webm') {
     sprintf('width="%s"', options$out.width),
     sprintf('height="%s"', options$out.height), opts
   )
-  cap = .img.cap(options, alt = TRUE)
+  cap = .img.cap(options, alt = TRUE, escape = TRUE)
   if (cap != '') cap = sprintf('<p>%s</p>', cap)
   sprintf(
     '<video %s><source src="%s" />%s</video>', trimws(opts),

diff --git a/R/output.R b/R/output.R
@@ -653,7 +653,7 @@ add_html_caption = function(options, code, id = NULL) {
   if (cap == '' && !length(id)) return(code)
 
   if (length(id)) {
-    alt = .img.cap(options, alt = TRUE)
+    alt = .img.cap(options, alt = TRUE, escape = TRUE)
     if (cap == alt && cap != '') {
       # both are the same, so insert cap with id
       alttext = sprintf('<p class="caption" id="%s">%s</p>\n', id, cap)

diff --git a/tests/testit/test-utils.R b/tests/testit/test-utils.R
@@ -137,11 +137,11 @@ opts = list(
 assert('.img.cap() generates the figure caption and alt attribute', {
   (.img.cap(list(fig.cap = NULL), FALSE) %==% "")
   (.img.cap(opts, FALSE) %==% opts$fig.cap)
-  (.img.cap(opts, TRUE)  %==% 'Figure &quot;caption&quot; &lt;&gt;.')
+  (.img.cap(opts, TRUE, TRUE)  %==% 'Figure &quot;caption&quot; &lt;&gt;.')
 
   opts$fig.alt = 'Figure "alternative text" <>.'
 
-  (.img.cap(opts, TRUE)  %==% 'Figure &quot;alternative text&quot; &lt;&gt;.')
+  (.img.cap(opts, TRUE, TRUE)  %==% 'Figure &quot;alternative text&quot; &lt;&gt;.')
   (.img.cap(opts, FALSE)  %==% opts$fig.cap)
 
   (.img.cap(list(fig.cap = '', fig.alt = "alt"), FALSE) %==% "")