Merge pull request #4 from SciViews/displayMode

Argument display=FALSE to transform_mathjax() - inline/display equations

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: equatags
 Type: Package
 Title: Equations to 'XML'
-Version: 0.2.0
+Version: 0.2.1
 Authors@R: c(
     person("David", "Gohel", role = c("aut", "cre"),
     email = "david.gohel@ardata.fr"),
@@ -16,6 +16,6 @@ BugReports: https://github.com/ardata-fr/equatags/issues
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.0
+RoxygenNote: 7.2.3
 Depends: R (>= 4.0.0)
 Imports: xml2, xslt, tools, katex

NEWS.md

@@ -1,7 +1,11 @@
+# equatags 0.2.1
+
+\*.add a display= argument to transform_mathjax() to allow generating display or inline equations. It is set to FALSE by default (inline equation). This changes the behaviour that was previously to generate display equations only.
+
 # equatags 0.2.0
 
-* drop the node.js dependency in favor of package katex.
+-   drop the node.js dependency in favor of package katex.
 
 # equatags 0.1.1
 
-* use tools::R_user_dir instead of rappdirs::user_data_dir as it's a condition to keep the package on CRAN ("This is using ^~/.local/share/equatags , prohibited by the CRAN policy.  Please replace the use of rappdirs by the allowed procedure documented there.")
+-   use tools::R_user_dir instead of rappdirs::user_data_dir as it's a condition to keep the package on CRAN ("This is using \^\~/.local/share/equatags , prohibited by the CRAN policy. Please replace the use of rappdirs by the allowed procedure documented there.")

R/write_mathjax.R

@@ -20,6 +20,8 @@ xml_header <- "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
 #' of 'MathJax' equations.
 #' @param x MathJax equations
 #' @param to output format, one of 'html' or 'mml'
+#' @param display should the equation be in display (`TRUE`) or inline mode
+#' (`FALSE`, by default)
 #' @return a character vector that contains 'html' or 'mml'
 #' codes corresponding to the equations.
 #' @examples
@@ -31,7 +33,7 @@ xml_header <- "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
 #' cat(z, sep = "\n\n")
 #' @importFrom xml2 read_xml xml_children
 #' @importFrom katex katex_mathml katex_html
-transform_mathjax <- function(x, to = "html"){
+transform_mathjax <- function(x, to = "html", display = FALSE){
 
   if(length(x) < 1) return(character(0))
   to <- match.arg(to, choices = c("html", "mml", "svg"), several.ok = FALSE)
@@ -43,7 +45,8 @@ transform_mathjax <- function(x, to = "html"){
     info <- gsub("<span class=\"katex\">", "", info, fixed = TRUE)
     info <- vapply(info, mml_to_ooml, FUN.VALUE = character(1L), USE.NAMES = FALSE)
   } else {
-    info <- vapply(x, katex_html, "", preview = FALSE, include_css = TRUE)
+    info <- vapply(x, katex_html, "", preview = FALSE, include_css = TRUE,
+      displayMode = display)
     names(info) <- NULL
   }