org.asciidoctor.extension

Annotation Type Format

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Format

This annotation defines how an InlineMacroProcessor is applied. Possible values are:

FormatType.LONG

to match inline macros of the form: <macro name> ':' <target> '[' <attributes> ']'

FormatType.SHORT

to match inline macros of the form: <macro name> ':' '[' <attributes> ']'

FormatType.CUSTOM

the regular expression defined by the regexp() has to match the macro. The first capture will be mapped to the target, the second to the attributes.

Applicable for:

BlockMacroProcessor
BlockProcessor
BlockProcessor
DocInfoProcessor
IncludeProcessor
InlineMacroProcessor	✓
Postprocessor
Preprocessor
Treeprocessor

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	regexp
FormatType	value

Element Detail

value

public abstract FormatType value

Default:

org.asciidoctor.extension.FormatType.CUSTOM

regexp

public abstract java.lang.String regexp

Default:

""