Overview
Span plugin for Markdown anchor shortcuts.
You can link to another page using [display text](http://example.com)
.
Alternatively, you can use defined links ...
Show [this link][id]. [id]: http://example.com
And a shorthand for defined links ...
Show the [example][]. [example]: http://example.com
Named-reference link definitions are captured in the prepare() phase by the StripLinkDefs plugin, and are used by both the Link plugin and the Image plugin.
Package
This class is part of the Solar_Markdown_Apidoc package.
Inheritance:
Solar_Markdown_Apidoc_Link
Configuration Keys
markdown
: The "parent" Markdown object.
Constants
None.
Public Properties
The Solar_Markdown_Apidoc_Link class has no public properties; try the list of all properties.
Public Methods
These are all the public methods in the Solar_Markdown_Apidoc_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 the source text after all parsing occurs.
-
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.
-
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()
-
Converts Markdown links into XHTML anchors.
-
prepare()
-
Prepares the source text before any parsing occurs.
-
reset()
-
Resets this plugin to its original state (for multiple parsings).
-
setMarkdown()
-
Sets the "parent" Markdown object.