Here's a reference on Quarto callouts. How should we use them for consistency? Some lessons use callout-caution for tips (e.g., r_programming_introduction, with icon suppressed), while others use callout-tip or callout-note, which makes more sense for less urgent tips or notes.
Exercises are generally callout-note but some are formatted without icons, which makes sense.
Idea:
- Important (red, with circled exclamation): do not skip this or things will break (analogous to an error)
- Caution (orange, with triangle exclamation): do not skip this or things will be problematic (analogous to a warning)
- Note (blue, with circled "i"): good to know, but no one will die if you skip this (like a message)
- Tip (green, with light bulb): a best practice, or a nod to a bigger idea
- For these use cases, don't suppress the icons (they make sense in these contexts), and don't collapse the tip
Examples, exercises, actions
- Exercises are generally called out as
callout-note, but perhaps the icon should be suppressed (i.e., {.callout-note icon=false}) since the circle-i doesn't make much sense.
- maybe solutions or hints could be as collapsed tips (green, icon suppressed)
- note that if the solution is a code chunk you can put
#| code-fold: true and #| code-summary: "Answer" (or "Hint") in the quarto options
- In clean/wrangling lesson, some examples are called out as
{.callout-note icon=false appearance="minimal"} which differentiates from the exercise formatting (note, minimal appearance already suppresses the icon). But maybe a different color would be better?
- In some scripts, actions for the user are as tips (e.g., "Setup" notes in the literate analysis lesson) - perhaps these should also have the icon suppressed since the light bulb doesn't really make sense?
- WAY COOLER let's do custom callouts, a la this example (noted from this Github issue)
Syntax notes
This seems to work in the scripts currently:
::: callout-tip
### This will appear as the tip title
tip text: could also do callout-important etc.
:::
but looks like this is the more powerful syntax:
::: {.callout-caution icon=false collapse=true}
### Quick Tip
You can also include title="callout title" in the curly brackets!
:::
Here's a reference on Quarto callouts. How should we use them for consistency? Some lessons use
callout-cautionfor tips (e.g.,r_programming_introduction, with icon suppressed), while others usecallout-tiporcallout-note, which makes more sense for less urgent tips or notes.Exercises are generally
callout-notebut some are formatted without icons, which makes sense.Idea:
Examples, exercises, actions
callout-note, but perhaps the icon should be suppressed (i.e.,{.callout-note icon=false}) since the circle-i doesn't make much sense.#| code-fold: trueand#| code-summary: "Answer"(or"Hint") in the quarto options{.callout-note icon=false appearance="minimal"}which differentiates from the exercise formatting (note, minimal appearance already suppresses the icon). But maybe a different color would be better?Syntax notes
This seems to work in the scripts currently:
but looks like this is the more powerful syntax: