AsciidoctorTask (asciidoctor-gradle-jvm 4.0.2 API)

Summary:
Constructor
Method

| Detail:
Constructor
Method

org.asciidoctor.gradle.jvm.AsciidoctorTask

```
@SuppressWarnings(value: [MethodCount, Instanceof])
@groovy.transform.CompileStatic
@CacheableTask
class AsciidoctorTask
extends AbstractAsciidoctorTask
```
Standard generic task for converting Asciidoctor documents. For convention and cmopatibility with older releases of this pugin, the default source directory is "src/docs/asciidoc" if the task is named aciidoctor. For all other instances of this task type the default source directory is "src/docs/${task.name.capitalize()"}. In a similar fasion the default output directory is either "${buildDir/asciidoc"} or "${buildDir/asciidoc${task.name.capitalize()}"}.
Authors:
Noam Tenne
Andres Almiray
Tom Bujok
Lukasz Pielak
Dmitri Vyazelenko
Benjamin Muschko
Dan Allen
Rob Winch
Stefan Schlott
Stephan Classen
Marcus Fihlon
Schalk W. Cronjé
Robert Panzer
Gary Hale

Inherited fields
Fields inherited from class	Fields
`class AbstractAsciidoctorTask`	`CLASSPATH, ERROR, FATAL, INFO, IN_PROCESS, JAVA_EXEC, OUT_OF_PROCESS, WARN`

Constructor Summary

Constructors
Constructor and description
`AsciidoctorTask (WorkerExecutor we)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exec()`
	`PatternSet`	`getDefaultSecondarySourceDocumentPattern()` The default pattern set for secondary sources baced upon the configured backends.
	`void`	`outputOptions(groovy.lang.Closure cfg)` Configures output options for this task.
	`void`	`outputOptions(Action<org.asciidoctor.gradle.base.OutputOptions> cfg)` Configures output options for this task.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractAsciidoctorTask`	`attributes, configurations, configurations, exec, forkOptions, forkOptions, getAttributeProviders, getAttributes, getConfigurations, getFailureLevel, getOptions, getReportableConfigurations, options, setAttributes, setConfigurations, setExecutionMode, setExecutionMode, setFailureLevel, setFailureLevel, setInProcess, setInProcess, setOptions, withGemJar, withGemJar, withGemPath`

- Constructor Detail
  - @Inject AsciidoctorTask(WorkerExecutor we)
- Method Detail
  - @Override void exec()
  - @Override PatternSet getDefaultSecondarySourceDocumentPattern()
    
    The default pattern set for secondary sources baced upon the configured backends. If the backends contain docbook then *docbook*.xml is added. If the backend contain html5 then *docbook*.html is added.
    Returns:
    Default pattern set.
  - void outputOptions(@groovy.lang.DelegatesTo(value: OutputOptions) groovy.lang.Closure cfg)
    
    Configures output options for this task.
    Parameters:
    cfg - Closure which will delegate to a org.asciidoctor.gradle.base.OutputOptions instance.
  - void outputOptions(Action<org.asciidoctor.gradle.base.OutputOptions> cfg)
    
    Configures output options for this task.
    Parameters:
    cfg - Action which will be passed an instances of org.asciidoctor.gradle.base.OutputOptions to configure.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Copyright © 2013-2024 the original author or authors. All rights reserved.