1% Generated by roxygen2: do not edit by hand 2% Please edit documentation in R/pandoc.R 3\name{pandoc_args} 4\alias{pandoc_args} 5\alias{pandoc_variable_arg} 6\alias{pandoc_include_args} 7\alias{pandoc_highlight_args} 8\alias{pandoc_latex_engine_args} 9\alias{pandoc_toc_args} 10\title{Functions for generating pandoc command line arguments} 11\usage{ 12pandoc_variable_arg(name, value) 13 14pandoc_include_args(in_header = NULL, before_body = NULL, 15 after_body = NULL) 16 17pandoc_highlight_args(highlight, default = "tango") 18 19pandoc_latex_engine_args(latex_engine) 20 21pandoc_toc_args(toc, toc_depth = 3) 22} 23\arguments{ 24\item{name}{Name of template variable to set.} 25 26\item{value}{Value of template variable (defaults to \code{true} if missing).} 27 28\item{in_header}{One or more files with content to be included in the 29header of the document.} 30 31\item{before_body}{One or more files with content to be included before 32the document body.} 33 34\item{after_body}{One or more files with content to be included after the 35document body.} 36 37\item{highlight}{The name of a pandoc syntax highlighting theme.} 38 39\item{default}{The highlighting theme to use if "default" 40is specified.} 41 42\item{latex_engine}{LaTeX engine for producing PDF output. Options are 43"pdflatex", "lualatex", and "xelatex".} 44 45\item{toc}{\code{TRUE} to include a table of contents in the output.} 46 47\item{toc_depth}{Depth of headers to include in table of contents.} 48} 49\value{ 50A character vector with pandoc command line arguments 51} 52\description{ 53Functions that assist in creating various types of pandoc command line 54arguments (e.g. for templates, table of contents, highlighting, and content 55includes) 56} 57\details{ 58Non-absolute paths for resources referenced from the 59 \code{in_header}, \code{before_body}, and \code{after_body} 60 parameters are resolved relative to the directory of the input document. 61} 62\examples{ 63\dontrun{ 64 65library(rmarkdown) 66 67pandoc_include_args(before_body = "header.htm") 68pandoc_include_args(before_body = "header.tex") 69 70pancoc_highlight_args("kate") 71 72pandoc_latex_engine_args("pdflatex") 73 74pandoc_toc_args(toc = TRUE, toc_depth = 2) 75 76} 77} 78