PDF render updates

DESCRIPTION

@@ -7,10 +7,10 @@ Description: Functions for easily creating interactive web pages using
 Authors@R: c(
     person("Dale","Barr",
            email = "[email protected]",
-	         role = c("aut", "cre")),
+	         role = c("aut")),
     person("Lisa", "DeBruine",
-           email = "lisa.debruine@glasgow.ac.uk",
-           role = "aut"))
+           email = "debruine@gmail.com",
+           role = c("aut", "cre")))
 URL: https://github.com/psyteachr/webexercises
 Depends: R (>= 3.1.2)
 Imports:

NEWS.md

@@ -5,6 +5,7 @@
 * webex.hide knit hooks get set up .onLoad instead of in webex.R
 * remove js dependency on jquery
 * `total_correct()` deprecated
+* PDF rendering is better (but webexercises is really built for HTML)
 
 # webexercises 1.0.0
 

R/webexercises_fns.R

@@ -63,13 +63,25 @@ fitb <- function(answer,
   answers <- jsonlite::toJSON(as.character(answer))
   answers <- gsub("\'", "&apos;", answers, fixed = TRUE)
 
-  paste0("<input class='webex-solveme",
+  # html format
+  html <- paste0("<input class='webex-solveme",
          ifelse(ignore_ws, " nospaces", ""),
          ifelse(!is.null(tol), paste0("' data-tol='", tol, ""), ""),
          ifelse(ignore_case, " ignorecase", ""),
          ifelse(regex, " regex", ""),
          "' size='", width,
          "' data-answer='", answers, "'/>")
+
+  # pdf / other format
+  pdf <- paste(rep("_", width), collapse = "")
+
+  # check type of knitting
+  out_fmt <- knitr::opts_knit$get("out.format")
+  pandoc_to <- knitr::opts_knit$get("rmarkdown.pandoc.to")
+  ifelse((is.null(out_fmt) & is.null(pandoc_to)) ||
+           isTRUE(out_fmt == "html") ||
+           isTRUE(pandoc_to == "html"),
+         html, pdf)
 }
 
 #' Create a multiple-choice question
@@ -96,9 +108,22 @@ mcq <- function(opts) {
     stop("MCQ has no correct answer")
   }
 
+  # html format
   options <- sprintf("<option value='%s'>%s</option>", names(opts), opts)
-  sprintf("<select class='webex-select'><option value='blank'></option>%s</select>",
+  html <- sprintf("<select class='webex-select'><option value='blank'></option>%s</select>",
           paste(options, collapse = ""))
+
+  # pdf / other format
+  pdf_opts <- sprintf("* (%s) %s  ", LETTERS[seq_along(opts)], opts)
+  pdf <- paste0("\n\n", paste(pdf_opts, collapse = "\n"), "\n\n")
+
+  # check type of knitting
+  out_fmt <- knitr::opts_knit$get("out.format")
+  pandoc_to <- knitr::opts_knit$get("rmarkdown.pandoc.to")
+  ifelse((is.null(out_fmt) & is.null(pandoc_to)) ||
+           isTRUE(out_fmt == "html") ||
+           isTRUE(pandoc_to == "html"),
+         html, pdf)
 }
 
 #' Create a true-or-false question
@@ -122,7 +147,14 @@ torf <- function(answer) {
     names(opts) <- c("answer", "")
   else
     names(opts) <- c("", "answer")
-  mcq(opts)
+
+  # check type of knitting
+  out_fmt <- knitr::opts_knit$get("out.format")
+  pandoc_to <- knitr::opts_knit$get("rmarkdown.pandoc.to")
+  ifelse((is.null(out_fmt) & is.null(pandoc_to)) ||
+           isTRUE(out_fmt == "html") ||
+           isTRUE(pandoc_to == "html"),
+         mcq(opts), "TRUE / FALSE")
 }
 
 
@@ -162,9 +194,22 @@ longmcq <- function(opts) {
   qname <- paste0("radio_", paste(sample(LETTERS, 10, T), collapse = ""))
   options <- sprintf('<label><input type="radio" autocomplete="off" name="%s" value="%s"></input> <span>%s</span></label>', qname, names(opts), opts2)
 
-  paste0("<div class='webex-radiogroup' id='", qname, "'>",
+  # html format
+  html <- paste0("<div class='webex-radiogroup' id='", qname, "'>",
          paste(options, collapse = ""),
          "</div>\n")
+
+  # pdf / other format
+  pdf_opts <- sprintf("* (%s) %s  ", LETTERS[seq_along(opts2)], opts2)
+  pdf <- paste0("\n\n", paste(pdf_opts, collapse = "\n"), "\n\n")
+
+  # check type of knitting
+  out_fmt <- knitr::opts_knit$get("out.format")
+  pandoc_to <- knitr::opts_knit$get("rmarkdown.pandoc.to")
+  ifelse((is.null(out_fmt) & is.null(pandoc_to)) ||
+           isTRUE(out_fmt == "html") ||
+           isTRUE(pandoc_to == "html"),
+         html, pdf)
 }
 
 

README.md

@@ -12,7 +12,9 @@ Although `{webexercises}` has fewer features than RStudio’s
 lightweight: whereas `{learnr}` tutorials must be either hosted on a
 shiny server or run locally, `{webexercises}` creates standalone HTML
 files that require only a JavaScript-enabled browser. It is also
-extremely simple to use.
+extremely simple to use. See the [webexercises
+website](https://psyteachr.github.io/webexercises/) for demos and
+instructions.
 
 ## Installation
 
@@ -29,10 +31,6 @@ You can install the development version from
 devtools::install_github("psyteachr/webexercises")
 ```
 
-See the [webexercises
-website](https://psyteachr.github.io/webexercises/) for demos and
-instructions.
-
 <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This
 work is licensed under a
 <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative

tests/testthat/test-create_quarto_doc.R

@@ -9,7 +9,9 @@ test_that("untitled doc", {
   css <- file.path(normalizePath(tmpdir), "Untitled", "webex.css")
   js <- file.path(normalizePath(tmpdir), "Untitled", "webex.js")
 
-  expect_equal(path, expected)
+  #expect_equal(path, expected)
+  expect_true(file.exists(expected))
+  expect_true(file.exists(path))
   expect_true(file.exists(css))
   expect_true(file.exists(js))
 
@@ -28,5 +30,18 @@ test_that("titled doc", {
 
   expected <- file.path(normalizePath(tmpdir), "MyBook", "MyBook.qmd")
 
-  expect_equal(path, expected)
+  expect_true(file.exists(expected))
+  expect_true(file.exists(path))
+})
+
+test_that("pdf", {
+  skip("requires pandoc and human inspection")
+  path <- create_quarto_doc("MyBook", open = FALSE)
+  on.exit(unlink("MyBook", recursive = TRUE)) # clean up
+
+  quarto::quarto_render(input = path, output_format = "html")
+  browseURL("MyBook/MyBook.html") # check format
+
+  quarto::quarto_render(input = path, output_format = "pdf")
+  browseURL("MyBook/MyBook.pdf") # check format
 })