BREAKING: Remove div, span, mdapply, as_markdown (#7)

- Remove div, span, and as_markdown as they have been superseded by qto_div, qt_span, and qto_block - Remove as_markdown, as it is superseded by calling qto_block(map_qto))
ElianHugh · Dec 16, 2023 · beef3ed · beef3ed
1 parent c102a7b
commit beef3ed
Show file tree

Hide file tree

Showing 20 changed files with 178 additions and 509 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,10 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,quarto_block)
-export(as_markdown)
-export(div)
 export(map_qto)
-export(mdapply)
 export(qto_attributes)
 export(qto_block)
 export(qto_callout)
@@ -20,7 +17,6 @@ export(qto_pagebreak)
 export(qto_shortcode)
 export(qto_span)
 export(qto_video)
-export(span)
 export(with_body_column)
 export(with_margin_column)
 export(with_page_column)

diff --git a/R/block.R b/R/block.R
@@ -15,7 +15,6 @@
 #'
 #' @return character vector of length 1
 #' @seealso
-#' - [as_markdown()]
 #' - [knitr::asis_output()]
 #'
 #' @export

diff --git a/R/elements.R b/R/elements.R
diff --git a/R/misc.R b/R/misc.R
diff --git a/R/with.R b/R/with.R
@@ -13,47 +13,107 @@ handle_extensions <- function(extension, valid_extensions) {
 #'
 #' See [the Quarto documentation for a full list
 #' of available extension options](https://quarto.org/docs/authoring/article-layout.html#available-columns).
-#' @param outset should the outset affix be applied to the column class?
+#' @param outset If `TRUE`, the ouset affix is applied to the column class
 #' @param extension affix to apply to column class
-#' @inheritParams div
+#' @inheritParams qto_div
+#' @inheritDotParams qto_div
 #' @export
 #' @examples
 #' with_body_column("Hello world!")
 #' @return character vector of length 1
 #' @rdname page-layout
-with_body_column <- function(..., attr = NULL, outset = FALSE, extension = NULL) {
+with_body_column <- function(...,
+                             outset = FALSE,
+                             id = NULL,
+                             class = NULL,
+                             extension = NULL,
+                             .attributes = NULL,
+                             call = caller_env()) {
     extension_string <- handle_extensions(extension, c("left", "right"))
     outset_string <- ifelse(isTRUE(outset), "-outset", "")
     cls <- sprintf(".column-body%s%s", outset_string, extension_string)
-    div(..., attr = c(cls, attr))
+    .attributes <- c(cls, as.list(.attributes))
+    .attributes <- list_drop_empty(.attributes)
+    qto_div(
+        ...,
+        id = id,
+        .attributes = .attributes,
+        call = call
+    )
 }
 
 #' @export
 #' @rdname page-layout
-with_page_column <- function(..., attr = NULL, extension = NULL) {
+with_page_column <- function(...,
+                             id = NULL,
+                             class = NULL,
+                             extension = NULL,
+                             .attributes = NULL,
+                             call = caller_env()) {
     extension_string <- handle_extensions(extension, c("left", "right"))
     cls <- sprintf(".column-page%s", extension_string)
-    div(..., attr = c(cls, attr))
+    .attributes <- c(cls, as.list(.attributes))
+    .attributes <- list_drop_empty(.attributes)
+    qto_div(
+        ...,
+        id = id,
+        .attributes = .attributes,
+        call = call
+    )
 }
 
 #' @export
 #' @rdname page-layout
-with_screen_inset_column <- function(..., attr = NULL, extension = NULL) {
+with_screen_inset_column <- function(...,
+                                     id = NULL,
+                                     class = NULL,
+                                     extension = NULL,
+                                     .attributes = NULL,
+                                     call = caller_env()) {
     extension_string <- handle_extensions(extension, c("left", "right", "shaded"))
     cls <- sprintf(".column-screen-inset%s", extension_string)
-    div(..., attr = c(cls, attr))
+    .attributes <- c(cls, as.list(.attributes))
+    .attributes <- list_drop_empty(.attributes)
+    qto_div(
+        ...,
+        id = id,
+        .attributes = .attributes,
+        call = call
+    )
 }
 
 #' @export
 #' @rdname page-layout
-with_screen_column <- function(..., attr = NULL, extension = NULL) {
+with_screen_column <- function(...,
+                               id = NULL,
+                               class = NULL,
+                               extension = NULL,
+                               .attributes = NULL,
+                               call = caller_env()) {
     extension_string <- handle_extensions(extension, c("left", "right"))
     cls <- sprintf(".column-screen%s", extension_string)
-    div(..., attr = c(cls, attr))
+    .attributes <- c(cls, as.list(.attributes))
+    .attributes <- list_drop_empty(.attributes)
+    qto_div(
+        ...,
+        id = id,
+        .attributes = .attributes,
+        call = call
+    )
 }
 
 #' @export
 #' @rdname page-layout
-with_margin_column <- function(..., attr = NULL) {
-    div(..., attr = c(".column-margin", attr))
+with_margin_column <- function(...,
+                               id = NULL,
+                               .attributes = NULL,
+                               call = caller_env()) {
+    .attributes <- c(".column-margin", as.list(.attributes))
+    .attributes <- list_drop_empty(.attributes)
+    qto_div(
+        ...,
+        id = id,
+        .attributes = .attributes,
+        call = call
+    )
 }
diff --git a/README.md b/README.md
@@ -122,46 +122,8 @@ print(fig_example)
 We can leverage the `apply` family of functions ability to loop over
 list elements to simplify creating many divs at once.
 
-Normally this would require a workaround to allow for printing directly
-as markdown content, but `{quartools}` exports the `mdapply` function
-(read: “markdown apply”) which allows for directly printing the result
-as valid markdown content:
-
-``` r
-input <- list(
-  list(type = "tip", msg = "a tip"),
-  list(type = "warning", msg = "a warning"),
-  list(type = "message", msg = "a message")
-)
-
-mdapply(input, function(x) div(x$msg, attr = sprintf(".callout-%s", x$type))) |>
-  print()
-```
-
-
-
-    :::{.callout-tip}
-
-    a tip
-
-    :::
-
-
-    :::{.callout-warning}
-
-    a warning
-
-    :::
-
-
-    :::{.callout-message}
-
-    a message
-
-    :::
-
-`map_qto()` is a similar alternative and allows users to set the
-function using the `.type` parameter:
+`map_qto()` allows users to set the function using the `.type`
+parameter:
 
 ``` r
 qto_list <- map_qto(list("This is a note.", "And this is a note.", "And this is a note"), .type = "callout")

diff --git a/README.qmd b/README.qmd
@@ -91,20 +91,7 @@ print(fig_example)
 
 We can leverage the `apply` family of functions ability to loop over list elements to simplify creating many divs at once.
 
-Normally this would require a workaround to allow for printing directly as markdown content, but `{quartools}` exports the `mdapply` function (read: "markdown apply") which allows for directly printing the result as valid markdown content:
-
-```{r}
-input <- list(
-  list(type = "tip", msg = "a tip"),
-  list(type = "warning", msg = "a warning"),
-  list(type = "message", msg = "a message")
-)
-
-mdapply(input, function(x) div(x$msg, attr = sprintf(".callout-%s", x$type))) |>
-  print()
-```
-
-`map_qto()` is a similar alternative and allows users to set the function using the `.type` parameter:
+`map_qto()` allows users to set the function using the `.type` parameter:
 
 ```{r}
 qto_list <- map_qto(list("This is a note.", "And this is a note.", "And this is a note"), .type = "callout")

diff --git a/man/as_markdown.Rd b/man/as_markdown.Rd
diff --git a/man/div.Rd b/man/div.Rd