| Title: | RStudio Addin to Insert Quarto Helpers |
|---|---|
| Description: | An RStudio Addin to insert ('stamp') pre-written classes and divs into your Quarto documents. |
| Authors: | Matt Dray [aut, cre],
Zoë Turner [ctb] |
| Maintainer: | Matt Dray <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.1 |
| Built: | 2024-10-27 03:48:30 UTC |
| Source: | https://github.com/matt-dray/quartostamp |
Insert a div that creates an 'aside' in a Revealjs presentation slide. Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_aside()stamp_aside()
The output looks like this if the user hadn't selected any text:
::: aside Additional commentary. :::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a callout-block div of type 'caution', which has an orange accent and a traffic-cone icon. Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_callout_caution()stamp_callout_caution()
The output looks like this if the user hadn't selected any text:
:::{.callout-caution collapse=false appearance='default' icon=true}
## Optional caption (caution)
- Hide callout body with 'collapse=true'
- Remove 'collapse' to prevent expandability
- Set appearance to 'default', 'simple' or 'minimal'
- Remove icon with 'icon=false'
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a callout-block div of type 'important', which has a red accent and an exclamation-point icon. Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_callout_important()stamp_callout_important()
The output looks like this if the user hadn't selected any text:
:::{.callout-important collapse=false appearance='default' icon=true}
## Optional caption (important)
- Hide callout body with 'collapse=true'
- Remove 'collapse' to prevent expandability
- Set appearance to 'default', 'simple' or 'minimal'
- Remove icon with 'icon=false'
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a callout-block div of type 'note', which has a blue accent and a letter 'i' icon. Will embed text selected bythe user, otherwise skeleton help text will be inserted.
stamp_callout_note()stamp_callout_note()
The output looks like this if the user hadn't selected any text:
:::{.callout-note collapse=false appearance='default' icon=true}
## Optional caption (note)
- Hide callout body with 'collapse=true'
- Remove 'collapse' to prevent expandability
- Set appearance to 'default', 'simple' or 'minimal'
- Remove icon with 'icon=false'
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a callout-block div of type 'tip', which has an green accent and a lightbulb icon. Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_callout_tip()stamp_callout_tip()
The output looks like this if the user hadn't selected any text:
:::{.callout-tip collapse=false appearance='default' icon=true}
## Optional caption (tip)
- Hide callout body with 'collapse=true'
- Remove 'collapse' to prevent expandability
- Set appearance to 'default', 'simple' or 'minimal'
- Remove icon with 'icon=false'
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a callout-block div of type 'warning', which has a yellow accent and a warning-triangle icon. Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_callout_warning()stamp_callout_warning()
The output looks like this if the user hadn't selected any text:
:::{.callout-warning collapse=false appearance='default' icon=true}
## Optional caption (warning)
- Hide callout body with 'collapse=true'
- Remove 'collapse' to prevent expandability
- Set appearance to 'default', 'simple' or 'minimal'
- Remove icon with 'icon=false'
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a div for a horizontal two-column layout with percentage widths in a Revealjs presentation slide. Will embed text selected by the user into the left column and helper text into the right, otherwise skeleton help text will be inserted into both columns.
stamp_columns()stamp_columns()
The output looks like this if the user hadn't selected any text:
:::: {.columns}
::: {.column width='40%'}
Left column
:::
::: {.column width='60%'}
Right column
:::
::::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a slide divider in a Revealjs presentation (for slides without titles).
stamp_divider()stamp_divider()
The output looks like this:
---
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a footnote marker with skeleton text. If the user selects some text before using this function, a modified version of it will be used to fill the footnote label text instead (punctuation will be removed, spaces will be replaced by hyphens and the text will be made lowercase).
stamp_footnote(clip = TRUE)stamp_footnote(clip = TRUE)
clip |
Logical. Should the footnote string be added to the clipboard so
the user can paste it at the bottom of the document? Defaults to |
The output looks like this if the user hadn't selected any text and just wants to insert a footnote skeleton:
Here is some text you wrote [^footnote].
And the console will print:
ℹ Copy the footnote '[^footnote]: Insert description'. ℹ Paste it at the bottom of your document and adjust the description. ℹ Ensure your footnote labels are unique.
The output looks like this if the user selected some text before using the function:
Here is some text[^some-text] you wrote.
And the console will print:
ℹ The footnote '[^some-text]: Insert description.' was added to the clipboard. ℹ Paste it at the bottom of your document and adjust the description. ℹ Ensure your footnote labels are unique.
Nothing. Text is updated in the active document and footnote is added
to the clipboard if clip = TRUE.
The Quarto documentation website.
Insert a list-containing div in a Revealjs presentation slide that is revealed incrementally. Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_incremental()stamp_incremental()
The output looks like this if the user hadn't selected any text:
::: {.incremental}
- List element A
- List element B
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a list-containing div to a Revealjs presentation slide that is not revealed incrementally (overrides a global incremental reveal). Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_nonincremental()stamp_nonincremental()
The output looks like this if the user hadn't selected any text:
::: {.nonincremental}
- List element A
- List element B
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a speaker notes div in a Revealjs presentation slide. Will embed text selected by the user, otherwise skeleton help text will be inserted.
stamp_notes()stamp_notes()
The output looks like this if the user hadn't selected any text:
::: {.notes}
Speaker notes (press 's' when presenting to switch to speaker mode).
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a pause marker into a Revealjs presentation slide.
stamp_pause()stamp_pause()
The output looks like this:
. . .
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a class that allows content to be scrolled if the slide is too small to hold it (place on the same line as the slide title).
stamp_scrollable()stamp_scrollable()
Output looks like this:
{.scrollable}
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a class that makes the font smaller in a Revealjs presentation slide (place on the same line as the slide title).
stamp_smaller()stamp_smaller()
Output looks like this:
{.smaller}
Nothing. Text is updated in the active document.
The Quarto documentation website.
Insert a panel tabset div to a Revealjs presentation slide. Will embed text selected by the user into the first tab and skeleton help text into the second, otherwise skeleton help text will be inserted into both tabs.
stamp_tabset()stamp_tabset()
The output looks like this if the user hadn't selected any text:
::: {.panel-tabset}
## Tab A
Content for Tab A
## Tab B
Content for Tab B
:::
Nothing. Text is updated in the active document.
The Quarto documentation website.