Class WikiLinkExtension

java.lang.Object

com.vladsch.flexmark.ext.wikilink.WikiLinkExtension

All Implemented Interfaces:

Formatter.FormatterExtension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension

public class WikiLinkExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension

Extension for wikilinks

Create it with create() and then configure it on the builders

The parsed emoji shortcuts text regions are turned into WikiLink nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<Boolean>	ALLOW_ANCHOR_ESCAPE
static final DataKey<Boolean>	ALLOW_ANCHORS
static final DataKey<Boolean>	ALLOW_INLINES
static final DataKey<Boolean>	ALLOW_PIPE_ESCAPE
static final DataKey<Boolean>	DISABLE_RENDERING
static final DataKey<String>	IMAGE_FILE_EXTENSION
static final DataKey<Boolean>	IMAGE_LINKS
static final DataKey<String>	IMAGE_PREFIX
static final DataKey<String>	IMAGE_PREFIX_ABSOLUTE	Image prefix to use for absolute wiki image sources starting with the '/' character.
static final DataKey<String>	LINK_ESCAPE_CHARS	Characters to escape in wiki links.
static final DataKey<String>	LINK_FILE_EXTENSION
static final DataKey<Boolean>	LINK_FIRST_SYNTAX
static final DataKey<String>	LINK_PREFIX
static final DataKey<String>	LINK_PREFIX_ABSOLUTE	Link prefix to use for absolute wiki links starting with the '/' character.
static final DataKey<String>	LINK_REPLACE_CHARS	Characters to replace LINK_ESCAPE_CHARS with.
static final LinkType	WIKI_LINK

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	WikiLinkExtension()

Method Summary

Modifier and Type	Method	Description
static WikiLinkExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)	Called to give each extension to register extension points that it contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	parserOptions(MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
void	rendererOptions(@NotNull MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALLOW_INLINES

public static final DataKey<Boolean> ALLOW_INLINES

ALLOW_ANCHORS

public static final DataKey<Boolean> ALLOW_ANCHORS

ALLOW_ANCHOR_ESCAPE

public static final DataKey<Boolean> ALLOW_ANCHOR_ESCAPE

ALLOW_PIPE_ESCAPE

public static final DataKey<Boolean> ALLOW_PIPE_ESCAPE

DISABLE_RENDERING

public static final DataKey<Boolean> DISABLE_RENDERING

LINK_FIRST_SYNTAX

public static final DataKey<Boolean> LINK_FIRST_SYNTAX

LINK_PREFIX

public static final DataKey<String> LINK_PREFIX

LINK_PREFIX_ABSOLUTE

public static final DataKey<String> LINK_PREFIX_ABSOLUTE

Link prefix to use for absolute wiki links starting with the '/' character.

Will get its value from option LINK_PREFIX until its own value is set.

IMAGE_PREFIX

public static final DataKey<String> IMAGE_PREFIX

IMAGE_PREFIX_ABSOLUTE

public static final DataKey<String> IMAGE_PREFIX_ABSOLUTE

Image prefix to use for absolute wiki image sources starting with the '/' character.

Will get its value from option IMAGE_PREFIX until its own value is set.

IMAGE_LINKS

public static final DataKey<Boolean> IMAGE_LINKS

LINK_FILE_EXTENSION

public static final DataKey<String> LINK_FILE_EXTENSION

IMAGE_FILE_EXTENSION

public static final DataKey<String> IMAGE_FILE_EXTENSION

LINK_ESCAPE_CHARS

public static final DataKey<String> LINK_ESCAPE_CHARS

Characters to escape in wiki links.

Each character in the configuration string is replaced with a character at the corresponding index in the string given by the configuration option LINK_REPLACE_CHARS.

LINK_REPLACE_CHARS

public static final DataKey<String> LINK_REPLACE_CHARS

Characters to replace LINK_ESCAPE_CHARS with.

See Also:

• LINK_ESCAPE_CHARS

WIKI_LINK

public static final LinkType WIKI_LINK

Constructor Details

WikiLinkExtension

private WikiLinkExtension()

Method Details

create

public static WikiLinkExtension create()

rendererOptions

public void rendererOptions(@NotNull
 @NotNull MutableDataHolder options)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

Parameters:

options - option set that will be used for the builder

parserOptions

public void parserOptions(MutableDataHolder options)

Description copied from interface: Parser.ParserExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

parserOptions in interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

extend

public void extend(Parser.Builder parserBuilder)

Description copied from interface: Parser.ParserExtension

This method is called on all extensions so that they can register their custom processors

Specified by:

extend in interface Parser.ParserExtension

Parameters:

parserBuilder - parser builder with which to register extensions

See Also:

• Parser.Builder.customBlockParserFactory(CustomBlockParserFactory)
• Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory)
• Parser.Builder.customInlineParserFactory(InlineParserFactory)
• Parser.Builder.customDelimiterProcessor(DelimiterProcessor)
• Parser.Builder.postProcessorFactory(PostProcessorFactory)
• Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory)
• Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory)
• Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory)
• Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)

extend

public void extend(@NotNull
 HtmlRenderer.Builder htmlRendererBuilder,
 @NotNull
 @NotNull String rendererType)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

Called to give each extension to register extension points that it contains

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - type of rendering being performed. For now "HTML", "JIRA" or "YOUTRACK"

See Also:

• HtmlRenderer.Builder.attributeProviderFactory(AttributeProviderFactory)
• HtmlRenderer.Builder.nodeRendererFactory(NodeRendererFactory)
• HtmlRenderer.Builder.linkResolverFactory(LinkResolverFactory)
• HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)