pandoc.epub: Invoke Pandoc to Produce an Electronic Book

Description Usage Arguments Value

View source: R/epub.R

Description

Invoke Pandoc with the provided parameters.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
pandoc.epub(
  sourceFile,
  destName = sub(pattern = "\\..*", replacement = "", x = basename(sourceFile)),
  destDir = dirname(sourceFile),
  format.in = "markdown",
  standalone = TRUE,
  tabstops = 2L,
  toc.print = TRUE,
  toc.depth = 3L,
  crossref = TRUE,
  bibliography = TRUE,
  numberSections = TRUE,
  mathToGraphic = FALSE,
  metadata = NULL
)

Arguments

sourceFile

the path to the source file

destName

the base name of the destination file without extension

destDir

the destination directory

format.in

the input format

standalone

should we produce a stand-alone document?

tabstops

the number of spaces with which we replace a tab character, or NA to not replace

toc.print

print a table of contents?

toc.depth

the depth of the table of content to print

crossref

use pandoc-crossref?

bibliography

do we have a bibliography?

numberSections

should sections be numbered?

mathToGraphic

should math be converted to graphics? If TRUE, math is rendered to png images, which takes quite some time. If FALSE, then math is rendered as MathML, which should, by now, be supported by many EPUB readers. As of version 0.8.3, we stick with the latter.

metadata

the metadata

Value

the canonical path to the destination file


thomasWeise/bookbuildeR documentation built on Sept. 5, 2021, 6:31 p.m.