How to disable default behavior of callouts for unsupported formats?

[florian-wagner]

Description

Dear quarto community,

I would like to make code solutions available to students as a collapsible callout. This works great in HTML, but students should also be able to download the solutions as Jupyter notebooks to run the code (without callouts). Please find a minimal working example below. Unfortunately, the default behavior of replacing callouts with blockquotes in unsupported formats, breaks the Jupyter code cell. I have played with conditional content based on the output format, but I cannot put the opening and closing fences as conditional content.

Any idea how to solve this?

Thanks a lot!

---
title: Callouts for HTML, but not for notebooks
format:
  html: default
  ipynb: default
engine: jupyter
---

## First try (looks good in html, but breaks code cell in notebook)

Q: What is 1 + 1?

::: {.callout-tip collapse="true"}
# Solution

```{python}
print(1 + 1)
```
:::

## Second try (does not work)


Q: What is 1 + 1?

:::: {.content-visible unless-format="ipynb"}
::: {.callout-tip collapse="true"}
# Solution
::::

```{python}
print(1 + 1)
```
:::: {.content-visible unless-format="ipynb"}
:::
::::

[mcanouil]

Did you look at what others did?

• Creating Jupyter notebooks for exercises & solutions #2422
• Compile exercises with and without answers on a website #7830
• Adding QED symbol at the end of an exercise's solution? #7314
• How to leave blank space for homework solutions? #5823
• https://github.com/r-wasm/quarto-live

(Not exhaustive list)

How to disable default behavior of callouts for unsupported formats?

Not directly, but you could make a Lua filter.

[cderv]

This works great in HTML, but students should also be able to download the solutions as Jupyter notebooks to run the code (without callouts). Please find a minimal working example below. Unfortunately, the default behavior of replacing callouts with blockquotes in unsupported formats, breaks the Jupyter code cell.

Thanks for the reproducible example. This looks like something we would need to handle better indeed for --to ipynb

Currently the same default for BlockQuote is used for all outputs formats. We could maybe make an exception for ipynb.

What would you expect to be kept exactly? Only the content and use the callout inside title as a regular title ?
Or would you expect the content of the callout (except the code cell) to be blockquote ?

Jupyter notebook cells does not have nested structure - so that is what makes it hards

I am interested in your thoughts about the output to think about an alternative for --to ipynb

you could make a Lua filter.

For example to completely ignore the callout in Ipynb output you could do a lua filter as suggestion

filters: ['ignore-callout.lua']

Callout = function(callout) 
    if quarto.doc.is_format("ipynb") then
        return callout.content
    end
    return callout
end

or if you want at least to keep the title

Callout = function(callout) 
    if quarto.doc.is_format("ipynb") then
        content = callout.content
        title = pandoc.Strong(pandoc.utils.blocks_to_inlines({callout.title}))
        return pandoc.Blocks({title, content})
    end
    return callout
end

Hope it helps

[florian-wagner]

Thanks @mcanouil for the list. I saw some of these, but did not find anything on the callout behavior in ipynb format.
Thanks @cderv for the lua filter. Works like a charm and already helps me a lot. To answer your question: I would think that a callout/blockquote for the heading only + warning that callouts are currently unsupported for the ipynb format would be a sensible default. Callout/blockquote formatting of the heading + warning are "nice to have" but from a notebook user perspective, I find it most important that unsupported formatting does not break the interactive code cells.

Thanks to the whole team for the amazing work on Quarto!

[cderv]

Thanks. I created FR

• Code cell inside Callout should still be runnable code cell when output if format: ipynb #13510