AsciidoctorJRevealJSTask (asciidoctor-gradle-jvm-slides 3.0.0-alpha.3 API)

org.asciidoctor.gradle.jvm.slides.AsciidoctorJRevealJSTask

All Implemented Interfaces and Traits:: org.asciidoctor.gradle.base.slides.SlidesToExportAware

@groovy.transform.CompileStatic
class AsciidoctorJRevealJSTask
extends org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask

Since:: 2.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`PLUGIN_CONFIGURATION_FILENAME`
`static String`	`PLUGIN_LIST_FILENAME`
`static String`	`REVEALJS_GEM`

Inherited fields
Fields inherited from class	Fields
`class org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask`	`IN_PROCESS, OUT_OF_PROCESS, JAVA_EXEC, __$stMC, __$stMC, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`
`class org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask`	`__$stMC, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`File`	`pluginConfigurationFile`
`Iterable<Object>`	`plugins`
`RevealJSOptions`	`revealjsOptions` Options for Reveal.JS slides.
`Object`	`templateRelativeDir`
`String`	`theme`

Constructor Summary

Constructors
Constructor and description
`AsciidoctorJRevealJSTask (WorkerExecutor we)` Injection constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`File`	`getPluginConfigurationFile()` Returns the location of the file for configuring external plugins.
	`List<String>`	`getPlugins()` Get list of activated plugins.
	`org.asciidoctor.gradle.base.slides.Profile`	`getProfile()`
	`protected CopySpec`	`getResourceCopySpec(Optional<String> lang)` Gets the CopySpec for additional resources If `resources` was never called, it will return a default CopySpec otherwise it will return the one built up via successive calls to `resources`
	`protected RevealJSExtension`	`getRevealjsExtension()`
	`protected RevealJSPluginExtension`	`getRevealsjsPluginExtension()`
	`protected Map<String, Object>`	`getTaskSpecificDefaultAttributes(File workingSourceDir)` A task may add some default attributes.
	`File`	`getTemplateDir()` The physical location of the template directory
	`String`	`getTemplateRelativeDir()` Obtains the relative location of the template directory.
	`File`	`getTemplateSourceDir()` The directory where template is read from.
	`String`	`getTheme()` Get the reveal.js theme.
	`void`	`plugins(Iterable<Object> p)` Name one or more reveal.js plugins to activate.
	`void`	`plugins(Object... p)` Name one or more reveal.js plugins to activate.
	`void`	`processAsciidocSources()`
	`protected void`	`processTemplateResources()` Processes the RevealJS template.
	`void`	`revealjsOptions(groovy.lang.Closure configurator)` Configures Reveal.js options via a Closure.
	`void`	`revealjsOptions(Action<RevealJSOptions> configurator)` Configures Reveal.js options via an Action.
	`void`	`setPluginConfigurationFile(Object f)` Sets the location of the project configuration file.
	`void`	`setPlugins(Iterable<Object> p)` Set reveal.js plugins to activate.
	`void`	`setTemplateRelativeDir(Object f)` Sets the location of the final template directory relative to the output directory.
	`void`	`setTheme(String aTheme)` Select a reveal.js theme.
	`void`	`toggleBuiltinPlugin(String name, boolean pluginState)` Toggle a built-in reveal.js plugin

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask`	org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getAttributes(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#options(java.util.Map), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#attributes(java.util.Map), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getOptions(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#access$0(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask, java.io.File, java.util.Set, java.util.Optional), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#access$1(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask, java.lang.Iterable, java.util.Optional), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#access$2(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask, java.io.File, java.util.Set, java.util.Optional), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#access$3(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask, java.lang.String, org.gradle.workers.WorkerConfiguration, org.gradle.api.file.FileCollection, org.asciidoctor.gradle.internal.ExecutorConfigurationContainer), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#pfaccess$0(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#forkOptions(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#forkOptions(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getConfigurations(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#configurations(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#configurations([Ljava.lang.Object;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setAttributes(java.util.Map), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setConfigurations(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setOptions(java.util.Map), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getAttributeProviders(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setInProcess(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setInProcess(org.asciidoctor.gradle.base.process.ProcessMode), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getInProcess(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#processAsciidocSources(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getParallelMode(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#isParallelMode(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setParallelMode(boolean), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#super$4$$getStaticMetaClass(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getProperty(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getBaseDir(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getBaseDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#invokeMethod(java.lang.String, java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getMetaClass(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setMetaClass(groovy.lang.MetaClass), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#resources(java.lang.String, org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#resources(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#resources(java.lang.String, groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#resources(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#sources(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#sources(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#sources([Ljava.lang.String;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setBaseDir(java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getOutputDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setOutputDir(java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#pfaccess$0(org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#this$dist$invoke$3(java.lang.String, java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#this$dist$set$3(java.lang.String, java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#this$dist$get$3(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getSourceFileTree(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getSourceDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#languages([Ljava.lang.String;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#languages(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setSourceDir(java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#baseDirIsRootProjectDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#baseDirIsProjectDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#baseDirFollowsSourceDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#clearSecondarySources(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#secondarySources(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#secondarySources(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getSecondarySourceFileTree(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#copyAllResources(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#copyNoResources(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#copyResourcesOnlyIf([Ljava.lang.String;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getCopyResourcesForBackends(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#useIntermediateWorkDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#withIntermediateArtifacts(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#withIntermediateArtifacts(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getIntermediateWorkDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getBackendOutputDirectories(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getLanguages(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setLanguages(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getLogDocuments(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#isLogDocuments(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setLogDocuments(boolean), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setProperty(java.lang.String, java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#toString(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#compareTo(org.gradle.api.Task), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#compareTo(java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getName(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getActions(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getState(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getState(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getPath(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getExtensions(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getDescription(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setDescription(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getDidWork(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#isEnabled(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#configure(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#configure(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#hasProperty(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getGroup(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getTaskIdentity(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setEnabled(boolean), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getAsDynamicObject(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#doFirst(java.lang.String, org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#doFirst(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#doFirst(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#onlyIf(org.gradle.api.specs.Spec), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#onlyIf(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setActions(java.util.List), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getTaskDependencies(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getTaskDependencies(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getDependsOn(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setDependsOn(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#dependsOn([Ljava.lang.Object;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setOnlyIf(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setOnlyIf(org.gradle.api.specs.Spec), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setDidWork(boolean), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#doLast(groovy.lang.Closure), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#doLast(java.lang.String, org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#doLast(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getEnabled(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getOutputs(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getOutputs(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getDestroyables(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getLocalState(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getTemporaryDir(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#mustRunAfter([Ljava.lang.Object;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setMustRunAfter(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getMustRunAfter(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#finalizedBy([Ljava.lang.Object;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setFinalizedBy(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getFinalizedBy(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#shouldRunAfter([Ljava.lang.Object;), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setShouldRunAfter(java.lang.Iterable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getShouldRunAfter(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#property(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getInputs(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getInputs(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getProject(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getIdentityPath(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getAnt(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setGroup(java.lang.String), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getStandardOutputCapture(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getConvention(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getLogging(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getLogging(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getTaskActions(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#hasTaskActions(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getOnlyIf(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getImpliesSubProjects(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#setImpliesSubProjects(boolean), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#replaceLogger(org.gradle.api.logging.Logger), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getTemporaryDirFactory(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#prependParallelSafeAction(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#appendParallelSafeAction(org.gradle.api.Action), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#isHasCustomActions(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getLogger(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getTimeout(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#wait(long, int), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#wait(long), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#wait(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#equals(java.lang.Object), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#hashCode(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#getClass(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#notify(), org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask#notifyAll()
`class org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask`	org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getProperty(java.lang.String), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getAttributes(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getBaseDir(java.lang.String), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getBaseDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#invokeMethod(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#attributes(java.util.Map), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getMetaClass(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setMetaClass(groovy.lang.MetaClass), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#resources(java.lang.String, org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#resources(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#resources(java.lang.String, groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#resources(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#sources(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#sources(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#sources([Ljava.lang.String;), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setBaseDir(java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getOutputDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setOutputDir(java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#pfaccess$0(org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setAttributes(java.util.Map), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#this$dist$invoke$3(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#this$dist$set$3(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#this$dist$get$3(java.lang.String), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getSourceFileTree(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getSourceDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getAttributeProviders(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#languages([Ljava.lang.String;), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#languages(java.lang.Iterable), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setSourceDir(java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#baseDirIsRootProjectDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#baseDirIsProjectDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#baseDirFollowsSourceDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#clearSecondarySources(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#secondarySources(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#secondarySources(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getSecondarySourceFileTree(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#copyAllResources(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#copyNoResources(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#copyResourcesOnlyIf([Ljava.lang.String;), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getCopyResourcesForBackends(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#useIntermediateWorkDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#withIntermediateArtifacts(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#withIntermediateArtifacts(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getIntermediateWorkDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getBackendOutputDirectories(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getLanguages(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setLanguages(java.lang.Iterable), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getLogDocuments(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#isLogDocuments(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setLogDocuments(boolean), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setProperty(java.lang.String, java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#toString(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#compareTo(org.gradle.api.Task), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#compareTo(java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getName(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getActions(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getState(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getState(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getPath(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getExtensions(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getDescription(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setDescription(java.lang.String), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getDidWork(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#isEnabled(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#configure(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#configure(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#hasProperty(java.lang.String), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getGroup(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getTaskIdentity(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setEnabled(boolean), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getAsDynamicObject(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#doFirst(java.lang.String, org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#doFirst(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#doFirst(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#onlyIf(org.gradle.api.specs.Spec), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#onlyIf(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setActions(java.util.List), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getTaskDependencies(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getTaskDependencies(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getDependsOn(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setDependsOn(java.lang.Iterable), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#dependsOn([Ljava.lang.Object;), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setOnlyIf(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setOnlyIf(org.gradle.api.specs.Spec), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setDidWork(boolean), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#doLast(groovy.lang.Closure), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#doLast(java.lang.String, org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#doLast(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getEnabled(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getOutputs(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getOutputs(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getDestroyables(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getLocalState(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getTemporaryDir(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#mustRunAfter([Ljava.lang.Object;), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setMustRunAfter(java.lang.Iterable), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getMustRunAfter(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#finalizedBy([Ljava.lang.Object;), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setFinalizedBy(java.lang.Iterable), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getFinalizedBy(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#shouldRunAfter([Ljava.lang.Object;), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setShouldRunAfter(java.lang.Iterable), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getShouldRunAfter(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#property(java.lang.String), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getInputs(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getInputs(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getProject(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getIdentityPath(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getAnt(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setGroup(java.lang.String), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getStandardOutputCapture(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getConvention(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getLogging(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getLogging(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getTaskActions(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#hasTaskActions(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getOnlyIf(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getImpliesSubProjects(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#setImpliesSubProjects(boolean), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#replaceLogger(org.gradle.api.logging.Logger), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getTemporaryDirFactory(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#prependParallelSafeAction(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#appendParallelSafeAction(org.gradle.api.Action), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#isHasCustomActions(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getLogger(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getTimeout(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#wait(long, int), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#wait(long), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#wait(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#equals(java.lang.Object), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#hashCode(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#getClass(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#notify(), org.asciidoctor.gradle.base.AbstractAsciidoctorBaseTask#notifyAll()

- Field Detail
  - public static final String PLUGIN_CONFIGURATION_FILENAME
  - public static final String PLUGIN_LIST_FILENAME
  - public static final String REVEALJS_GEM
- Property Detail
  - File pluginConfigurationFile
  - Iterable<Object> plugins
  - @Nested final RevealJSOptions revealjsOptions
    
    Options for Reveal.JS slides.
  - Object templateRelativeDir
  - String theme
- Constructor Detail
  - @Inject @SuppressWarnings('ClosureAsLastMethodParameter') AsciidoctorJRevealJSTask(WorkerExecutor we)
    
    Injection constructor.
    Parameters:
    we - WorkerExecutor.
- Method Detail
  - @InputFile @Optional File getPluginConfigurationFile()
    
    Returns the location of the file for configuring external plugins.
    Returns:
    Location of file. Can be null
  - @Input List<String> getPlugins()
    
    Get list of activated plugins.
    Returns:
    List of plugins that will be copied to the template.
  - @Internal @Override org.asciidoctor.gradle.base.slides.Profile getProfile()
  - @Override @SuppressWarnings('UnnecessaryPackageReference') protected CopySpec getResourceCopySpec(Optional<String> lang)
    
    Gets the CopySpec for additional resources If resources was never called, it will return a default CopySpec otherwise it will return the one built up via successive calls to resources
    Parameters:
    lang - Language to to apply to or empty for no-language support.
    Returns:
    ACopySpec. Never null.
  - @Internal protected RevealJSExtension getRevealjsExtension()
  - @Internal protected RevealJSPluginExtension getRevealsjsPluginExtension()
  - @Override protected Map<String, Object> getTaskSpecificDefaultAttributes(File workingSourceDir)
    
    A task may add some default attributes. If the user specifies any of these attributes, then those attributes will not be utilised. The default implementation will add includedir.
    Parameters:
    workingSourceDir - Directory where source files are located.
    Returns:
    A collection of default attributes.
  - @OutputDirectory File getTemplateDir()
    
    The physical location of the template directory
    Returns:
  - @Input String getTemplateRelativeDir()
    
    Obtains the relative location of the template directory. If this has not been set previously via setTemplateRelativeDir the default is reveal.js.
    Returns:
    Relative location of template directory.
  - @InputDirectory File getTemplateSourceDir()
    
    The directory where template is read from.
    Returns:
  - @Input String getTheme()
    
    Get the reveal.js theme. This is the equivalent of revealjs_theme. The default is white.
    Returns:
    Theme that will used for slides.
  - void plugins(Iterable<Object> p)
    
    Name one or more reveal.js plugins to activate. Plugins must match bundle names registered in the revealjsPlugins docExtensions. If selected plugins from a bundle is requires then they can be specified as 'bundleName/pluginName'.
    Parameters:
    p - List of plugins. Must be convertible to string.
  - void plugins(Object... p)
    
    Name one or more reveal.js plugins to activate. Plugins must match bundle names registered in the revealjsPlugins docExtensions. If selected plugins from a bundle is requires then they can be specified as 'bundleName/pluginName'.
    Parameters:
    p - List of plugins. Must be convertible to string.
  - @Override void processAsciidocSources()
  - protected void processTemplateResources()
    
    Processes the RevealJS template. Copies from getTemplateSourceDir to getTemplateDir.
  - void revealjsOptions(@groovy.lang.DelegatesTo(RevealJSOptions) groovy.lang.Closure configurator)
    
    Configures Reveal.js options via a Closure.
    Parameters:
    configurator - Configurating closure. Delegates to a RevealJSOptions object.
  - void revealjsOptions(Action<RevealJSOptions> configurator)
    
    Configures Reveal.js options via an Action.
    Parameters:
    configurator - Configurating action. Will be passed a RevealJSOptions object.
  - void setPluginConfigurationFile(Object f)
    
    Sets the location of the project configuration file.
    Parameters:
    f - Location of the configuration file
  - void setPlugins(Iterable<Object> p)
    
    Set reveal.js plugins to activate. Plugins must match bundle names registered in the revealjsPlugins docExtensions. If selected plugins from a bundle is requires then they can be specified as 'bundleName/pluginName'.
    Parameters:
    p - List of plugins. Must be convertible to string.
  - void setTemplateRelativeDir(Object f)
    
    Sets the location of the final template directory relative to the output directory. This is the equivalent of the revealjsdir attribute. This is where template ends up after initial processing, but before asciidoctor conversion starts.
    Parameters:
    f - Anything convertible to a string.
  - void setTheme(String aTheme)
    
    Select a reveal.js theme. Usually this is one on beige , black, league, night, serif, simple, sky, solarized OR white, but a custom template could have different themes.
    Parameters:
    aTheme - Theme to use. No validation is done on the theme.
  - void toggleBuiltinPlugin(String name, boolean pluginState)
    
    Toggle a built-in reveal.js plugin
    Parameters:
    name - Name of plugin
    pluginState - true enables plugin.

Summary:
Field
Property
Constructor
Method

[Groovy] Class AsciidoctorJRevealJSTask

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String PLUGIN_CONFIGURATION_FILENAME

public static final String PLUGIN_LIST_FILENAME

public static final String REVEALJS_GEM

Property Detail

File pluginConfigurationFile

Iterable<Object> plugins

@Nested final RevealJSOptions revealjsOptions

Object templateRelativeDir

String theme

Constructor Detail

@Inject @SuppressWarnings('ClosureAsLastMethodParameter') AsciidoctorJRevealJSTask(WorkerExecutor we)

Method Detail

@InputFile @Optional File getPluginConfigurationFile()

@Input List<String> getPlugins()

@Internal @Override org.asciidoctor.gradle.base.slides.Profile getProfile()

@Override @SuppressWarnings('UnnecessaryPackageReference') protected CopySpec getResourceCopySpec(Optional<String> lang)

@Internal protected RevealJSExtension getRevealjsExtension()

@Internal protected RevealJSPluginExtension getRevealsjsPluginExtension()

@Override protected Map<String, Object> getTaskSpecificDefaultAttributes(File workingSourceDir)

@OutputDirectory File getTemplateDir()

@Input String getTemplateRelativeDir()

@InputDirectory File getTemplateSourceDir()

@Input String getTheme()

void plugins(Iterable<Object> p)

void plugins(Object... p)

@Override void processAsciidocSources()

protected void processTemplateResources()

void revealjsOptions(@groovy.lang.DelegatesTo(RevealJSOptions) groovy.lang.Closure configurator)

void revealjsOptions(Action<RevealJSOptions> configurator)

void setPluginConfigurationFile(Object f)

void setPlugins(Iterable<Object> p)

void setTemplateRelativeDir(Object f)

void setTheme(String aTheme)

void toggleBuiltinPlugin(String name, boolean pluginState)