renderer_html: html renderer using span tags and CSS
In highlight: Syntax Highlighter
translator_html R Documentation
html renderer using span tags and CSS
Description
implementation of the renderer that renders
the information as a series of <span> html tags
Usage
translator_html(x, size)
space_html()
newline_html()
renderer_html(
document = TRUE,
translator = translator_html,
formatter = formatter_html,
space = space_html,
newline = newline_html,
header = header_html(document, stylesheet),
footer = footer_html(document),
stylesheet = "default",
...
)
Arguments
x
argument to the translator. Returned as is.
size
font size. ignored
document
logical. Indicates if the renderer should render a full document
or simply a <pre> section containing the highlighted
tokens. This argument is used by the header_html and
footer_html to build appropriate header and footer.
translator
Since the highlighted tokens are wrapped in a <pre> tag,
no further translation is needed.
formatter
html formatter. creates <span> tags for all tokens.
See formatter_html
space
returns a space character
newline
returns a newline character
header
html header. Depending on the document argument, this will be a
function building a the beginning of a
complete html document (starting with <html>) including
css definitions or simply a function returning <pre>
enabling the renderer to be used to just render the syntax
as part of a bigger document.
footer
html footer. Depending on the document argument, this will
either close the full document (close the </html> tag)
or simply close the </pre> tag.
stylesheet
stylesheet to use. This is used by the header when document is TRUE.
The content of the stylesheet is copied verbatim into a <style>
tag in that case. See getStyleFile for details
on where the stylesheet can be located
...
Additional arguments. unused.
Value
A renderer capable suitable for the renderer argument
of highlight
See Also
renderer for a description of the interface
this renderer is implementing.
highlight takes a renderer argument to which it
delegates rendering.
highlight documentation built on Jan. 22, 2023, 1:38 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| translator_html | R Documentation |
html renderer using span tags and CSS
Description
implementation of the renderer that renders
the information as a series of <span> html tags
Usage
translator_html(x, size) space_html() newline_html() renderer_html( document = TRUE, translator = translator_html, formatter = formatter_html, space = space_html, newline = newline_html, header = header_html(document, stylesheet), footer = footer_html(document), stylesheet = "default", ... )
Arguments
x |
argument to the translator. Returned as is. |
size |
font size. ignored |
document |
logical. Indicates if the renderer should render a full document
or simply a <pre> section containing the highlighted
tokens. This argument is used by the |
translator |
Since the highlighted tokens are wrapped in a <pre> tag, no further translation is needed. |
formatter |
html formatter. creates <span> tags for all tokens.
See |
space |
returns a space character |
newline |
returns a newline character |
header |
html header. Depending on the document argument, this will be a function building a the beginning of a complete html document (starting with <html>) including css definitions or simply a function returning <pre> enabling the renderer to be used to just render the syntax as part of a bigger document. |
footer |
html footer. Depending on the document argument, this will either close the full document (close the </html> tag) or simply close the </pre> tag. |
stylesheet |
stylesheet to use. This is used by the header when document is TRUE.
The content of the stylesheet is copied verbatim into a <style>
tag in that case. See |
... |
Additional arguments. unused. |
Value
A renderer capable suitable for the renderer argument
of highlight
See Also
renderer for a description of the interface
this renderer is implementing.
highlight takes a renderer argument to which it
delegates rendering.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.