From 0a2d4ddd1f0f29b7cad6bd902302d0cd189e1996 Mon Sep 17 00:00:00 2001 From: Thomas Lin Pedersen <thomasp85@gmail.com> Date: Tue, 10 Jan 2023 08:46:54 +0100 Subject: [PATCH] fix links and redocument --- DESCRIPTION | 2 +- R/SVG.R | 2 +- man/editSVG.Rd | 4 +--- man/svglite.Rd | 6 +++--- man/svgstring.Rd | 8 +++----- man/xmlSVG.Rd | 4 +--- vignettes/fonts.Rmd | 2 +- 7 files changed, 11 insertions(+), 17 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3eb2377..cbc3d6e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -44,5 +44,5 @@ VignetteBuilder: Config/Needs/website: tidyverse/tidytemplate Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.1 SystemRequirements: C++11, libpng diff --git a/R/SVG.R b/R/SVG.R index 722b94f..ea303ca 100644 --- a/R/SVG.R +++ b/R/SVG.R @@ -60,7 +60,7 @@ #' if the file is being parsed while it is still being written to. #' @param file Identical to `filename`. Provided for backward compatibility. #' @references \emph{W3C Scalable Vector Graphics (SVG)}: -#' \url{http://www.w3.org/Graphics/SVG/} +#' \url{https://www.w3.org/Graphics/SVG/} #' @author This driver was written by T Jake Luciani #' \email{jakeluciani@@yahoo.com} 2012: updated by Matthieu Decorde #' \email{matthieu.decorde@@ens-lyon.fr} diff --git a/man/editSVG.Rd b/man/editSVG.Rd index cdfc4f7..908cc17 100644 --- a/man/editSVG.Rd +++ b/man/editSVG.Rd @@ -11,9 +11,7 @@ editSVG(code, ..., width = NA, height = NA) \item{...}{Other arguments passed on to \code{\link{svglite}}.} -\item{width}{Height and width in inches.} - -\item{height}{Height and width in inches.} +\item{height, width}{Height and width in inches.} } \description{ This is useful primarily for testing or post-processing the SVG. diff --git a/man/svglite.Rd b/man/svglite.Rd index a74f7f8..fac1f50 100644 --- a/man/svglite.Rd +++ b/man/svglite.Rd @@ -33,14 +33,14 @@ svglite( \item{standalone}{Produce a standalone svg file? If \code{FALSE}, omits xml header and default namespace.} -\item{system_fonts}{\ifelse{html}{\out{<a href='https://www.tidyverse.org/lifecycle/#superseded'><img src='figures/lifecycle-superseded.svg' alt='Superseded lifecycle'></a>}}{\strong{Superseded}} \emph{Consider using +\item{system_fonts}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \emph{Consider using \code{\link[systemfonts:register_font]{systemfonts::register_font()}} instead}. Named list of font names to be aliased with fonts installed on your system. If unspecified, the R default families \code{sans}, \code{serif}, \code{mono} and \code{symbol} are aliased to the family returned by \code{\link[systemfonts]{font_info}()}.} -\item{user_fonts}{\ifelse{html}{\out{<a href='https://www.tidyverse.org/lifecycle/#superseded'><img src='figures/lifecycle-superseded.svg' alt='Superseded lifecycle'></a>}}{\strong{Superseded}} \emph{Consider using +\item{user_fonts}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \emph{Consider using \code{\link[systemfonts:register_font]{systemfonts::register_font()}} instead}. Named list of fonts to be aliased with font files provided by the user rather than fonts properly installed on the system. The aliases can be fonts from the fontquiver @@ -105,7 +105,7 @@ dev.off() } \references{ \emph{W3C Scalable Vector Graphics (SVG)}: -\url{http://www.w3.org/Graphics/SVG/} +\url{https://www.w3.org/Graphics/SVG/} } \seealso{ \code{\link{pictex}}, \code{\link{postscript}}, \code{\link{Devices}} diff --git a/man/svgstring.Rd b/man/svgstring.Rd index 68c0c20..512a0de 100644 --- a/man/svgstring.Rd +++ b/man/svgstring.Rd @@ -19,9 +19,7 @@ svgstring( ) } \arguments{ -\item{width}{Height and width in inches.} - -\item{height}{Height and width in inches.} +\item{height, width}{Height and width in inches.} \item{bg}{Default background color for the plot (defaults to "white").} @@ -30,14 +28,14 @@ svgstring( \item{standalone}{Produce a standalone svg file? If \code{FALSE}, omits xml header and default namespace.} -\item{system_fonts}{\ifelse{html}{\out{<a href='https://www.tidyverse.org/lifecycle/#superseded'><img src='figures/lifecycle-superseded.svg' alt='Superseded lifecycle'></a>}}{\strong{Superseded}} \emph{Consider using +\item{system_fonts}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \emph{Consider using \code{\link[systemfonts:register_font]{systemfonts::register_font()}} instead}. Named list of font names to be aliased with fonts installed on your system. If unspecified, the R default families \code{sans}, \code{serif}, \code{mono} and \code{symbol} are aliased to the family returned by \code{\link[systemfonts]{font_info}()}.} -\item{user_fonts}{\ifelse{html}{\out{<a href='https://www.tidyverse.org/lifecycle/#superseded'><img src='figures/lifecycle-superseded.svg' alt='Superseded lifecycle'></a>}}{\strong{Superseded}} \emph{Consider using +\item{user_fonts}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \emph{Consider using \code{\link[systemfonts:register_font]{systemfonts::register_font()}} instead}. Named list of fonts to be aliased with font files provided by the user rather than fonts properly installed on the system. The aliases can be fonts from the fontquiver diff --git a/man/xmlSVG.Rd b/man/xmlSVG.Rd index 7048eee..c62e157 100644 --- a/man/xmlSVG.Rd +++ b/man/xmlSVG.Rd @@ -14,9 +14,7 @@ xmlSVG(code, ..., standalone = FALSE, height = 7, width = 7) \item{standalone}{Produce a standalone svg file? If \code{FALSE}, omits xml header and default namespace.} -\item{height}{Height and width in inches.} - -\item{width}{Height and width in inches.} +\item{height, width}{Height and width in inches.} } \value{ A \code{xml2::xml_document} object. diff --git a/vignettes/fonts.Rmd b/vignettes/fonts.Rmd index 2c82d1f..447906e 100644 --- a/vignettes/fonts.Rmd +++ b/vignettes/fonts.Rmd @@ -20,7 +20,7 @@ name is then recorded in the `font-family` property of text anchors so that SVG renderers know what fonts to use. svglite does try to ensure a consistent figure rendering even when fonts are not available at the time of rendering (by supplying the -[textLength](http://www.w3.org/TR/SVG/text.html#TextElementTextLengthAttribute) +[textLength](https://www.w3.org/TR/SVG/text.html#TextElementTextLengthAttribute) SVG text attribute). However, the text may look slightly distorted when a fallback font is used. This means that for optimal display, the font must be available on both the computer used to create the