Package 'juicedown'

Description

This function inserts HTML snippet to help students memorize important concepts. To make this function to work, you need to run anki_setup() somewhere in the markdown document.

Usage

anki(text)

Arguments

Value

HTML code span.

Description

This function inserts JavaScript code for anki texts. Call this function in a code chunk somewhere in your R Markdown file. Use anki() function with a inline r code, to make a hidden block.

Usage

anki_setup(
  background = "yellow",
  color = "blue",
  border = "slateblue",
  padding = 3,
  margin = 3,
  cursor = "pointer"
)

Arguments

Value

character. CSS/JavaScript code for anki texts.

Description

This function facilitates writing contents in R Markdown formats for CMS the source editor of which silently removes style tags. When run interactively, the resulting HTML code will be copied to the clipboard.

It basically does three things:

1. it converts (R) Markdown file into a HTML file with knitr::knit() + markdown::mark(),

2. embed CSS information in style atribute with juicyjuice::css_inline(), and then

3. extracts article/div element that is ready for copying and pasting into CMS's source editor.

Usage

convert(
  file = NULL,
  dir = NULL,
  tag = NULL,
  id = NULL,
  clip = TRUE,
  full_html = NULL,
  remove_script = NULL,
  stylesheet = NULL,
  template = NULL
)

Arguments

Value

Invisibly returns a character vector identical to the result file.

Details

Change default behaviors with options()

Currently, three global defaults are available. You can set these defaults to alter the appearance of the result.

• juicedown.template: Defaults to juicedown:::pkg_file("xml", "template.html")

• juicedown.article.css: Defaults to juicedown:::pkg_file("css", "article.scss")

• juicedown.div.css: juicedown:::pkg_file("css", "div.scss")

Priority order

You can pass conversion parameters in function argument and YAML metadata (under juicedown key) and for some parameters, global options, with priority given in that order. For instance, if the stylesheet parameter exists in the function call, it is used. If not and if YAML metadata has stylesheet key under juicedown key, then that will be used. In the below example, some.css used.

---
juicedown:
  stylesheet:
     some.css
---

If neither the function argument nor missing YAML metadata exist, then the global option (such as juicedown.article.css) will be used.

Examples

file <- juicedown_example("markdown", "sample.md")
tdir <- tempdir()
convert(file, dir = tdir, clip = FALSE)
unlink(file.path(tdir, "sample.html"))

Description

Convert a HTML file into a HTML block to be copied and pasted for CMS.

Usage

convert_html2cms(
  in_text,
  full_html = the$full_html %||% FALSE,
  tag = the$tag %||% "body",
  id = the$id,
  remove_script = the$remove_script %||% FALSE
)

Arguments

Value

character. HTML block.

Description

Define a counter with cnt <- counter("type"). Add cross-referenced label in your document with cnt$set("ref"). Refer to "ref" with cnt$get("ref").

Usage

counter(label, open = NULL, close = NULL, sep = " ", link = FALSE)

Arguments

Value

List of functions to set and get counters with label.

Examples

cnt <- counter("Quiz")
cnt$set("aaa")
cnt$set()
cnt$set("bbb", quiet = TRUE)
cnt$get("aaa")
cnt$get("bbb")
cnt$get("aaa", type = "bare")
cnt$dump()

Description

Include Audio media.

Usage

includeAudio(
  url,
  preload = c("metadata", "auto", "none"),
  alt = "Your browser does not support the audio element."
)

Arguments

Value

An R object of class "knit_asis" (defined in the knitr package), the data of which is the HTML audio tag to insert into the document.

Description

Include Flickr album

Usage

includeFlickr(albumUrl, title = NULL, width = 480, height = 360)

Arguments

Value

Flickr embed code.

Description

This function is a wrapper for knitr::include_graphics().

Usage

includeGraphics(path, ...)

Arguments

Value

The result of knitr::include_graphics()

Description

Include Summary/Details block.

Usage

includeQuestion(
  summary,
  detail,
  summary_label = "Quiz",
  detail_label = "Answer",
  ...
)

Arguments

Value

HTML5 summary/details block is inserted.

Description

Insert text into a document.

Usage

includeText(path, data = parent.frame(), quiet = TRUE)

Arguments

Value

An R object of class "knit_asis" (defined in the knitr package), the data of which represents the content of the child document (after knitr::knit())

Examples

template <- tempfile()
cat("Hello, `r name`.\n", file = template)
includeText(template, data = list(name = "Alice"))
file.remove(template)

Description

Include YouTube video.

Usage

includeYT(url, .class = "includeYT")

Arguments

Value

An embed code of a YouTube video is inserted.

Description

List example files for the package. Show the path when the exact name is given.

Usage

juicedown_example(name = NULL, file = NULL)

Arguments

Details

The package sample files are organized under samples directory like so:

samples/ |– from-html/ | -- sample.html – include/ |– pic/ '– sample.Rmd

• juicedown_example() is equivalent to ⁠ls samples⁠,

• juicedown_example("from-html") is to ⁠ls samples/from-html⁠, and

• juicedown_example("from-html", "sample.html") shows the full path.

Value

character. A list of example files or a path string to each example file.

Examples

juicedown_example()
juicedown_example("from-html")
juicedown_example("from-html", "sample.html")

Description

Footnote highlighting is corrupt when CSS is in-lined. Fix this by calling this function in a code chunk somewhere in your R Markdown file.

Usage

tweak_footnote_highlight()

Value

Script block that makes highlighting possible.

Description

You may want the title of the article to be different from the title of the resource. Call this function in a code chunk somewhere in your R Markdown file.

Usage

tweak_moodle_heading()

Value

Script block that makes H2 head of the content invisible.