- add(String, Object) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Add a single attribute
- addAll(Map<String, Object>) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Add additional Asciidoctor attributes.
- addAsBoolean(String, Object) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Indicates that the value should be treated as a time value.
- addAsDate(String, Object) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Indicates that the value should be treated as a date value.
- addAsTime(String, Object) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Indicates that the value should be treated as a time value.
- asBoolean(Object) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Indicates that the value should be treated as a boolean value.
- AsciidoctorConversionSettings - Interface in org.asciidoctor.gradle.model5.core
-
Describes the source documents, attributes etc.
- AsciidoctorDocInfo - Interface in org.asciidoctor.gradle.model5.core.publications
-
Methods for configuring docinfo
- AsciidoctorEngine - Interface in org.asciidoctor.gradle.model5.core.engines
-
Methods for executing an engine
- AsciidoctorExecutionSettings - Interface in org.asciidoctor.gradle.model5.core
-
Describes execution options for running a launcher.
- AsciidoctorExtension - Interface in org.asciidoctor.gradle.model5.core.extensions
-
Defines an Asciddoctor extension.
- AsciidoctorGenericOutputFormatter - Interface in org.asciidoctor.gradle.model5.core.formatters
-
Generic output formatter for adding backends that are not
directly supported by this plugin suite.
- AsciidoctorLauncher - Interface in org.asciidoctor.gradle.model5.core
-
Something that can launch and execute Ascidoctor conversions.
- AsciidoctorNamedBackend - Interface in org.asciidoctor.gradle.model5.core
-
Named backend which represents a backend, but which might be named differently.
- AsciidoctorOutputData - Interface in org.asciidoctor.gradle.model5.core.publications
-
Holds data regarding a publication output.
- AsciidoctorOutputFormatter - Interface in org.asciidoctor.gradle.model5.core.formatters
-
Defines an output formatter.
- AsciidoctorRequires - Interface in org.asciidoctor.gradle.model5.core
-
Items such as output formatters and extensions may need to supply a list of required components to an
Asciidoctor engine.
- AsciidoctorTaskMethods - Interface in org.asciidoctor.gradle.model5.core.tasks
-
- AsciidoctorToolchain - Interface in org.asciidoctor.gradle.model5.core.toolchains
-
Represents an Asciidoctor toolchain.
- asDate(Object) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Indicates that the value should be treated as a date value.
- asTime(Object) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Indicates that the value should be treated as a time value.
- attributeProvider(Provider<Map<String, Object>>) - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Adds a provider as an additional attribute provider.
- Attributes - Interface in org.asciidoctor.gradle.model5.core.attributes
-
An Asciidoctor-implementation agnostic representation of attributes.
- attributes(Action<Attributes>) - Method in interface org.asciidoctor.gradle.model5.core.attributes.HasAsciidoctorAttributes
-
Configures the attributes for this publication
- attributes(Closure) - Method in interface org.asciidoctor.gradle.model5.core.attributes.HasAsciidoctorAttributes
-
Configures the attributes for this publication
- AttributeType - Interface in org.asciidoctor.gradle.model5.core.attributes
-
Flag attributes as certain type.
- getAdditionalClasspath() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorExecutionSettings
-
Additional classpath to be added.
- getAdditionalClasspath() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
Additional classpath to add for execution.
- getAdjustBaseDirPerFile() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Whether the engine should change the base directory prior to converting a file.
- getAdjustBaseDirPerFile() - Method in interface org.asciidoctor.gradle.model5.core.basedir.BaseDirStrategy
-
Whether to adjust the base directory per file.
- getAsciidocExtensions() - Method in interface org.asciidoctor.gradle.model5.core.toolchains.AsciidoctorToolchain
-
Extensions registered with this toolchain.
- getAttributeProvider() - Method in interface org.asciidoctor.gradle.model5.core.attributes.HasAttributeProvider
-
Indicates that something can provide unresolved attributes.
- getAttributeResolver() - Method in interface org.asciidoctor.gradle.model5.core.attributes.Attributes
-
Resolves all the Asciidoctor options.
- getAttributes() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Document attributes.
- getAttributes() - Method in interface org.asciidoctor.gradle.model5.core.attributes.HasAsciidoctorAttributes
-
Direct access to the attributes for this publication.
- getBackend() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Backend to use.
- getBackend() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorNamedBackend
-
The actual backend.
- getBackend() - Method in interface org.asciidoctor.gradle.model5.core.formatters.AsciidoctorOutputFormatter
-
What this is known to Asciidoctor as the backend.
- getBackend() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
The named backend for this formatter.
- getBaseDir() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Base directory.
- getBaseDir(Provider<Directory>) - Method in interface org.asciidoctor.gradle.model5.core.basedir.BaseDirStrategy
-
Base directory location.
- getBaseDir(Provider<Directory>, String) - Method in interface org.asciidoctor.gradle.model5.core.basedir.BaseDirStrategy
-
Base directory location for a specific language.
- getBaseDir() - Method in interface org.asciidoctor.gradle.model5.core.basedir.HasBaseDirStrategy
-
Direct access to basedir configuration.
- getBaseDirStrategy() - Method in interface org.asciidoctor.gradle.model5.core.basedir.BaseDirConfiguration
-
Returns the current basedir strategy if it has been configured.
- getBuiltBy() - Method in interface org.asciidoctor.gradle.model5.core.publications.ExternalAsciidoctorSource
-
Tasks that build this external source.
- getClasspath() - Method in interface org.asciidoctor.gradle.model5.core.extensions.AsciidoctorExtension
-
Additional items to add to the classpath when a conversion involving the extension is executed.
- getClasspath() - Method in interface org.asciidoctor.gradle.model5.core.formatters.AsciidoctorOutputFormatter
-
Additional items to add to the classpath when a conversion involving the output formatter is executed.
- getConversionTemplate() - Method in interface org.asciidoctor.gradle.model5.core.formatters.HasTemplates
-
Configured templates.
- getConversionTemplate() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
If the formatter has configured templates, it can be set here.
- getCopyResources() - Method in interface org.asciidoctor.gradle.model5.core.formatters.AsciidoctorOutputFormatter
-
Whether resource files should be copied to the output directory.
- getCopyResources() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
Whether resources should be copied.
- getDestinationDir() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Destination directory.
- getDisplayType() - Method in interface org.asciidoctor.gradle.model5.core.HasDisplayType
-
A string representing the class name as it should be used in the DSL.
- getDocType() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Document type.
- getDocType() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
Get the documentation type that needs to be based to the engine at run time.
- getDuplicatesStrategy() - Method in interface org.asciidoctor.gradle.model5.core.publications.ProvidedExternalSources
-
How to deal with duplicates from various external sources.
- getEcosystemSignature() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorLauncher
-
An arbitrary string that the launcher makes up from its runnable ecosystem.
- getEmbedded() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Whether embedded processing should be performed.
- getEmbedded() - Method in interface org.asciidoctor.gradle.model5.core.formatters.HasEmbedded
-
Embedded conversion setting.
- getEmbedded() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
Whether embedded processing should be performed.
- getEnforcedDocType() - Method in interface org.asciidoctor.gradle.model5.core.formatters.AsciidoctorOutputFormatter
-
Indicates that this backend always requires a specific document type and will try to enforce it.
- getExternalSources() - Method in interface org.asciidoctor.gradle.model5.core.publications.ProvidedExternalSources
-
The list of provided external sources.
- getFatalWarnings() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Patterns of warnings which must be treated as errors.
- getFormatterName() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorExecutionSettings
-
The name of the formatter.
- getFormatterName() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
The actual name of the formatter, but not the alias name.
- getInto() - Method in interface org.asciidoctor.gradle.model5.core.publications.ProvidedExternalSourceSet
-
Whether the external source should be placed in a folder below the local source directory and also in the
destination directory.
- getLauncher() - Method in interface org.asciidoctor.gradle.model5.core.engines.AsciidoctorEngine
-
Something that can execute Asciidoctor conversions.
- getModuleRequires() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorExecutionSettings
-
Some launchers have the concept of require for external libraries.
- getModuleRequires() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
List modules which need to be explicitly called out as being required.
- getOutputDir() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
Directory where output will be written to.
- getRegisteredOutputFormatters() - Method in interface org.asciidoctor.gradle.model5.core.toolchains.AsciidoctorToolchain
-
Output formatters registered with this toolchain.
- getRequires() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorRequires
-
A list of requires that a component places on the associated toolchain.
- getResourcesPatterns() - Method in interface org.asciidoctor.gradle.model5.core.publications.HasAsciidoctorResources
-
Patterns that can be added to a copy spec for copying resources to a target directory.
- getResourcesPatterns() - Method in interface org.asciidoctor.gradle.model5.core.publications.ProvidedExternalSourceSet
-
Patterns that can be added to a copy spec for copying resources to a target directory.
- getSafeMode() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorExecutionSettings
-
Safe mode
- getSafeMode() - Method in interface org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions
-
Returns the Asciidoctor SafeMode under which a conversion will be run.
- getScriptCollections() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
A collection of scripts, grouped by implementation language.
- getScriptedExtensions() - Method in interface org.asciidoctor.gradle.model5.core.extensions.ScriptedExtensions
-
Returns a list of scripted extensions.
- getScriptFiles() - Method in interface org.asciidoctor.gradle.model5.core.ScriptCollection
-
A set of files containing scripts.
- getScripts() - Method in interface org.asciidoctor.gradle.model5.core.ScriptCollection
-
A set of scripts.
- getScriptType() - Method in interface org.asciidoctor.gradle.model5.core.ScriptCollection
-
The language of the script collection.
- getSourceDir() - Method in interface org.asciidoctor.gradle.model5.core.publications.HasAsciidoctorSource
-
The top directory for asciidoc sources for this publication.
- getSourceFiles() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
Source files.
- getSourcePatterns() - Method in interface org.asciidoctor.gradle.model5.core.publications.HasAsciidoctorSource
-
A provider of source patterns.
- getSourcePatterns() - Method in interface org.asciidoctor.gradle.model5.core.publications.ProvidedExternalSourceSet
-
A provider of source patterns.
- getSourceRootDir() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
The root directory where source files are located.
- getSourcesAndResources() - Method in interface org.asciidoctor.gradle.model5.core.publications.ProvidedExternalSourceSet
-
A collection of files from the external source area.
- getTemplateDirs() - Method in interface org.asciidoctor.gradle.model5.core.ConversionTemplate
-
List of template directories
- getTemplateEngines() - Method in interface org.asciidoctor.gradle.model5.core.ConversionTemplate
-
List of template engines.
- getTemplates() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorConversionSettings
-
When an output formatter supports templates, this may be populated.
- getThemeDir() - Method in interface org.asciidoctor.gradle.model5.core.pdfthemes.PdfTheme
-
Provider to where the theme is located.
- getThemeDir() - Method in interface org.asciidoctor.gradle.model5.core.pdfthemes.PdfThemeCollection
-
Provider to where the theme is located.
- getThemeName() - Method in interface org.asciidoctor.gradle.model5.core.pdfthemes.PdfTheme
-
The theme name.
- getToolchainName() - Method in interface org.asciidoctor.gradle.model5.core.AsciidoctorExecutionSettings
-
The name of the toolchain.
- getToolchainName() - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorOutputData
-
The name of the toolchain.
- getToolchainPreparationTaskNames() - Method in interface org.asciidoctor.gradle.model5.core.toolchains.AsciidoctorToolchain
-
A list of tasks that will perform toolchain-related preparation before conversion using the toolchain can start.
- GithubThemeCollection - Interface in org.asciidoctor.gradle.model5.core.pdfthemes
-
A PDF theme hosted on Github.
- GitlabThemeCollection - Interface in org.asciidoctor.gradle.model5.core.pdfthemes
-
A PDF theme hosted on Gitlab.
- ScriptCollection - Interface in org.asciidoctor.gradle.model5.core
-
A collection of scripts that can be used for extension.
- ScriptedExtensions - Interface in org.asciidoctor.gradle.model5.core.extensions
-
An interface for providing scripted extensions.
- setAdjustBaseDirPerFile(Provider<Boolean>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
Sets whether the base directory needs to be adjusted by file.
- setAllowUriRead(boolean) - Method in interface org.asciidoctor.gradle.model5.core.formatters.HasAllowUriRead
-
Sets whether content can be read from URIs.
- setAttributes(Provider<Map<String, String>>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
The attributes the task will use.
- setBackend(String) - Method in interface org.asciidoctor.gradle.model5.core.formatters.AsciidoctorGenericOutputFormatter
-
Sets the name of the backend.
- setBaseDir(Object) - Method in interface org.asciidoctor.gradle.model5.core.basedir.BaseDirConfiguration
-
Sets the base directory for a conversion.
- setBaseDir(Provider<Directory>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
Sets the base directory for conversions.
- setCopyResources(boolean) - Method in interface org.asciidoctor.gradle.model5.core.formatters.AsciidoctorGenericOutputFormatter
-
Set whether resources should be copied.
- setDocInfoDir(Object) - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorDocInfo
-
Fix a specific directory to contain docinfo content.
- setEmbedded(boolean) - Method in interface org.asciidoctor.gradle.model5.core.formatters.HasEmbedded
-
Tells the backend to perform embedded outputs.
- setEnforcedDocType(String) - Method in interface org.asciidoctor.gradle.model5.core.formatters.AsciidoctorGenericOutputFormatter
-
Set a document type if the backend always requires a specific one.
- setExternalSources(Provider<? extends ProvidedExternalSources>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
External sources.
- setFatalWarnings(Provider<Set<Pattern>>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
The set of patterns to check for fatal warnings.
- setFetchDiagrams(boolean) - Method in interface org.asciidoctor.gradle.model5.core.kroki.KrokiConfiguration
-
Define if the images from the Kroki server should be stored to disk.
- setFooterIsPrivate(boolean) - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorDocInfo
-
Setting this will apply to all source files in the source set.
- setHeaderIsPrivate(boolean) - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorDocInfo
-
Setting this will apply to all source files in the source set.
- setHeadIsPrivate(boolean) - Method in interface org.asciidoctor.gradle.model5.core.publications.AsciidoctorDocInfo
-
Setting this will apply to all source files in the source set.
- setKrokiMethod(String) - Method in interface org.asciidoctor.gradle.model5.core.kroki.KrokiConfiguration
-
Define how we should get the image from the Kroki server.
- setLauncher(Provider<? extends AsciidoctorLauncher>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
Sets the conversion launcher for this task.
- setLogDocuments(boolean) - Method in interface org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions
-
Whether documents should be logged as they are processed.
- setMaxUriLength(int) - Method in interface org.asciidoctor.gradle.model5.core.kroki.KrokiConfiguration
-
Define the max URI length before using a POST request when using adaptive HTTP method.
- setOutputData(AsciidoctorOutputData) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
Configures the task according to a toolchain and output formatter combination.
- setPathInRepo(Object) - Method in interface org.asciidoctor.gradle.model5.core.pdfthemes.GithubThemeCollection
-
The relative path to the themes directory inside the downloaded package.
- setPathInRepo(Object) - Method in interface org.asciidoctor.gradle.model5.core.pdfthemes.GitlabThemeCollection
-
The relative path to the themes directory inside the downloaded package.
- setSafeMode(Provider<SafeMode>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
The safety mode the specific task will run conversions under.
- setSafeMode(SafeMode) - Method in interface org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions
-
Set Asciidoctor safe mode.
- setSafeMode(int) - Method in interface org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions
-
Set Asciidoctor safe mode.
- setSafeMode(String) - Method in interface org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions
-
Set Asciidoctor safe mode.
- setSafeMode(Provider<SafeMode>) - Method in interface org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions
-
Set Asciidoctor safe mode.
- setScriptExtensions(Provider<Map<String, ? extends ScriptCollection>>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
A provider of script collections.
- setServerUri(Object) - Method in interface org.asciidoctor.gradle.model5.core.kroki.KrokiConfiguration
-
The URL of the Kroki server.
- setSourceDir(Object) - Method in interface org.asciidoctor.gradle.model5.core.publications.HasAsciidoctorSource
-
The directory where the root of the Asciidoc documents will be found.
- setSourceDir(Provider<Directory>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
Sets the source directory for actual sources.
- setSourcePatterns(Provider<PatternFilterable>) - Method in interface org.asciidoctor.gradle.model5.core.tasks.AsciidoctorTaskMethods
-
The source patterns to look for in the source directory.
- setThemeDir(Object) - Method in interface org.asciidoctor.gradle.model5.core.pdfthemes.LocalThemeCollection
-
Define the directory where the theme is located.
- setThemeName(Object) - Method in interface org.asciidoctor.gradle.model5.core.pdfthemes.PdfTheme
-
- sources(Closure<?>) - Method in interface org.asciidoctor.gradle.model5.core.publications.HasAsciidoctorSource
-
Configures sources.
- sources(Action<? super PatternSet>) - Method in interface org.asciidoctor.gradle.model5.core.publications.HasAsciidoctorSource
-
Configures sources.
- sources(String...) - Method in interface org.asciidoctor.gradle.model5.core.publications.HasAsciidoctorSource
-
Include source patterns.