renderings as document option

fixes #12381

Author: gordonwoodhull

src/resources/filters/normalize/flags.lua

@@ -195,6 +195,9 @@ function compute_flags()
       elseif lightbox_auto == false then
         flags.has_lightbox = false
       end
+      if el.renderings then
+        flags.has_renderings = true
+      end
     end,
   }}
 end

src/resources/filters/quarto-post/cell-renderings.lua

@@ -8,15 +8,31 @@ function choose_cell_renderings()
       return {json}
     end
   end
+
+  local documentRenderings
 
   return {
+    traverse = "topdown",
+    Meta = function(meta)
+      if meta.renderings then
+        documentRenderings = {}
+        for _, inlines in ipairs(meta.renderings) do
+          table.insert(documentRenderings, inlines[1].text)
+        end
+      end
+    end,
     Div = function(div)
       -- Only process cell div with renderings attr
-      if not div.classes:includes("cell") or not div.attributes["renderings"] then
+      if not div.classes:includes("cell") or (not documentRenderings and not div.attributes["renderings"]) then
         return nil
       end
-      local renderingsJson = div.attributes['renderings']
-      local renderings = jsonDecodeArray(renderingsJson)
+      local renderings
+      if div.attributes['renderings'] then
+        local renderingsJson = div.attributes['renderings']
+        renderings = jsonDecodeArray(renderingsJson)
+      else
+        renderings = documentRenderings
+      end
       if not type(renderings) == "table" or #renderings == 0 then
         quarto.log.warning("renderings expected array of rendering names, got", renderings)
         return nil

src/resources/schema/document-options.yml

@@ -34,6 +34,11 @@
                   description: The dark theme name, theme scss file, or a mix of both.
   description: Theme name, theme scss file, or a mix of both.
 
+- name: renderings
+  schema:
+    arrayOf: string
+  description: "Array of rendering names, e.g. `[light, dark]`"
+
 - name: body-classes
   tags:
     formats: [$html-doc]

tests/docs/smoke-all/dark-mode/ggplot-duobrand-doc-renderings.qmd

@@ -0,0 +1,130 @@
+---
+title: "knitr dark mode - ggplot"
+brand:
+  light: united-brand.yml
+  dark: slate-brand.yml
+execute:
+  echo: false
+  warning: false
+renderings: [light, dark]
+_quarto:
+  tests:
+    html:
+      ensureHtmlElements:
+        -
+          - 'body.quarto-light'
+          - 'div.cell div.light-content'
+          - 'div.cell div.dark-content'
+          - 'div.cell div.cell-code pre.code-with-copy'
+        - []
+---
+
+```{r}
+#| echo: false
+#| warning: false
+library(ggplot2)
+
+ggplot_theme <- function(bgcolor, fgcolor) {
+  theme_minimal(base_size = 11) %+%
+    theme(
+      panel.border = element_blank(),
+      panel.grid.major.y = element_blank(),
+      panel.grid.minor.y = element_blank(),
+      panel.grid.major.x = element_blank(),
+      panel.grid.minor.x = element_blank(),
+      text = element_text(colour = fgcolor),
+      axis.text = element_text(colour = fgcolor),
+      rect = element_rect(colour = bgcolor, fill = bgcolor),
+      plot.background = element_rect(fill = bgcolor, colour = NA),
+      axis.line = element_line(colour = fgcolor),
+      axis.ticks = element_line(colour = fgcolor)
+    )
+}
+
+brand_ggplot <- function(brand_yml) {
+  brand <- yaml::yaml.load_file(brand_yml)
+  ggplot_theme(brand$color$background, brand$color$foreground)
+}
+
+united_theme <- brand_ggplot("united-brand.yml")
+slate_theme <- brand_ggplot("slate-brand.yml")
+
+colour_scale <- scale_colour_manual(values = c("darkorange", "purple", "cyan4"))
+```
+
+### no crossref, no caption
+
+```{r}
+ggplot(mtcars, aes(mpg, wt)) +
+  geom_point(aes(colour = factor(cyl))) +
+  united_theme +
+  colour_scale
+ggplot(mtcars, aes(mpg, wt)) +
+  geom_point(aes(colour = factor(cyl))) +
+  slate_theme +
+  colour_scale
+```
+
+### with crossref but no caption
+
+and `echo: true`
+
+::: {#fig-ggplot}
+
+```{r}
+#| echo: true
+#| renderings: [dark, light]
+
+# override renderings order
+ggplot(mtcars, aes(mpg, disp)) +
+  geom_point(aes(colour = factor(cyl))) +
+  slate_theme +
+  colour_scale
+ggplot(mtcars, aes(mpg, disp)) +
+  geom_point(aes(colour = factor(cyl))) +
+  united_theme +
+  colour_scale
+```
+
+:::
+
+
+### with caption but no crossref
+
+<div>
+
+```{r}
+#| renderings: [dark]
+
+# override number of renderings
+ggplot(mtcars, aes(mpg, disp)) +
+  geom_point(aes(colour = factor(cyl))) +
+  slate_theme +
+  colour_scale
+```
+
+ggplot - dark only
+
+</div>
+
+
+### with crossref and caption
+
+::: {#fig-ggplot-mpg-hp}
+```{r}
+ggplot(mtcars, aes(mpg, hp)) +
+  geom_point(aes(colour = factor(cyl))) +
+  united_theme +
+  colour_scale
+ggplot(mtcars, aes(mpg, hp)) +
+  geom_point(aes(colour = factor(cyl))) +
+  slate_theme +
+  colour_scale
+```
+
+mtcars - mpg vs hp
+:::
+
+Here's a [link](https://example.com).
+
+{{< lipsum 3 >}}