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
BashCompletion bool
Generate a bash completion script. To enable bash completion with pandoc, add this to your .bashrc:
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.
Defaults FilePath
Specify a set of default option settings.
FailIfWarnings bool
Exit with error status if there are any warnings.
Files FilePathCollection
From From
Specify input format Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name
Help bool
Show usage message.
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).
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.
Quiet bool
Suppress warning messages.
To To
Specify output format Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name
Verbose bool
Give verbose debugging output.
Version bool
Print version.

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) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator 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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin