'add .extensions and .pandoc_args arguments' (#26)

* add .extensions and .pandoc_args arguments * update vignettes * update NEWS * build docs and man * update NEWS
atusy · Oct 22, 2020 · 2bf00d3 · 2bf00d3
1 parent 0a21e54
commit 2bf00d3
Show file tree

Hide file tree

Showing 14 changed files with 83 additions and 31 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,11 +1,12 @@
-# ftExtra 0.0.3.6
+# ftExtra 0.0.3.7
 
 * Support markdown footnote with `colformat_md`. Currently, one footnote per a cell is allowed, and it must be located at the end of the cell content (#22).
 * Add `footnote_options()` to configure options for footnotes (#23).
 * Support formatting markdown texts on header with `colformat_md(part = "header")` (#23).
 * Support single- and double-quotes by a lua filter (dfc82e0).
 * Support attributes with Span, Link, and Code. Useful attributes include the `.underline` class and the `color`, `shading.color`, and `font.family` attributes (#24).
 * Support inline code (#25).
+* Add the `.extensions` and `.pandoc_args` arguments to `colformat_md()` and `as_paragraph_md()` (#26).
 
 # ftExtra 0.0.3
 

diff --git a/R/as-paragraph-md.R b/R/as-paragraph-md.R
@@ -31,14 +31,23 @@ image_size <- function(x, y = "width") {
 }
 
 parse_md <- function(x,
-                     .from = "markdown",
                      auto_color_link = "blue",
+                     .from = "markdown",
+                     .pandoc_args = NULL,
                      .footnote_options = NULL) {
   if (!is.character(auto_color_link) || length(auto_color_link) != 1L) {
     stop("`auto_color_link` must be a string")
   }
 
-  md_df <- md2df(x, .from = .from)
+  md_df <- md2df(
+    x,
+    .from = .from,
+    .pandoc_args = c(
+      "--lua-filter", system.file("lua/smart.lua", package = "ftExtra"),
+      "--lua-filter", system.file("lua/inline-code.lua", package = "ftExtra"),
+      .pandoc_args
+    )
+  )
 
   if (is.null(.footnote_options) || (all(names(md_df) != "Note"))) {
     y <- md_df
@@ -96,7 +105,12 @@ construct_chunk <- function(x, auto_color_link = "blue") {
 #' @param auto_color_link A color of the link texts.
 #' @param .from
 #'   Pandoc's `--from` argument (default: `'markdown+autolink_bare_uris'`).
-#' @param .footnote_options Spec options for footnotes via `colformat_md`.
+#' @param .extensions
+#'   Pandoc's extensions (see <https://www.pandoc.org/MANUAL.html#extensions>)
+#' @param .pandoc_args
+#'   Extra arguments given to Pandoc
+#' @param ...
+#'   Arguments passed to internal functions.
 #'
 #' @examples
 #' if (rmarkdown::pandoc_available()) {
@@ -114,10 +128,13 @@ construct_chunk <- function(x, auto_color_link = "blue") {
 as_paragraph_md <- function(x,
                             auto_color_link = "blue",
                             .from = "markdown+autolink_bare_uris",
-                            .footnote_options = NULL) {
+                            .extensions = NULL,
+                            .pandoc_args = NULL,
+                            ...) {
   structure(lapply(x, parse_md,
-                   .from = .from,
+                   .from = paste0(.from, paste(.extensions, collapse="")),
+                   .pandoc_args = .pandoc_args,
                    auto_color_link = auto_color_link,
-                   .footnote_options = .footnote_options),
+                   ...),
             class = "paragraph")
 }
diff --git a/R/colformat.R b/R/colformat.R
@@ -25,7 +25,9 @@ colformat_md <- function(x,
                          part = c("body", "header", "all"),
                          auto_color_link = "blue",
                          .footnote_options = footnote_options(),
-                         .from = "markdown+autolink_bare_uris"
+                         .from = "markdown+autolink_bare_uris",
+                         .extensions = NULL,
+                         .pandoc_args = NULL
 ) {
   .j <- rlang::enexpr(j)
   part <- match.arg(part)
@@ -56,6 +58,7 @@ colformat_md <- function(x,
                              unlist(dataset[col], use.names = FALSE),
                              auto_color_link = auto_color_link,
                              .from = .from,
+                             .extensions = .extensions,
                              .footnote_options = .footnote_options
                            ))
 

diff --git a/R/md2ast.R b/R/md2ast.R
@@ -2,7 +2,7 @@
 #' @param x A character vector
 #' @param .from Markdown format
 #' @noRd
-md2ast <- function(x, .from = "markdown") {
+md2ast <- function(x, .from = "markdown", .pandoc_args = NULL) {
   tf <- tempfile()
   writeLines(x, tf)
   jsonlite::fromJSON(
@@ -12,9 +12,7 @@ md2ast <- function(x, .from = "markdown") {
         tf,
         "--from", .from,
         "--to json",
-        "--lua-filter", system.file("lua/smart.lua", package = "ftExtra"),
-        "--lua-filter", system.file("lua/inline-code.lua", package = "ftExtra"),
-        ""
+        paste(.pandoc_args, collapse = " ")
       ),
       intern = TRUE
     ),

diff --git a/R/md2df.R b/R/md2df.R
@@ -149,8 +149,8 @@ ast2df <- function(x) {
 
 #' Convert Pandoc's Markdown to data frame
 #' @noRd
-md2df <- function(x, .from) {
-  ast <- md2ast(x, .from = .from)
+md2df <- function(x, .from = "markdown", .pandoc_args = NULL) {
+  ast <- md2ast(x, .from = .from, .pandoc_args = .pandoc_args)
 
   if ((ast$blocks[[1]]$t != "Para") || (length(ast$blocks) > 1)) {
     stop("Markdown text must be a single paragraph")

diff --git a/docs/articles/format_columns.html b/docs/articles/format_columns.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -5,5 +5,5 @@ articles:
   format_columns: format_columns.html
   group-rows: group-rows.html
   transform-headers: transform-headers.html
-last_built: 2020-10-22T12:58Z
+last_built: 2020-10-22T13:37Z
 
diff --git a/docs/reference/as_paragraph_md.html b/docs/reference/as_paragraph_md.html
diff --git a/docs/reference/colformat_md.html b/docs/reference/colformat_md.html
diff --git a/docs/reference/footnote_options.html b/docs/reference/footnote_options.html
diff --git a/man/as_paragraph_md.Rd b/man/as_paragraph_md.Rd
diff --git a/man/colformat_md.Rd b/man/colformat_md.Rd
diff --git a/vignettes/format_columns.Rmd b/vignettes/format_columns.Rmd
@@ -146,11 +146,11 @@ data.frame(linebreak = c("a\nb"), stringsAsFactors = FALSE) %>%
 
 ## Emoji
 
-Pandoc's markdown provides an extension, `'emoji'`.
-To use it with `colformat_md()`, specify `markdown+emoji`.
+Pandoc's markdown provides an extension, `emoji`.
+To use it with `colformat_md()`, specify `.extensions="+emoji"`.
 
 ```{r}
 data.frame(emoji = c(":+1:"), stringsAsFactors = FALSE) %>%
   as_flextable() %>%
-  colformat_md(.from = "markdown+emoji")
+  colformat_md(.extensions = "+emoji")
 ```