Package com.vladsch.flexmark.ext.wikilink

Class WikiLinkExtension

java.lang.Object

com.vladsch.flexmark.ext.wikilink.WikiLinkExtension

All Implemented Interfaces:

com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.util.misc.Extension

public class WikiLinkExtension
extends Object
implements com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.formatter.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 com.vladsch.flexmark.util.data.DataKey<Boolean>	ALLOW_ANCHOR_ESCAPE
static com.vladsch.flexmark.util.data.DataKey<Boolean>	ALLOW_ANCHORS
static com.vladsch.flexmark.util.data.DataKey<Boolean>	ALLOW_INLINES
static com.vladsch.flexmark.util.data.DataKey<Boolean>	ALLOW_PIPE_ESCAPE
static com.vladsch.flexmark.util.data.DataKey<Boolean>	DISABLE_RENDERING
static com.vladsch.flexmark.util.data.DataKey<String>	IMAGE_FILE_EXTENSION
static com.vladsch.flexmark.util.data.DataKey<Boolean>	IMAGE_LINKS
static com.vladsch.flexmark.util.data.DataKey<String>	IMAGE_PREFIX
static com.vladsch.flexmark.util.data.DataKey<String>	IMAGE_PREFIX_ABSOLUTE	Image prefix to use for absolute wiki image sources starting with the '/' character.
static com.vladsch.flexmark.util.data.DataKey<String>	LINK_ESCAPE_CHARS	Characters to escape in wiki links.
static com.vladsch.flexmark.util.data.DataKey<String>	LINK_FILE_EXTENSION
static com.vladsch.flexmark.util.data.DataKey<Boolean>	LINK_FIRST_SYNTAX
static com.vladsch.flexmark.util.data.DataKey<String>	LINK_PREFIX
static com.vladsch.flexmark.util.data.DataKey<String>	LINK_PREFIX_ABSOLUTE	Link prefix to use for absolute wiki links starting with the '/' character.
static com.vladsch.flexmark.util.data.DataKey<String>	LINK_REPLACE_CHARS	Characters to replace LINK_ESCAPE_CHARS with.
static com.vladsch.flexmark.html.renderer.LinkType	WIKI_LINK

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Method Summary

Modifier and Type	Method	Description
static WikiLinkExtension	create()
void	extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)
void	extend(com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
void	extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
void	parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)
void	rendererOptions(@NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_INLINES

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> ALLOW_INLINES

ALLOW_ANCHORS

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> ALLOW_ANCHORS

ALLOW_ANCHOR_ESCAPE

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> ALLOW_ANCHOR_ESCAPE

ALLOW_PIPE_ESCAPE

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> ALLOW_PIPE_ESCAPE

DISABLE_RENDERING

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> DISABLE_RENDERING

LINK_FIRST_SYNTAX

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> LINK_FIRST_SYNTAX

LINK_PREFIX

public static final com.vladsch.flexmark.util.data.DataKey<String> LINK_PREFIX

LINK_PREFIX_ABSOLUTE

public static final com.vladsch.flexmark.util.data.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 com.vladsch.flexmark.util.data.DataKey<String> IMAGE_PREFIX

IMAGE_PREFIX_ABSOLUTE

public static final com.vladsch.flexmark.util.data.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 com.vladsch.flexmark.util.data.DataKey<Boolean> IMAGE_LINKS

LINK_FILE_EXTENSION

public static final com.vladsch.flexmark.util.data.DataKey<String> LINK_FILE_EXTENSION

IMAGE_FILE_EXTENSION

public static final com.vladsch.flexmark.util.data.DataKey<String> IMAGE_FILE_EXTENSION

LINK_ESCAPE_CHARS

public static final com.vladsch.flexmark.util.data.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 com.vladsch.flexmark.util.data.DataKey<String> LINK_REPLACE_CHARS

Characters to replace LINK_ESCAPE_CHARS with.

See Also:

LINK_ESCAPE_CHARS

WIKI_LINK

public static final com.vladsch.flexmark.html.renderer.LinkType WIKI_LINK

Method Detail

create

public static WikiLinkExtension create()

rendererOptions

public void rendererOptions(@NotNull
                            @NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)

Specified by:

rendererOptions in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

Specified by:

rendererOptions in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)

Specified by:

parserOptions in interface com.vladsch.flexmark.parser.Parser.ParserExtension

extend

public void extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)

Specified by:

extend in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

extend

public void extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)

Specified by:

extend in interface com.vladsch.flexmark.parser.Parser.ParserExtension

extend

public void extend(@NotNull
                   com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder,
                   @NotNull
                   @NotNull String rendererType)

Specified by:

extend in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension