Overview
Span plugin to change `text` to <literal>text</literal>.
Backtick quotes are used for <code></code> spans.
You can use multiple backticks as the delimiters if you want to include literal backticks in the code span. So, this input ...
Just type ``foo `bar` baz`` at the prompt.
... will translate to ...
<para>Just type <literal>foo `bar` baz</literal> at the prompt.</para>
There's no arbitrary limit to the number of backticks you can use as delimters. If you need three consecutive backticks in your code, use four for delimiters, etc.
You can use spaces to get literal backticks at the edges ...
type `` `bar` ``
... which turns into ...
type <literal>`bar`</literal>
Package
This class is part of the Solar_Markdown_Apidoc package.
Inheritance:
Solar_Markdown_Plugin_CodeSpan
Solar_Markdown_Apidoc_Literal
Configuration Keys
markdown: The "parent" Markdown object.
Constants
None.
Public Properties
The Solar_Markdown_Apidoc_Literal class has no public properties; try the list of all properties.
Public Methods
These are all the public methods in the Solar_Markdown_Apidoc_Literal 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() -
Creates code spans from backtick-delimited text.
-
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.