R/html_e2m.R
In sigbertklinke/exams2moodle: Access routines to XML Moodle files and helper routines to simplify generating exercises for Moodle from the 'exams' package
Defines functions
html_e2m
Documented in
html_e2m
#' @title html_e2m
#' @description Creates an HTML page with all the contents of XML tags whose names match \code{pattern}.\cr\cr
#' The default is to show the contents of all XML tags. The HTML page is stored in the HTML file \code{name}.\cr\cr
#' The default \code{name=NULL} creates a temporary file. If the name does not end in code{.html}, then a \code{.html} is appended.
#'
#' If \code{browseURL=TRUE} (default) then the HTML page will be displayed in the browser.
#'
#' If necessary the contents of XML tags are concatenated with \code{"\n"}.
#' For single XML tags this can be changed, e.g. \code{merge=list("questionlist"="<br>"} leads to the fact that for the XML tag
#' \code{<questionlist>...</questionlist>)} \code{"<br>"} is used instead of \code{"\n"}.
#' @seealso The aim is similar to \code{exams:::exams:::browse_exercise}, but \code{html_e2m} takes the information form
#' the XML file generated by the \code{exams2moodle}.
#'
#' @param exam list: return list from \code{exam2moodle}
#' @param name character: name of HTML file (default: \code{NULL})
#' @param pattern character: string containing a regular expression to match list elements (default: \code{.})
#' @param mathjax logical: should MathJax be loaded (default: \code{TRUE})
#' @param browseURL logical: should the generated HTML shown (default: \code{TRUE})
#' @param overwrite logical: should the HTML file overwritten, if it exists (default: \code{FALSE})
#' @param header integer: at which level of the list a \code{<h2>...</h2>} element should be included (default: \code{2})
#' @param merge list: should elements with \code{.XXXXnn} at the end merged (default: \code{list('questionlist'="<br>")})
#' @param png logical: if a entry ends with \code{.png} then the function will try to embed the PNG in the output
#'
#' @return invisibly the names of list elements in the HTML file
#' @importFrom utils browseURL
#' @importFrom base64enc base64encode
#' @export
#'
#' @examples
#' if (interactive()) {
#' resexams <- readRDS(system.file("xml", "klausur-test.rds", package="exams.moodle"))
#' html_e2m(resexams) # opens HTML file into browser
#' }
html_e2m <- function(exam, name=NULL, pattern=".", mathjax=TRUE, browseURL=TRUE, overwrite=FALSE,
header=2, merge=list('questionlist'="<br>"), png=TRUE) {
if (is.null(name)) name <- tempfile()
if (!endsWith(name, ".html")) name <- paste0(name, ".html")
lst <- unlist(exam)
nlst <- names(lst)
if (!is.null(merge)) {
nlst <- gsub('[0-9]+$', '', nlst)
index <- structure(1:length(nlst), names=nlst)
plst <- names(merge)
lst <- tapply(index, nlst, function(ind) {
if (length(ind)<2) return(lst[ind])
for (i in 1:length(plst)) {
if (grepl(plst[i], nlst[ind[1]])) {
return(paste0(lst[ind], collapse=merge[[i]]))
}
}
paste0(lst[ind], collapse="\n")
})
nlst <- names(lst)
}
elem <- grepl(pattern, nlst)
stopifnot(sum(elem)>0)
lst <- lst[elem]
nlst <- names(lst)
slst <- strsplit(nlst, '.', fixed=TRUE)
# create html
ret <- '<!DOCTYPE html><html><head>'
if (mathjax) {
ret <- c(ret, '<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>')
}
ret <- c(ret, '</head><body>')
if (header>0) lastheader <- rep('', header)
for (i in 1:length(lst)) {
if (header>0) {
if (any(lastheader!=slst[[i]][1:header])) {
if (i>1) ret <- c(ret, "</table>")
lastheader <- slst[[i]][1:header]
ret <- c(ret, sprintf('<h2>%s</h2>', paste(lastheader, collapse=" ")))
ret <- c(ret, '<table width="100%">')
}
}
img <- ''
if (png && !is.na(lst[i]) && endsWith(lst[i], ".png")) {
if (file.exists(lst[i])) img <- sprintf('<br><img src="data:image/png;base64,%s"></body>', base64encode(lst[i]))
}
ret <- c(ret, sprintf('<tr><td><div id="%s" width="100%%">%s%s</div></td>', nlst[i], lst[i], img))
if (header>0) slst[[i]] <- slst[[i]][-(1:header)]
ret <- c(ret, sprintf('<td style="text-align:right;background-color: grey;">%s</td></tr>',
paste0(slst[[i]], collapse=" "))
)
}
ret <- c(ret, "</table></body></html>")
if (all(!endsWith(name, c(".html", ".htm")))) name <- paste0(name, '_xml.html')
if (!file.exists(name) | overwrite) {
writeLines(ret, name)
if (browseURL) browseURL(name)
}
invisible(nlst)
}
sigbertklinke/exams2moodle documentation built on July 6, 2023, 3:26 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions html_e2m
Documented in html_e2m
#' @title html_e2m
#' @description Creates an HTML page with all the contents of XML tags whose names match \code{pattern}.\cr\cr
#' The default is to show the contents of all XML tags. The HTML page is stored in the HTML file \code{name}.\cr\cr
#' The default \code{name=NULL} creates a temporary file. If the name does not end in code{.html}, then a \code{.html} is appended.
#'
#' If \code{browseURL=TRUE} (default) then the HTML page will be displayed in the browser.
#'
#' If necessary the contents of XML tags are concatenated with \code{"\n"}.
#' For single XML tags this can be changed, e.g. \code{merge=list("questionlist"="<br>"} leads to the fact that for the XML tag
#' \code{<questionlist>...</questionlist>)} \code{"<br>"} is used instead of \code{"\n"}.
#' @seealso The aim is similar to \code{exams:::exams:::browse_exercise}, but \code{html_e2m} takes the information form
#' the XML file generated by the \code{exams2moodle}.
#'
#' @param exam list: return list from \code{exam2moodle}
#' @param name character: name of HTML file (default: \code{NULL})
#' @param pattern character: string containing a regular expression to match list elements (default: \code{.})
#' @param mathjax logical: should MathJax be loaded (default: \code{TRUE})
#' @param browseURL logical: should the generated HTML shown (default: \code{TRUE})
#' @param overwrite logical: should the HTML file overwritten, if it exists (default: \code{FALSE})
#' @param header integer: at which level of the list a \code{<h2>...</h2>} element should be included (default: \code{2})
#' @param merge list: should elements with \code{.XXXXnn} at the end merged (default: \code{list('questionlist'="<br>")})
#' @param png logical: if a entry ends with \code{.png} then the function will try to embed the PNG in the output
#'
#' @return invisibly the names of list elements in the HTML file
#' @importFrom utils browseURL
#' @importFrom base64enc base64encode
#' @export
#'
#' @examples
#' if (interactive()) {
#' resexams <- readRDS(system.file("xml", "klausur-test.rds", package="exams.moodle"))
#' html_e2m(resexams) # opens HTML file into browser
#' }
html_e2m <- function(exam, name=NULL, pattern=".", mathjax=TRUE, browseURL=TRUE, overwrite=FALSE,
header=2, merge=list('questionlist'="<br>"), png=TRUE) {
if (is.null(name)) name <- tempfile()
if (!endsWith(name, ".html")) name <- paste0(name, ".html")
lst <- unlist(exam)
nlst <- names(lst)
if (!is.null(merge)) {
nlst <- gsub('[0-9]+$', '', nlst)
index <- structure(1:length(nlst), names=nlst)
plst <- names(merge)
lst <- tapply(index, nlst, function(ind) {
if (length(ind)<2) return(lst[ind])
for (i in 1:length(plst)) {
if (grepl(plst[i], nlst[ind[1]])) {
return(paste0(lst[ind], collapse=merge[[i]]))
}
}
paste0(lst[ind], collapse="\n")
})
nlst <- names(lst)
}
elem <- grepl(pattern, nlst)
stopifnot(sum(elem)>0)
lst <- lst[elem]
nlst <- names(lst)
slst <- strsplit(nlst, '.', fixed=TRUE)
# create html
ret <- '<!DOCTYPE html><html><head>'
if (mathjax) {
ret <- c(ret, '<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>')
}
ret <- c(ret, '</head><body>')
if (header>0) lastheader <- rep('', header)
for (i in 1:length(lst)) {
if (header>0) {
if (any(lastheader!=slst[[i]][1:header])) {
if (i>1) ret <- c(ret, "</table>")
lastheader <- slst[[i]][1:header]
ret <- c(ret, sprintf('<h2>%s</h2>', paste(lastheader, collapse=" ")))
ret <- c(ret, '<table width="100%">')
}
}
img <- ''
if (png && !is.na(lst[i]) && endsWith(lst[i], ".png")) {
if (file.exists(lst[i])) img <- sprintf('<br><img src="data:image/png;base64,%s"></body>', base64encode(lst[i]))
}
ret <- c(ret, sprintf('<tr><td><div id="%s" width="100%%">%s%s</div></td>', nlst[i], lst[i], img))
if (header>0) slst[[i]] <- slst[[i]][-(1:header)]
ret <- c(ret, sprintf('<td style="text-align:right;background-color: grey;">%s</td></tr>',
paste0(slst[[i]], collapse=" "))
)
}
ret <- c(ret, "</table></body></html>")
if (all(!endsWith(name, c(".html", ".htm")))) name <- paste0(name, '_xml.html')
if (!file.exists(name) | overwrite) {
writeLines(ret, name)
if (browseURL) browseURL(name)
}
invisible(nlst)
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.