Summary
- Assembly
- Cake
.AsciiDoctorJ .dll - Namespace
- Cake
.AsciiDoctorJ - Base Types
-
- ToolSettings
Syntax
public class AsciiDoctorJRunnerSettings : ToolSettings
Attributes
Type | Description |
---|---|
Nullable |
|
NullableAttribute |
Constructors
Name | Summary |
---|---|
Ascii |
Initializes a new instance of the AsciiDoctorJRunnerSettings class.
|
Properties
Name | Value | Summary |
---|---|---|
Attributes | IDictionary |
Gets the list of attributes to set on the document.
Default: []. corresponds to: -a, --attribute. |
Backend | string |
Gets or sets a value indicating whether to
set output format backend.
Default: html5. corresponds to: -b, --backend. |
BaseDir | DirectoryPath |
Gets or sets a value indicating the
base directory containing the document and resources.
Default: directory of source file. corresponds to: -B, --base-dir. |
ClassPath | IList |
Gets the list of directories to add to the classpath.
corresponds to: -cp, -classpath, --classpath. |
Compact | bool |
Gets or sets a value indicating whether to
compact the output by removing blank lines.
Default: false. corresponds to: -C, --compact. |
DestinationDir | DirectoryPath |
Gets or sets a value indicating the
destination output directory.
Default: Directory of source file. corresponds to: -D, --destination-dir. |
DocType | Nullable |
Gets or sets a value indicating the
document type to use when rendering output: [article, book, inline].
Default: article. corresponds to: -d, --doctype. |
ERuby | Nullable |
Gets or sets a value to
specify eRuby implementation to render built-in templates: [erb, erubis].
Default: erb. corresponds to: -e, --eruby. |
InputFiles | IList |
Gets the list of input files to be processed.
|
LoadPath | IList |
Gets the list of directories to add to the $LOAD_PATH.
corresponds to: -I, --load-path. |
Output | FilePath |
Gets or sets a value indicating the
output file(default: based on input file path); use - to output to STDOUT.
corresponds to: -o, --out-file. |
Quiet | bool |
Gets or sets a value indicating whether to
suppress warnings.
Default: false. corresponds to: -q, --quiet. |
Require | IList |
Gets or sets a value indicating whether to
require the specified library before executing the processor.
corresponds to: -r, --require. |
SafeMode | Nullable |
Gets or sets a value to
set safe mode level explicitly: [unsafe, safe, server, secure].
Default: UNSAFE. corresponds to: -S, --safe-mode. |
SectionNumbers | bool |
Gets or sets a value indicating whether to
auto-number section titles in the HTML backend.
Default: false. corresponds to: -n, --section-numbers. |
Suppress |
bool |
Gets or sets a value indicating whether to
suppress output of header and footer.
Default: false. corresponds to: -s, --no-header-footer. |
TemplateDir | DirectoryPath |
Gets or sets a value indicating the
directory containing custom render templates the override the built-in set.
corresponds to: -T, --template-dir. |
TemplateEngine | string |
Gets or sets a value indicating the
template engine to use for the custom render templates (loads gem on demand).
corresponds to: -E, --template-engine. |
TimingsMode | bool |
Gets or sets a value indicating whether to
enable timings mode.
Default: false. corresponds to: -t, --timings. |
Verbose | bool |
Gets or sets a value indicating whether to
enable verbose mode.
Default: false. corresponds to: -v, --verbose. |
Version | bool |
Gets or sets a value indicating whether to
display the version and runtime environment.
Default: false. corresponds to: -V, --version. |
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 |
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
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|
WithAttribute |
Ascii |
Add multiple attributes to
Attributes .
Requires the Cake.AsciiDoctorJ addin
|
WithAttributes |
Ascii |
Add one attribute to
Attributes .
Requires the Cake.AsciiDoctorJ addin
|
WithBackend |
Ascii |
Set the
Backend
Use this only if you need a non-builtin backend (e.g. "pdf")
For builtin backends use WithBuiltinBackend(AsciiDoctorJRunnerSettings, BuiltinBackend) .
Requires the Cake.AsciiDoctorJ addin
|
WithBaseDir |
Ascii |
Sets the
BaseDir .
Requires the Cake.AsciiDoctorJ addin
|
WithBuiltinBackend |
Ascii |
Set the
Backend to a builtin backend.
Possible values are BuiltinBackend .
For non-builtin backends (i.e. plugins) use WithBackend(AsciiDoctorJRunnerSettings, string) .
Requires the Cake.AsciiDoctorJ addin
|
WithClassPath |
Ascii |
Add one path to
ClassPath .
Requires the Cake.AsciiDoctorJ addin
|
WithClassPaths |
Ascii |
Add multiple paths to
ClassPath .
Requires the Cake.AsciiDoctorJ addin
|
WithCompact |
Ascii |
Sets
Compact to true.
Requires the Cake.AsciiDoctorJ addin
|
WithDestinationDir |
Ascii |
Sets the
DestinationDir .
Requires the Cake.AsciiDoctorJ addin
|
WithDocType |
Ascii |
Requires the Cake.AsciiDoctorJ addin
|
WithERuby |
Ascii |
Requires the Cake.AsciiDoctorJ addin
|
WithInputFile |
Ascii |
Add a single File to
InputFiles .
Requires the Cake.AsciiDoctorJ addin
|
WithInputFiles |
Ascii |
Add a list of files to
InputFiles .
Requires the Cake.AsciiDoctorJ addin
|
WithLoadPath |
Ascii |
Adds one path to
LoadPath .
Requires the Cake.AsciiDoctorJ addin
|
WithLoadPaths |
Ascii |
Adds multiple paths to
LoadPath .
Requires the Cake.AsciiDoctorJ addin
|
WithOutputFile |
Ascii |
Set the
Output .
Requires the Cake.AsciiDoctorJ addin
|
WithQuiet |
Ascii |
Set
Quiet to true.
Requires the Cake.AsciiDoctorJ addin
|
WithRequire |
Ascii |
Set
Require to true.
Requires the Cake.AsciiDoctorJ addin
|
WithSafeMode |
Ascii |
Requires the Cake.AsciiDoctorJ addin
|
WithSectionNumbers |
Ascii |
Set
SectionNumbers to true.
Requires the Cake.AsciiDoctorJ addin
|
With |
Ascii |
Set
SuppressHeaderAndFooter to true.
Requires the Cake.AsciiDoctorJ addin
|
WithTemplateDir |
Ascii |
Set the
TemplateDir .
Requires the Cake.AsciiDoctorJ addin
|
WithTemplateEngine |
Ascii |
Set the
TemplateEngine .
Requires the Cake.AsciiDoctorJ addin
|
WithTimingsMode |
Ascii |
set
TimingsMode to true.
Requires the Cake.AsciiDoctorJ addin
|
WithVerbose |
Ascii |
set
Verbose to true.
Requires the Cake.AsciiDoctorJ addin
|
WithVersion |
Ascii |
Set
Version to true.
Requires the Cake.AsciiDoctorJ addin
|