Index (asciidoctor-gradle-base 5.0.2 API)

A B C G H I L O P R S U V W

A

AbstractDownloadableComponent<ComponentSrc,ResolvedComponent> - Class in org.asciidoctor.gradle.base: Base class for building extension which can allows styles and themes to be added to various Asciidoctor backends that may require them.
AbstractDownloadableComponent(Project) - Constructor for class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Protected c-tor.
AsciidoctorAttributeProvider - Interface in org.asciidoctor.gradle.base: A provider of Asciidoctor attributes.
AsciidoctorModuleDefinition - Interface in org.asciidoctor.gradle.base: Describes a converter.
AsciidoctorTaskAttributes - Interface in org.asciidoctor.gradle.base: The attribute methods all Asciidoctor conversion tasks will offer.
AsciidoctorTaskBaseDirConfiguration - Interface in org.asciidoctor.gradle.base: Asciidoctor base directories need special care and those methods are specified by this interface.
AsciidoctorTaskFileOperations - Interface in org.asciidoctor.gradle.base: The standard methods all Asciidoctor conversion tasks will offer.
AsciidoctorTaskMethods - Interface in org.asciidoctor.gradle.base: Methods that an ASciidoctor conversion task should implement.
AsciidoctorTaskOutputOptions - Interface in org.asciidoctor.gradle.base: Asciidoctor conversion output options.
AsciidoctorTaskReportableConfigurations - Interface in org.asciidoctor.gradle.base
AsciidoctorTaskTreeOperations - Interface in org.asciidoctor.gradle.base: Additional operations on the source and destinations trees for Asciidoctor conversions.
AsciidoctorTaskWorkspacePreparation - Interface in org.asciidoctor.gradle.base: Methods for preparing an Asciidoctor worksapce prior to conversion.
attributes(Map<String, Object>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskAttributes: Shortcut method to add additional asciidoctor attributes.

B

backends() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: The current set of configured Asciidoctor backends.
baseDirFollowsSourceDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: The base dir will be the same as the source directory.
baseDirFollowsSourceFile() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Sets the basedir to be the same directory as each individual source file.
baseDirIsProjectDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Sets the basedir to be the same directory as the current project directory.
baseDirIsRootProjectDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Sets the basedir to be the same directory as the root project directory.

C

checkForIncompatiblePathRoots(BaseDirStrategy) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: Validates that the path roots are sane.
checkForInvalidSourceDocuments() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: Validates the source tree
clearSecondarySources() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Clears any of the existing secondary soruces patterns.
clearSources() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Clears existing sources patterns.
convertible(String, AbstractCloudGit) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Creates a closure that can convert from a GitLab/GitHub repository to a local cached file.
convertible(ComponentSrc) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Create a closure that will convert an instance of a ComponentSrc into a ResolvedComponent.
copyAllResources() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Copies all resources to the output directory.
copyNoResources() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Do not copy any resources to the output directory.
copyResourcesByBackend(String, File, File, Optional<String>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Copy resources for a backend name.
copyResourcesOnlyIf(String...) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Copy resources to the output directory only if the backend names matches any of the specified names.

G

getAttributeProviders() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskAttributes: Shortcut method to access additional providers of attributes.
getAttributes() - Method in interface org.asciidoctor.gradle.base.AsciidoctorAttributeProvider: Map of (potentially unresolved) Asciidoctor attributes.
getAttributes() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskAttributes: Shortcut method for obtaining attributes.
getBackendOutputDirectories() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns a list of all output directories by backend.
getBackendOutputDirectories() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Returns a list of all output directories by backend
getBaseDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Base directory (current working directory) for a conversion.
getBaseDir(String) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Base directory (current working directory) for a conversion.
getBaseDirProvider() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Provider of the base directory.
getBaseDirStrategy() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Returns the current basedir strategy if it has been configured.
getByName(String) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Retrieve a component by name.
getCopyResourcesForBackends() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: List of backends for which to copy resources.
getDeckTapeShortName() - Method in enum org.asciidoctor.gradle.base.slides.Profile: Get name for usage within Decktape.
getDefaultResourceCopySpec(Optional<String>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: The default CopySpec that will be used if resources was never called By default, anything below $sourceDir/images will be included.
getDefaultSecondarySourceDocumentPattern() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: The default pattern set for secondary sources.
getDefaultSourceDocumentPattern() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: The default PatternSet that will be used if sources was never called
getEngineName() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: The name of the Asciidoctor engine implementation.
getIntermediateArtifactPatternProvider() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: A provider of patterns identifying intermediate artifacts.
getIntermediateWorkDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: The directory that will be the intermediate directory should one be required.
getIntermediateWorkDirProvider() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations
getLanguageResourceCopySpec(String) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns the copy specification for the resources of a specific language.
getLanguages() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Obtain List of languages the sources documents are written in.
getLanguageSecondarySourceFileTree(String) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: Gets the language-specific secondary source tree.
getLanguageSourceFileTree(String) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: Gets the language-specific source tree
getLogDocuments() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Logs documents as they are converted
getName() - Method in enum org.asciidoctor.gradle.base.slides.Profile: Profile name
getOutputDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns the current toplevel output directory
getOutputDirForBackend(String) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Get the output directory for a specific backend.
getOutputDirForBackend(String, String) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Get the output directory for a specific backend.
getOutputDirProperty() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns the current toplevel output directory as a property object.
getOutputOptions() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskOutputOptions: Access to the underlying OutputOptions.
getProfile() - Method in interface org.asciidoctor.gradle.base.slides.SlidesToExportAware: Slides profile
getProfileShortName() - Method in enum org.asciidoctor.gradle.base.slides.Profile: Get short name of profile.
getReportableConfigurations() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskReportableConfigurations: Configurations for which dependencies should be reported.
getResourceCopySpec(Optional<String>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Gets the CopySpec for additional resources.
getSecondarySourceFileTree() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns a FileTree containing all secondary source documents.
getSecondarySourceFileTreeFrom(File) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: Obtains a secondary source tree based on patterns.
getSourceDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns the parent directory for Asciidoctor source.
getSourceDirProperty() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns the parent directory for Asciidoctor source as a property object.
getSourceFileTree() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Returns a FileTree containing all source documents If a filter with AsciidoctorTaskFileOperations.sources(groovy.lang.Closure<?>) was never set then all asciidoc source files below AsciidoctorTaskFileOperations.setSourceDir(java.lang.Object) will be included.
getSourceFileTreeFrom(File) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskTreeOperations: Obtains a source tree based on patterns.
getTaskSpecificDefaultAttributes(File) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: A task may add some default attributes.
getVersion() - Method in interface org.asciidoctor.gradle.base.AsciidoctorModuleDefinition: Version of the component
github(String, Action<AscGitHubArchive>) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Use a GitHub repository as a theme.
gitlab(String, Closure<?>) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Use a GitLab repository as a theme.
gitlab(String, Action<AscGitLabArchive>) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Use a GitLab repository as a theme.

H

hasIntermediateWorkDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Checks whether an intermediate workdir is required.

I

instantiateComponentSource(String) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Instantiates a component of type ComponentSrc.
instantiateResolvedComponent(String, File) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Instantiates a resolved component.
isBaseDirConfigured() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Checks whether an explicit strategy has been set for base directory.
isDefined() - Method in interface org.asciidoctor.gradle.base.AsciidoctorModuleDefinition: Whether the component has been allocated a version.

L

languages(Iterable<String>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Add to list of languages to process.
languages(String...) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Add to list of languages to process.
local(String, Action<ComponentSrc>) - Method in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Adds a component source that is available on the local filesystem.

O

org.asciidoctor.gradle.base - package org.asciidoctor.gradle.base
org.asciidoctor.gradle.base.slides - package org.asciidoctor.gradle.base.slides

P

prepareWorkspace() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskWorkspacePreparation: Prepares a workspace prior to conversion.
prepareWorkspace(String) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskWorkspacePreparation: Prepares a workspace for a specific language prior to conversion.
prepareWorkspace(Optional<String>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskWorkspacePreparation: Prepares a workspace for a specific language prior to conversion.
Profile - Enum in org.asciidoctor.gradle.base.slides: Profile names for various slide deck frameworks.
projectOperations - Variable in class org.asciidoctor.gradle.base.AbstractDownloadableComponent: Re-usable instance of ProjectOperations

R

resources(Closure) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Add to the CopySpec for extra files.
resources(Action<? super CopySpec>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Add to the CopySpec for extra files.
resources(String, Closure) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Add to the CopySpec for extra files.
resources(String, Action<? super CopySpec>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Add to the CopySpec for extra files.

S

secondarySources(Closure<?>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Configures secondary sources.
secondarySources(Action<? super PatternSet>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Configures sources.
setAttributes(Map<String, Object>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskAttributes: Shortcut method to apply a new set of Asciidoctor attributes, clearing any attributes previously set.
setBaseDir(Object) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskBaseDirConfiguration: Sets the base directory for a conversion.
setLanguages(Iterable<String>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Reset current list of languages and replace with a new set.
setLogDocuments(boolean) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Whether to log documents as they are being converted.
setOutputDir(Object) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Sets the new Asciidoctor parent output directory.
setSourceDir(Object) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Sets the new Asciidoctor parent source directory.
setVersion(Object) - Method in interface org.asciidoctor.gradle.base.AsciidoctorModuleDefinition: Set the version of the component to use.
SlidesToExportAware - Interface in org.asciidoctor.gradle.base.slides: For tasks types that creates slides and can be auto-recognised for specific slide-to-pdf converters when such plugins are applied.
sourceDir(Object) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Sets the new Asciidoctor parent source directory in a declarative style.
sources(Closure<?>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Configures sources.
sources(Action<? super PatternSet>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Configures sources.
sources(String...) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Include source patterns.

U

use() - Method in interface org.asciidoctor.gradle.base.AsciidoctorModuleDefinition: Use the default version of this component
useIntermediateWorkDir() - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Some extensions such as ditaa creates images in the source directory.

V

valueOf(String) - Static method in enum org.asciidoctor.gradle.base.slides.Profile: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.asciidoctor.gradle.base.slides.Profile: Returns an array containing the constants of this enum type, in the order they are declared.
version(Object) - Method in interface org.asciidoctor.gradle.base.AsciidoctorModuleDefinition: Declarative way in DSL to set the version of the component to use.

W

withIntermediateArtifacts(Closure) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: The document conversion might generate additional artifacts that could require copying to the final destination.
withIntermediateArtifacts(Action<PatternSet>) - Method in interface org.asciidoctor.gradle.base.AsciidoctorTaskFileOperations: Additional artifacts created by Asciidoctor that might require copying.

A B C G H I L O P R S U V W