Use of inline HTML is not currently supported

[lionel-]

The lifecycle badges produce correct output but with warnings:

roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
  #' Foo
  #' @name foo
  #' @md
  #' @description
  #' `r lifecycle::badge('stable')`
  NULL
")
#> Warning: [<text>:5] @description Use of inline HTML is not currently supported
#> Warning: [<text>:5] @description Use of inline HTML is not currently supported
#> Warning: [<text>:5] @description Use of inline HTML is not currently supported
#> $foo.Rd
#> % Generated by roxygen2: do not edit by hand
#> % Please edit documentation in ./<text>
#> \name{foo}
#> \alias{foo}
#> \title{Foo}
#> \description{
#> \ifelse{html}{\out{<a href='https://www.tidyverse.org/lifecycle/#stable'><img src='figures/lifecycle-stable.svg' alt='Stable lifecycle'></a>}}{\strong{Stable}}
#> }

Needed for r-lib/lifecycle#17.

[gaborcsardi]

Yeah, I guess the contents of \out{} should not be parsed as markdown. So that is a bug.

EDIT: actually, it is not parsed as markdown, but it seems that we'll need to do some more escaping after the inline substitutions.

Btw. why not use \figure{} for this? Or its markdown equivalent?

[lionel-]

I'm not sure I remember well, but I think it had to do with having a clickable link. Does that make sense?

[gaborcsardi]

This seems to work well:

badge <-'\\ifelse{html}{[![](stable.svg "Stable")](https://www.tidyverse.org)}{Stable}'

The \ifelse{} is only needed because R does not format the alt text nicely.

[gaborcsardi]

More minimal reprex below. So it seems that we'll have to do another round of escaping to protect the fragile tags that were potentially inserted by inline code.

var <- "\\out{<span></span>}"
roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
  #' @name foo
  #' @title `r .GlobalEnv$var`
  #' @md
  NULL
  ")
#> Warning: [<text>:3] @title Use of inline HTML is not currently supported

#> Warning: [<text>:3] @title Use of inline HTML is not currently supported
#> $foo.Rd
#> % Generated by roxygen2: do not edit by hand
#> % Please edit documentation in ./<text>
#> \name{foo}
#> \alias{foo}
#> \title{\out{<span></span>}}
#> \description{
#> \out{<span></span>}
#> }

^{Created on 2020-06-15 by the reprex package (v0.3.0)}