Overview
Block plugin to convert Markdown headers into XHTML headers.
This plugin is just like the normal Markdown header plugin, but lets you set an ID on the header using {#id-word} after the header text.
For Setext-style headers, this code ...
Header 1 {#id-word1}
===================
Header 2 {#id-word2}
-------------------
... would become ...
<h1 id="id-word1">Header 1</h1> <h2 id="id-word2">Header 2</h2>
The same applies for ATX-style headers.
Package
This class is part of the Solar_Markdown_Extra package.
Inheritance:
Solar_Markdown_Extra_Header
Configuration Keys
markdown: The "parent" Markdown object.
Constants
None.
Public Properties
The Solar_Markdown_Extra_Header class has no public properties; try the list of all properties.
Public Methods
These are all the public methods in the Solar_Markdown_Extra_Header 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() -
Turns ATX- and setext-style headers into XHTML header tags.
-
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.