AsciiDoctorJRunnerSettingsExtensions Class

Summary

Extensions for fluent writing of AsciiDoctorJRunnerSettings.
Assembly
Cake.AsciiDoctorJ.dll
Namespace
Cake.AsciiDoctorJ
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["AsciiDoctorJRunnerSettingsExtensions"] class Type type-node

Syntax

public static class AsciiDoctorJRunnerSettingsExtensions

Methods

Name Value Summary
WithAttribute(AsciiDoctorJRunnerSettings, string, string) AsciiDoctorJRunnerSettings
Add multiple attributes to Attributes.
static
WithAttributes(AsciiDoctorJRunnerSettings, IEnumerable<KeyValuePair<string, string>>) AsciiDoctorJRunnerSettings
Add one attribute to Attributes.
static
WithBackend(AsciiDoctorJRunnerSettings, string) AsciiDoctorJRunnerSettings
Set the Backend Use this only if you need a non-builtin backend (e.g. "pdf") For builtin backends use WithBuiltinBackend(AsciiDoctorJRunnerSettings, BuiltinBackend).
static
WithBaseDir(AsciiDoctorJRunnerSettings, DirectoryPath) AsciiDoctorJRunnerSettings
Sets the BaseDir.
static
WithBuiltinBackend(AsciiDoctorJRunnerSettings, BuiltinBackend) AsciiDoctorJRunnerSettings
Set the Backend to a builtin backend. Possible values are BuiltinBackend. For non-builtin backends (i.e. plugins) use WithBackend(AsciiDoctorJRunnerSettings, string).
static
WithClassPath(AsciiDoctorJRunnerSettings, DirectoryPath) AsciiDoctorJRunnerSettings
Add one path to ClassPath.
static
WithClassPaths(AsciiDoctorJRunnerSettings, IEnumerable<DirectoryPath>) AsciiDoctorJRunnerSettings
Add multiple paths to ClassPath.
static
WithCompact(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
Sets Compact to true.
static
WithDestinationDir(AsciiDoctorJRunnerSettings, DirectoryPath) AsciiDoctorJRunnerSettings
Sets the DestinationDir.
static
WithDocType(AsciiDoctorJRunnerSettings, DocType) AsciiDoctorJRunnerSettings
Sets the DocType Possible Values DocType.
static
WithERuby(AsciiDoctorJRunnerSettings, ERuby) AsciiDoctorJRunnerSettings
Sets ERuby Possible values ERuby.
static
WithInputFile(AsciiDoctorJRunnerSettings, FilePath) AsciiDoctorJRunnerSettings
Add a single File to InputFiles.
static
WithInputFiles(AsciiDoctorJRunnerSettings, IEnumerable<FilePath>) AsciiDoctorJRunnerSettings
Add a list of files to InputFiles.
static
WithLoadPath(AsciiDoctorJRunnerSettings, DirectoryPath) AsciiDoctorJRunnerSettings
Adds one path to LoadPath.
static
WithLoadPaths(AsciiDoctorJRunnerSettings, IEnumerable<DirectoryPath>) AsciiDoctorJRunnerSettings
Adds multiple paths to LoadPath.
static
WithOutputFile(AsciiDoctorJRunnerSettings, FilePath) AsciiDoctorJRunnerSettings
Set the Output.
static
WithQuiet(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
Set Quiet to true.
static
WithRequire(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
Set Require to true.
static
WithSafeMode(AsciiDoctorJRunnerSettings, SafeMode) AsciiDoctorJRunnerSettings
Set SafeMode For possible values SafeMode.
static
WithSectionNumbers(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
Set SectionNumbers to true.
static
WithSuppressHeaderAndFooter(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
static
WithTemplateDir(AsciiDoctorJRunnerSettings, DirectoryPath) AsciiDoctorJRunnerSettings
Set the TemplateDir.
static
WithTemplateEngine(AsciiDoctorJRunnerSettings, string) AsciiDoctorJRunnerSettings
Set the TemplateEngine.
static
WithTimingsMode(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
set TimingsMode to true.
static
WithVerbose(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
set Verbose to true.
static
WithVersion(AsciiDoctorJRunnerSettings) AsciiDoctorJRunnerSettings
Set Version to true.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin