Method Detail

• public void clearSecondarySources()

  Clears any of the existing secondary soruces patterns. This should be used if none of the default patterns should be monitored.

• public void clearSources()

  Clears existing sources patterns.

• @OutputDirectories public Set<File> getBackendOutputDirectories()

  Returns a list of all output directories by backend

• public CopySpec getDefaultResourceCopySpec(Optional<String> lang)

  The default CopySpec that will be used if resources was never called By default, anything below $sourceDir/images will be included.

  Parameters:

  lang - Language to use. Can be empty (not null) when not to use a language.

  Returns:

  ACopySpec. Never null.

• @Internal public String getEngineName()

  The name of the Asciidoctor engine implementation.

  Returns:

  Engine name.

• @Internal public Provider<PatternSet> getIntermediateArtifactPatternProvider()

  A provider of patterns identifying intermediate artifacts.

  Returns:

  Provider to a PatternSet. Can be empty.

• @Internal public File getIntermediateWorkDir()

  The directory that will be the intermediate directory should one be required.

  Returns:

  Intermediate working directory

• @Internal public Provider<File> getIntermediateWorkDirProvider()

• public CopySpec getLanguageResourceCopySpec(String lang)

  Returns the copy specification for the resources of a specific language.

  Parameters:

  lang - Language

  Returns:

  Copy specification. Can be null.

• @Input public List<String> getLanguages()

  Obtain List of languages the sources documents are written in.

  Returns:

  List of languages. Can be empty, but never null.

• @Console public boolean getLogDocuments()

  Logs documents as they are converted

• @OutputDirectory public File getOutputDir()

  Returns the current toplevel output directory

  Returns:

  Output directory.

• @Internal public DirectoryProperty getOutputDirProperty()

  Returns the current toplevel output directory as a property object.

  Returns:

  Output directory as a property.

• public 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 public FileTree getSecondarySourceFileTree()

  Returns a FileTree containing all secondary source documents. If a filter with secondarySources was never set then all asciidoc source files below setSourceDir will be included. If multiple languages are used, all language secondary source sets are included.

  Returns:

  Collection of secondary source files

• @Internal public File getSourceDir()

  Returns the parent directory for Asciidoctor source.

  Returns:

  Location of source directory.

• @Internal public DirectoryProperty getSourceDirProperty()

  Returns the parent directory for Asciidoctor source as a property object.

  Returns:

  Source directory as a property.

• @Internal public FileTree getSourceFileTree()

  Returns a FileTree containing all source documents If a filter with sources was never set then all asciidoc source files below setSourceDir will be included. If multiple languages are used, all * language secondary source sets are included.

  Returns:

  Applicable source trees.

• public Map<String, ?> 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, revnumber, gradle-project-group, gradle-project-name

  Parameters:

  workingSourceDir - Directory where source files are located.

  Returns:

  A collection of default attributes.

• public boolean hasIntermediateWorkDir()

  Checks whether an intermediate workdir is required.

  Returns:

  true is there is an intermediate working directory.

• public void languages(Iterable<String> langs)

  Add to list of languages to process.

  Parameters:

  langs - List of additional languages

• public void languages(String langs)

  Add to list of languages to process.

  Parameters:

  langs - List of additional languages

• public void resources(groovy.lang.Closure cfg)

  Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend

  Parameters:

  cfg - CopySpec runConfiguration closure

• public void resources(Action<? super CopySpec> cfg)

  Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend

  Parameters:

  cfg - CopySpec runConfiguration Action

• public void resources(String lang, groovy.lang.Closure cfg)

  Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend If not languages are set. these resources will be ignored.

  Parameters:

  cfg - CopySpec runConfiguration closure

  lang - Language to which these resources will be applied to.

• public void resources(String lang, Action<? super CopySpec> cfg)

  Add to the CopySpec for extra files. The destination of these files will always have a parent directory of outputDir or outputDir + backend If not languages are set. these resources will be ignored.

  Parameters:

  cfg - CopySpec runConfiguration Action

  lang - Language to which these resources will be applied to.

  Since:

  3.0.0

• public void secondarySources(@groovy.lang.DelegatesTo(PatternSet.class) groovy.lang.Closure<?> cfg)

  Configures secondary sources.

  Parameters:

  cfg - Configuration closure. Is passed a PatternSet.

• public void secondarySources(Action<? super PatternSet> cfg)

  Configures sources.

  Parameters:

  cfg - Configuration Action. Is passed a PatternSet.

• public void setLanguages(Iterable<String> langs)

  Reset current list of languages and replace with a new set.

  Parameters:

  langs - List of new languages

• public void setLogDocuments(boolean mode)

  Whether to log documents as they are being converted.

  Parameters:

  mode - Set true in order to log documents.

• public void setOutputDir(Object f)

  Sets the new Asciidoctor parent output directory.

  Parameters:

  f - An object convertible via project.file.

• public void setSourceDir(Object f)

  Sets the new Asciidoctor parent source directory.

  Parameters:

  f - Any object convertible with project.file.

• public void sourceDir(Object f)

  Sets the new Asciidoctor parent source directory in a declarative style.

  Parameters:

  f - Any object convertible with project.file.

• public void sources(@groovy.lang.DelegatesTo(PatternSet.class) groovy.lang.Closure<?> cfg)

  Configures sources.

  Parameters:

  cfg - Configuration closure. Is passed a PatternSet.

• public void sources(Action<? super PatternSet> cfg)

  Configures sources.

  Parameters:

  cfg - Configuration Action. Is passed a PatternSet.

• public void sources(String includePatterns)

  Include source patterns.

  Parameters:

  includePatterns - ANT-style patterns for sources to include

• public void useIntermediateWorkDir()

  Some extensions such as ditaa creates images in the source directory. Use this setting to copy all sources and resources to an intermediate work directory before processing starts. This will keep the source directory pristine

• public void withIntermediateArtifacts(@groovy.lang.DelegatesTo(PatternSet.class) groovy.lang.Closure cfg)

  The document conversion might generate additional artifacts that could require copying to the final destination. An example is use of ditaa diagram blocks. These artifacts can be specified in this block. Use of the option implies useIntermediateWorkDir.

  Parameters:

  cfg - Configures a PatternSet with a base directory of the intermediate working directory.

• public void withIntermediateArtifacts(Action<PatternSet> cfg)

  Additional artifacts created by Asciidoctor that might require copying.

  Parameters:

  cfg - Action that configures a PatternSet.

  See Also:

  withIntermediateArtifacts(Closure cfg)