Overview

Replaces wiki and interwiki links in source text with XHTML anchors.

Wiki links are in this format ...

[[wiki page]]
[[wiki page #anchor]]
[[wiki page]]s
[[wiki page | display this instead]]
[[wiki page #anchor | ]]

The "wiki page" name is normalized to "Wiki_page". The last example, the one with the blank display text, will not display the anchor fragment.

Page links are replaced with encoded placeholders. At cleanup() time, the placeholders are transformed into XHTML anchors.

This plugin also supports Interwiki links, in this format ...

[[site::page]]
[[site::page #anchor]]
[[site::page]]s
[[site::page | display this instead]]
[[site::page #anchor | ]]

Site prefixes and page names are not normalize. The last example, the one with the blank display text, will not display the site prefix or the anchor fragment.

Interwiki links are replaced with HTML immediately and are not checked for existence.

Package

This class is part of the Solar_Markdown_Wiki package.

Inheritance:

Configuration Keys

  • markdown: The "parent" Markdown object.

Constants

None.

Public Properties

The Solar_Markdown_Wiki_Link class has no public properties; try the list of all properties.

Public Methods

These are all the public methods in the Solar_Markdown_Wiki_Link class.

You can also view the list of all public, protected, and private methods.

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

cleanup()

Cleans up text to replace encoded placeholders with anchors.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

getChars()

Get the list of characters this plugin uses for parsing.

getInterwiki()

Gets the list of interwiki mappings.

getPages()

Gets the list of pages found in the source text.

isBlock()

Is this a block-level plugin?

isCleanup()

Run this plugin during the "cleanup" phase?

isPrepare()

Run this plugin during the "prepare" phase?

isSpan()

Is this a span-level plugin?

locale()

Looks up class-specific locale strings based on a key.

parse()

Parses the source text for wiki page and interwiki links.

prepare()

Prepares the source text before any parsing occurs.

reset()

Resets this plugin for a new transformation.

setAttrib()

Sets one anchor attribute.

setAttribs()

Sets all attributes for one anchor type.

setCheckPagesCallback()

Sets the callback to check if pages exist.

setInterwiki()

Sets one or more interwiki name and href mapping.

setMarkdown()

Sets the "parent" Markdown object.



Local