ruby {html5}

Generate the <ruby> HTML tag.

Description

The <ruby> HTML element represents small annotations that are rendered above, below, or next to base text, usually used for showing the pronunciation of East Asian characters. It can also be used for annotating other kinds of text, but this usage is less common.

Usage

ruby(
  ...,
  attr = NULL,
  separate = FALSE,
  collapse = "",
  formatted = html5_vars$formatted
)

Arguments

...

A string or vector of content to pass to the tag.

attr

A named list or named vector, names are attribute names and values are attribute values.

separate

TRUE/FALSE, If TRUE, returns separate tags for each item of ...; if FALSE, returns one tag with the items of ... in the tag content.

collapse

A string. If NULL, returns a vector the same length as ... instead of collapsing the tags into one string.

formatted

TRUE/FALSE, if TRUE, HTML will be generated with indents and new lines for readability at the cost of performance. Controlled by setting the environment variable html5_vars$formatted <- TRUE/FALSE

Details

Learn more at https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ruby.

Value

A HTML tag string.

Examples

ruby(attr = list(class = "test"))