PandocSettings Class

Assembly
Cake.Pandoc.dll
Namespace
Cake.Pandoc
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["PandocSettings"] class Type type-node

Syntax

public sealed class PandocSettings : ToolSettings

Constructors

Name Summary
PandocSettings()

Properties

Name Value Summary
Abbreviations string
Specifies a custom abbreviations file, with abbreviations one to a line.If this option is not specified, pandoc will read the data file abbreviations from the user data directory or fall back on a system default. To see the system default, use pandoc --print-default-data-file= abbreviations.The only use pandoc makes of this list is in the Markdown reader.Strings found in this list will be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX.The strings may not contain spaces.
BaseHeaderLevel string
Deprecated.Use --shift-heading-level-by= X instead, where X = NUMBER - 1.Specify the base level for headings (defaults to 1).
BashCompletion bool
Generate a bash completion script. To enable bash completion with pandoc, add this to your .bashrc:.
BibLaTeX bool
Use biblatex for citations in LaTeX output. This option is not for use with the --citeproc option or with PDF output. It is intended for use in producing a LaTeX file that can be processed with bibtex or biber.
Bibliography FilePath
Set the bibliography field in the document’s metadata to FILE, overriding any value set in the metadata. If you supply this argument multiple times, each FILE will be added to bibliography.If FILE is a URL, it will be fetched via HTTP. If FILE is not found relative to the working directory, it will be sought in the resource path (see --resource-path).
CitationAbbreviations FilePath
Set the citation-abbreviations field in the document’s metadata to FILE, overriding any value set in the metadata. (This is equivalent to --metadata citation-abbreviations= FILE.) If FILE is a URL, it will be fetched via HTTP.If FILE is not found relative to the working directory, it will be sought in the resource path(see --resource-path) and finally in the csl subdirectory of the pandoc user data directory.
CitationProcessing bool
Process the citations in the file, replacing them with rendered citations and adding a bibliography.Citation processing will not take place unless bibliographic data is supplied, either through an external file specified using the --bibliography option or the bibliography field in metadata, or via a references section in metadata containing a list of citations in CSL YAML format with Markdown formatting.The style is controlled by a CSL stylesheet specified using the --csl option or the csl field in metadata. (If no stylesheet is specified, the chicago-author-date style will be used by default.) The citation processing transformation may be applied before or after filters or Lua filters(see --filter, --lua-filter): these transformations are applied in the order they appear on the command line.For more information, see the section on Citations.
Csl FilePath
Set the csl field in the document’s metadata to FILE, overriding any value set in the metadata. (This is equivalent to --metadata csl = FILE.) If FILE is a URL, it will be fetched via HTTP.If FILE is not found relative to the working directory, it will be sought in the resource path(see --resource-path) and finally in the csl subdirectory of the pandoc user data directory.
DataDirectory DirectoryPath
Specify the user data directory to search for pandoc data files.If this option is not specified, the default user data directory will be used.
DefaultImageExtension string
Specify a default extension to use when image paths/URLs have no extension. This allows you to use the same source for formats that require different kinds of images.Currently this option only affects the Markdown and LaTeX readers.
Defaults FilePath
Specify a set of default option settings.
DumpArgs bool
Print information about command-line arguments to stdout, then exit.
ExtractMedia string
Extract images and other media contained in or linked from the source document to the path DIR, creating it if necessary, and adjust the images references in the document so they point to the extracted files.
FailIfWarnings bool
Exit with error status if there are any warnings.
Files FilePathCollection
FileScope bool
Parse each file individually before combining for multifile documents. This will allow footnotes in different files with the same identifiers to work as expected.If this option is set, footnotes and links will not work across files. Reading binary files (docx, odt, epub) implies --file-scope.
Filter string
Specify an executable to be used as a filter transforming the pandoc AST after the input is parsed and before the output is written.
From From
Specify input format Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name.
GladTeX bool
Enclose TeX math in 'eq' tags in HTML output. The resulting HTML can then be processed by GladTeX to produce SVG images of the typeset formulas and an HTML file with these images embedded.
Help bool
Show usage message.
IgnoreArgs bool
Ignore command-line arguments.
IndentedCodeClasse string
Specify classes to use for indented code blocks–for example, perl, numberLines or haskell.Multiple classes may be separated by spaces or commas.
KaTeX string
Use KaTeX to display embedded TeX math in HTML output.The URL is the base URL for the KaTeX library.That directory should contain a katex.min.js and a katex.min.css file. If a URL is not provided, a link to the KaTeX CDN will be inserted.
ListExtensions string
List supported extensions for FORMAT, one per line, preceded by a + or - indicating whether it is enabled by default in FORMAT.If FORMAT is not specified, defaults for pandoc’s Markdown are given.
ListHighlightLanguages bool
List supported languages for syntax highlighting, one per line.
ListHighlightStyles bool
List supported styles for syntax highlighting, one per line.
ListInputFormats bool
List supported input formats, one per line.
ListOutputFormats bool
List supported output formats, one per line.
Log string
Write log messages in machine-readable JSON format to FILE.All messages above DEBUG level will be written, regardless of verbosity settings (--verbose, --quiet).
LuaFilter string
Transform the document in a similar fashion as JSON filters(see --filter), but use pandoc’s built-in Lua filtering system.
Mathjax string
Use MathJax to display embedded TeX math in HTML output.TeX math will be put between \(...\) (for inline math) or \[...\] (for display math) and wrapped in span tags with class math. Then the MathJax JavaScript will render it.The URL should point to the MathJax.js load script.If a URL is not provided, a link to the Cloudflare CDN will be inserted.
MathMl bool
Convert TeX math to MathML (in epub3, docbook4, docbook5, jats, html4 and html5). This is the default in odt output.Note that currently only Firefox and Safari (and select e-book readers) natively support MathML.
Metadata string
Set the metadata field KEY to the value VAL.A value specified on the command line overrides a value specified in the document using YAML metadata blocks.
MetadataFile string
Read metadata from the supplied YAML(or JSON) file.This option can be used with every input format, but string scalars in the YAML file will always be parsed as Markdown.
Natbib bool
Use natbib for citations in LaTeX output.This option is not for use with the --citeproc option or with PDF output. It is intended for use in producing a LaTeX file that can be processed with bibtex.
Output FilePath
Write output to FILE instead of stdout.If FILE is -, output will go to stdout, even if a non-textual format (docx, odt, epub2, epub3) is specified.
PreserveTabs bool
Preserve tabs instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.)
Quiet bool
Suppress warning messages.
ShiftHeadingLevelB string
Shift heading levels by a positive or negative integer.For example, with --shift-heading-level-by= -1, level 2 headings become level 1 headings, and level 3 headings become level 2 headings.Headings cannot have a level less than 1, so a heading that would be shifted below level 1 becomes a regular paragraph. Exception: with a shift of -N, a level-N heading at the beginning of the document replaces the metadata title. --shift-heading-level-by= -1 is a good choice when converting HTML or Markdown documents that use an initial level-1 heading for the document title and level-2+ headings for sections. --shift-heading-level-by= 1 may be a good choice for converting Markdown documents that use level-1 headings for sections to HTML, since pandoc uses a level-1 heading to render the document title.
StripEmptyParagraphs bool
Deprecated.Use the +empty_paragraphs extension instead.Ignore paragraphs with no content.This option is useful for converting word processing documents where users have used empty paragraphs to create inter-paragraph space.
TabStop string
Specify the number of spaces per tab (default is 4).
To To
Specify output format Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name.
Trace bool
Print diagnostic output tracing parser progress to stderr.This option is intended for use by developers in diagnosing performance issues.
TrackChanges string
Specifies what to do with insertions, deletions, and comments produced by the MS Word “Track Changes” feature. accept (the default) processes all the insertions and deletions.
Verbose bool
Give verbose debugging output.
Version bool
Print version.
WebTeX string
Convert TeX formulas to img tags that link to an external script that converts formulas to images.The formula will be URL-encoded and concatenated with the URL provided.For SVG images you can for example use --webtex https://latex.codecogs.com/svg.latex?. If no URL is specified, the CodeCogs URL generating PNGs will be used (https://latex.codecogs.com/png.latex?). Note: the --webtex option will affect Markdown output as well as HTML, which is useful if you’re targeting a version of Markdown without native math support.

Methods

Extension Methods

Name Value Summary
Dump<PandocSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PandocSettings>(PandocSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PandocSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<PandocSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<PandocSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<PandocSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin