AsciidoctorPdfSettings Class

Summary

Optional settings for Asciidoctor PDF
Assembly
Cake.Asciidoctor.dll
Namespace
Cake.Asciidoctor
Base Types
graph BT Type-->Base0["AsciidoctorSettingsBase"] click Base0 "/api/Cake.Asciidoctor/AsciidoctorSettingsBase" Base0-->Base1["ToolSettings"] Type["AsciidoctorPdfSettings"] class Type type-node

Syntax

public class AsciidoctorPdfSettings : AsciidoctorSettingsBase

Constructors

Name Summary
AsciidoctorPdfSettings()

Properties

Name Value Summary
Attributes AsciidoctorAttributeCollection
The attributes to set, override or unset when converting documents (command line option --attribute)
BaseDirectory DirectoryPath
The base directory containing the input document and resources (command line option --base-dir)
DestinationDirectory DirectoryPath
The output directory for converted documents (command line option --destination-dir)
Doctype Nullable<AsciidoctorPdfDoctype>
The document type to use for converting AsciiDoc documents (command line option --doctype)
Embedded bool
When set to true, generate an embeddable document which excludes content other than the document body (command line option --embedded)
FailureLevel Nullable<AsciidoctorFailureLevel>
The minimual log level that causes the document conversion to fail (command line option --failure-level)
LoadPaths ICollection<DirectoryPath>
Specifies additional path where extensions can be loaded from (command line option --load-path)
OutFile FilePath
The outpath for the converted docments (command line option --out-file)
Quiet bool
When set to true, disables log messages (command line option --quiet)
Require ICollection<string>
Specifies additional library to load before converting the input document (command line option --require)
SafeMode Nullable<AsciidoctorSafeMode>
The "safe mode" to use when converting documents (command line option --safe-mode)
SectionNumbers bool
When set to true, enables automatic numbering of sections (command line option --section-numbers).
SourceDirectory DirectoryPath
The path of the source directory (command line option --source-dir)
TemplateDirectories ICollection<DirectoryPath>
Specifies the paths of directories containing custom converted templates (command line option --template-dir)
Timings bool
When set to true, prints out a timing report (command line option --timings)
Trace bool
When set to true, includes additional information when logging errors in the console output (command line option --trace)
Verbose bool
When set to true, includes INFO and DEBUF messages in the log output (command line option --verbose)
Warnings bool
When set to true, enables script warnings (command line option --warnings)

Extension Methods

Name Value Summary
Dump<AsciidoctorPdfSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AsciidoctorPdfSettings>(AsciidoctorPdfSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AsciidoctorPdfSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AsciidoctorPdfSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AsciidoctorPdfSettings>(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<AsciidoctorPdfSettings>(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

See Also