This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Asciidoctor.
Summary
Base class for settings that are supported by both Asciidoctor and Asciidoctor PDF
- Assembly
- Cake
.Asciidoctor .dll - Namespace
- Cake
.Asciidoctor - Base Types
-
- ToolSettings
- Derived Types
graph BT
Type-->Base0["ToolSettings"]
Type["AsciidoctorSettingsBase"]
class Type type-node
Derived0["AsciidoctorPdfSettings"]-->Type
click Derived0 "/api/Cake.Asciidoctor/AsciidoctorPdfSettings"
Derived1["AsciidoctorSettings"]-->Type
click Derived1 "/api/Cake.Asciidoctor/AsciidoctorSettings"
Syntax
public abstract class AsciidoctorSettingsBase : ToolSettingsAttributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
Constructors
| Name | Summary |
|---|---|
| Asciidoctor |
Properties
| Name | Value | Summary |
|---|---|---|
| Attributes | Asciidoctor |
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)
|
| Embedded | bool |
When set to
true, generate an embeddable document which excludes content other than the document body (command line option --embedded)
|
| FailureLevel | Nullable |
The minimual log level that causes the document conversion to fail (command line option
--failure-level)
|
| LoadPaths | ICollection |
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 |
Specifies additional library to load before converting the input document (command line option
--require)
|
| SafeMode | Nullable |
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 |
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 |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|