org.asciidoctor.gradle.model5.core.kroki

Interface KrokiConfiguration

All Superinterfaces:

HasAttributeProvider

public interface KrokiConfiguration
extends HasAttributeProvider

Configuring Kroki

Since:

5.0

Method Summary

Modifier and Type	Method and Description
void	plantUmlIncludePath(org.gradle.api.Action<org.asciidoctor.gradle.model5.core.revealjs.FileOrUri> path) A file that will be included at the top of all PlantUML diagrams as if !include file was used.
void	plantUmlIncludePath(groovy.lang.Closure<?> path) A file that will be included at the top of all PlantUML diagrams as if !include file was used.
void	plantUmlSearchPaths(java.lang.Object... paths) Search path(s) that will be used to resolve !include file additionally to current diagram directory, similar to PlantUML property plantuml.include.path.
void	setFetchDiagrams(boolean flag) Define if the images from the Kroki server should be stored to disk.
void	setKrokiMethod(java.lang.String method) Define how we should get the image from the Kroki server.
void	setMaxUriLength(int length) Define the max URI length before using a POST request when using adaptive HTTP method.
void	setServerUri(java.lang.Object uri) The URL of the Kroki server.

Methods inherited from interface org.asciidoctor.gradle.model5.core.attributes.HasAttributeProvider

getAttributeProvider

Method Detail

setServerUri

void setServerUri(java.lang.Object uri)

The URL of the Kroki server.

If not set, the implementation will use the one at kroki.io.

Parameters:

uri - Anything convertible to a URI.

setFetchDiagrams

void setFetchDiagrams(boolean flag)

Define if the images from the Kroki server should be stored to disk.

Parameters:

flag - true to download images.

setKrokiMethod

void setKrokiMethod(java.lang.String method)

Define how we should get the image from the Kroki server.

If adaptive is used, get will be used unless the URI length is longer than what was set by setMaxUriLength(int).

Parameters:

method - get, post, or adaptive

setMaxUriLength

void setMaxUriLength(int length)

Define the max URI length before using a POST request when using adaptive HTTP method.

If not set, an internal default will be used.

Parameters:

length - Max length.

plantUmlIncludePath

void plantUmlIncludePath(org.gradle.api.Action<org.asciidoctor.gradle.model5.core.revealjs.FileOrUri> path)

A file that will be included at the top of all PlantUML diagrams as if !include file was used. This can be useful when you want to define a common skin for all your diagrams. The value can be a path or a URL.

Parameters:

path - Configure a file, a URI, or a relative path.

plantUmlIncludePath

void plantUmlIncludePath(@DelegatesTo(value=org.asciidoctor.gradle.model5.core.revealjs.FileOrUri.class)
                         groovy.lang.Closure<?> path)

A file that will be included at the top of all PlantUML diagrams as if !include file was used. This can be useful when you want to define a common skin for all your diagrams. The value can be a path or a URL.

Parameters:

path - Configure a file, a URI, or a relative path.

plantUmlSearchPaths

void plantUmlSearchPaths(java.lang.Object... paths)

Search path(s) that will be used to resolve !include file additionally to current diagram directory, similar to PlantUML property plantuml.include.path.

The implementation will take care to present the correctly formatted value to the engine as required by the operating system conventions.

Parameters:

paths - One or more search paths. Anything convertible to a file will do.