R/hpdf_document.R

In RLesur/weasydoc: Convert R Markdown to PDF Using HTML and CSS

# weasydoc - Convert R Markdown to PDF Using Weasyprint
# Copyright (C) 2018 Ministère de la Justice, République Française
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

#' @include hpdf_document_base.R
NULL

#' A PDF output format using CSS for Paged Media
#'
#' This is a format relying on CSS for Paged Media using an internal HTML5
#' template.
#'
#' @inheritParams html5_document
#' @inheritParams convert_html2pdf_format
#' @export
hpdf_document <- function(toc = FALSE,
                          toc_depth = 3,
                          number_sections = FALSE,
                          fig_width = 5,
                          fig_height = 4,
                          fig_retina = 8,
                          fig_caption = TRUE,
                          dev = "png",
                          dpi = 96,
                          df_print = NULL,
                          notes = c("endnotes", "footnotes"),
                          attach_code = FALSE,
                          smart = TRUE,
                          highlight = "default",
                          math_engine = "webtex_svg",
                          engine = c("weasyprint", "prince"),
                          engine_opts = NULL,
                          css = NULL,
                          includes = NULL,
                          keep_md = FALSE,
                          keep_html = FALSE,
                          self_contained = TRUE,
                          md_extensions = NULL,
                          pandoc_args = NULL) {

  if (!isTRUE(keep_html)) {
    self_contained <- TRUE
  }

  base_format <- html5_document(toc = toc,
                                toc_depth = toc_depth,
                                number_sections = number_sections,
                                fig_width = fig_width,
                                fig_height = fig_height,
                                fig_retina = fig_retina,
                                fig_caption = fig_caption,
                                dev = dev,
                                dpi = dpi,
                                df_print = df_print,
                                smart = smart,
                                highlight = highlight,
                                math_engine = math_engine,
                                css = css,
                                includes = includes,
                                keep_md = keep_md,
                                self_contained = self_contained,
                                md_extensions = md_extensions,
                                pandoc_args = pandoc_args)
  notes <- match.arg(notes)
  engine <- match.arg(engine)

  convert_html2pdf_format(engine = engine,
                          engine_opts = engine_opts,
                          attach_code = attach_code,
                          keep_html = keep_html,
                          notes = notes,
                          base_format = function() base_format)
}


#' HTML5 output format with CSS for Paged Media
#'
#' This is a basic HTML5 output format using an internal template.
#'
#' @inheritParams extd_html_document_base
#' @inheritParams rmarkdown::html_document
#' @keywords internal
#' @export
html5_document <- function(toc = FALSE,
                           toc_depth = 3,
                           number_sections = FALSE,
                           fig_width = 5,
                           fig_height = 4,
                           fig_retina = 8,
                           fig_caption = TRUE,
                           dev = "png",
                           dpi = 96,
                           df_print = NULL,
                           smart = TRUE,
                           highlight = "default",
                           math_engine = "webtex_svg",
                           css = NULL,
                           includes = NULL,
                           keep_md = FALSE,
                           self_contained = TRUE,
                           md_extensions = NULL,
                           pandoc_args = NULL) {

  section_divs <- TRUE
  template <- system.file("templates", "default", "h5default.html", package = "weasydoc")
  html_format <- "html5"

  pandoc_args <-
    c(# For number sections, we want CSS styling, not pandoc internal numbers
      if (isTRUE(number_sections)) c("-V", "number-sections-css"),
      pandoc_args
    )

  extd_html_document_base(
    toc = toc,
    toc_depth = toc_depth,
    number_sections = FALSE, # not pandoc internal numbers
    section_divs = section_divs,
    fig_width = fig_width,
    fig_height = fig_height,
    fig_retina = fig_retina,
    fig_caption = fig_caption,
    dev = dev,
    dpi = dpi,
    df_print = df_print,
    smart = smart,
    highlight = highlight,
    math_engine = math_engine,
    template = template,
    html_format = html_format,
    extra_dependencies = NULL,
    css = css,
    includes = includes,
    keep_md = keep_md,
    self_contained = self_contained,
    lib_dir = NULL,
    md_extensions = md_extensions,
    pandoc_args = pandoc_args
  )
}