Skip to contents

Escape Characters With Special HTML Meaning

Source: R/misc.R
html_esc.Rd

Arbitrary text may contain characters with special meaning in HTML, which may cause HTML display to be corrupted if they are included unescaped in a web page. This function escapes those special characters so they do not interfere with the HTML markup generated by e.g. to_html.

Usage

html_esc(x, what = getOption("fansi.html.esc", "<>&'\""))

Arguments

x

character vector

what

character(1) containing any combination of ASCII characters "<", ">", "&", "'", or "\"". These characters are special in HTML contexts and will be substituted by their HTML entity code. By default, all special characters are escaped, but in many cases "<>&" or even "<>" might be sufficient. @return x, but with the what characters replaced by their HTML entity codes.

Note

Non-ASCII strings are converted to and returned in UTF-8 encoding.

See also

Other HTML functions: in_html(), make_styles(), to_html()

Examples

html_esc("day > night")
#> [1] "day &gt; night"
html_esc("<SPAN>hello world</SPAN>")
#> [1] "&lt;SPAN&gt;hello world&lt;/SPAN&gt;"