mirror of
https://github.com/OrchardCMS/Orchard.git
synced 2025-10-15 19:54:57 +08:00
Adding Markdown module
--HG-- branch : 1.x
This commit is contained in:
Sebastien Ros
433
lib/markdown/MarkdownSharp.xml
Normal file
433
lib/markdown/MarkdownSharp.xml
Normal file
@@ -0,0 +1,433 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>MarkdownSharp</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:MarkdownSharp.IMarkdownOptions.AutoHyperlink">
|
||||
<summary>
|
||||
when true, (most) bare plain URLs are auto-hyperlinked
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.IMarkdownOptions.AutoNewLines">
|
||||
<summary>
|
||||
when true, RETURN becomes a literal newline
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.IMarkdownOptions.EmptyElementSuffix">
|
||||
<summary>
|
||||
use ">" for HTML output, or " />" for XHTML output
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.IMarkdownOptions.EncodeProblemUrlCharacters">
|
||||
<summary>
|
||||
when true, problematic URL characters like [, ], (, and so forth will be encoded
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.IMarkdownOptions.LinkEmails">
|
||||
<summary>
|
||||
when false, email addresses will never be auto-linked
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.IMarkdownOptions.StrictBoldItalic">
|
||||
<summary>
|
||||
when true, bold and italic require non-word characters on either side
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MarkdownSharp.Markdown">
|
||||
<summary>
|
||||
Markdown is a text-to-HTML conversion tool for web writers.
|
||||
Markdown allows you to write using an easy-to-read, easy-to-write plain text format,
|
||||
then convert it to structurally valid XHTML (or HTML).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MarkdownSharp.Markdown._nestDepth">
|
||||
<summary>
|
||||
maximum nested depth of [] and () supported by the transform; implementation detail
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MarkdownSharp.Markdown._tabWidth">
|
||||
<summary>
|
||||
Tabs are automatically converted to spaces as part of the transform
|
||||
this constant determines how "wide" those tabs become in spaces
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.#ctor">
|
||||
<summary>
|
||||
Create a new Markdown instance using default options
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.#ctor(MarkdownSharp.IMarkdownOptions)">
|
||||
<summary>
|
||||
Create a new Markdown instance and optionally load options from the supplied options parameter.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.#ctor(System.Boolean)">
|
||||
<summary>
|
||||
Create a new Markdown instance and optionally load options from a configuration
|
||||
file. There they should be stored in the appSettings section, available options are:
|
||||
|
||||
Markdown.StrictBoldItalic (true/false)
|
||||
Markdown.EmptyElementSuffix (">" or " />" without the quotes)
|
||||
Markdown.LinkEmails (true/false)
|
||||
Markdown.AutoNewLines (true/false)
|
||||
Markdown.AutoHyperlink (true/false)
|
||||
Markdown.EncodeProblemUrlCharacters (true/false)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.#cctor">
|
||||
<summary>
|
||||
In the static constuctor we'll initialize what stays the same across all transforms.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.Transform(System.String)">
|
||||
<summary>
|
||||
Transforms the provided Markdown-formatted text to HTML;
|
||||
see http://en.wikipedia.org/wiki/Markdown
|
||||
</summary>
|
||||
<remarks>
|
||||
The order in which other subs are called here is
|
||||
essential. Link and image substitutions need to happen before
|
||||
EscapeSpecialChars(), so that any *'s or _'s in the a
|
||||
and img tags get encoded.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.RunBlockGamut(System.String)">
|
||||
<summary>
|
||||
Perform transformations that form block-level tags like paragraphs, headers, and list items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.RunSpanGamut(System.String)">
|
||||
<summary>
|
||||
Perform transformations that occur *within* block-level tags like paragraphs, headers, and list items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.FormParagraphs(System.String)">
|
||||
<summary>
|
||||
splits on two or more newlines, to form "paragraphs";
|
||||
each paragraph is then unhashed (if it is a hash) or wrapped in HTML p tag
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.GetNestedBracketsPattern">
|
||||
<summary>
|
||||
Reusable pattern to match balanced [brackets]. See Friedl's
|
||||
"Mastering Regular Expressions", 2nd Ed., pp. 328-331.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.GetNestedParensPattern">
|
||||
<summary>
|
||||
Reusable pattern to match balanced (parens). See Friedl's
|
||||
"Mastering Regular Expressions", 2nd Ed., pp. 328-331.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.StripLinkDefinitions(System.String)">
|
||||
<summary>
|
||||
Strips link definitions from text, stores the URLs and titles in hash references.
|
||||
</summary>
|
||||
<remarks>
|
||||
^[id]: url "optional title"
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.GetBlockPattern">
|
||||
<summary>
|
||||
derived pretty much verbatim from PHP Markdown
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.HashHTMLBlocks(System.String)">
|
||||
<summary>
|
||||
replaces any block-level HTML blocks with hash entries
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.TokenizeHTML(System.String)">
|
||||
<summary>
|
||||
returns an array of HTML tokens comprising the input string. Each token is
|
||||
either a tag (possibly with nested, tags contained therein, such
|
||||
as <a href="<MTFoo>">, or a run of text between tags. Each element of the
|
||||
array is a two-element array; the first is either 'tag' or 'text'; the second is
|
||||
the actual value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoAnchors(System.String)">
|
||||
<summary>
|
||||
Turn Markdown link shortcuts into HTML anchor tags
|
||||
</summary>
|
||||
<remarks>
|
||||
[link text](url "title")
|
||||
[link text][id]
|
||||
[id]
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoImages(System.String)">
|
||||
<summary>
|
||||
Turn Markdown image shortcuts into HTML img tags.
|
||||
</summary>
|
||||
<remarks>
|
||||
![alt text][id]
|
||||
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoHeaders(System.String)">
|
||||
<summary>
|
||||
Turn Markdown headers into HTML header tags
|
||||
</summary>
|
||||
<remarks>
|
||||
Header 1
|
||||
========
|
||||
|
||||
Header 2
|
||||
--------
|
||||
|
||||
# Header 1
|
||||
## Header 2
|
||||
## Header 2 with closing hashes ##
|
||||
...
|
||||
###### Header 6
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoHorizontalRules(System.String)">
|
||||
<summary>
|
||||
Turn Markdown horizontal rules into HTML hr tags
|
||||
</summary>
|
||||
<remarks>
|
||||
***
|
||||
* * *
|
||||
---
|
||||
- - -
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoLists(System.String)">
|
||||
<summary>
|
||||
Turn Markdown lists into HTML ul and ol and li tags
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.ProcessListItems(System.String,System.String)">
|
||||
<summary>
|
||||
Process the contents of a single ordered or unordered list, splitting it
|
||||
into individual list items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoCodeBlocks(System.String)">
|
||||
<summary>
|
||||
/// Turn Markdown 4-space indented code into HTML pre code blocks
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoCodeSpans(System.String)">
|
||||
<summary>
|
||||
Turn Markdown `code spans` into HTML code tags
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoItalicsAndBold(System.String)">
|
||||
<summary>
|
||||
Turn Markdown *italics* and **bold** into HTML strong and em tags
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoHardBreaks(System.String)">
|
||||
<summary>
|
||||
Turn markdown line breaks (two space at end of line) into HTML break tags
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoBlockQuotes(System.String)">
|
||||
<summary>
|
||||
Turn Markdown > quoted blocks into HTML blockquote blocks
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.DoAutoLinks(System.String)">
|
||||
<summary>
|
||||
Turn angle-delimited URLs into HTML anchor tags
|
||||
</summary>
|
||||
<remarks>
|
||||
<http://www.example.com>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.Outdent(System.String)">
|
||||
<summary>
|
||||
Remove one level of line-leading spaces
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.EncodeEmailAddress(System.String)">
|
||||
<summary>
|
||||
encodes email address randomly
|
||||
roughly 10% raw, 45% hex, 45% dec
|
||||
note that @ is always encoded and : never is
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.EncodeCode(System.String)">
|
||||
<summary>
|
||||
Encode/escape certain Markdown characters inside code blocks and spans where they are literals
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.EncodeAmpsAndAngles(System.String)">
|
||||
<summary>
|
||||
Encode any ampersands (that aren't part of an HTML entity) and left or right angle brackets
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.EscapeBackslashes(System.String)">
|
||||
<summary>
|
||||
Encodes any escaped characters such as \`, \*, \[ etc
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.Unescape(System.String)">
|
||||
<summary>
|
||||
swap back in all the special characters we've hidden
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.EscapeBoldItalic(System.String)">
|
||||
<summary>
|
||||
escapes Bold [ * ] and Italic [ _ ] characters
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.EncodeProblemUrlChars(System.String)">
|
||||
<summary>
|
||||
hex-encodes some unusual "problem" chars in URLs to avoid URL detection problems
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.EscapeSpecialCharsWithinTagAttributes(System.String)">
|
||||
<summary>
|
||||
Within tags -- meaning between < and > -- encode [\ ` * _] so they
|
||||
don't conflict with their use in Markdown for code, italics and strong.
|
||||
We're replacing each such character with its corresponding hash
|
||||
value; this is likely overkill, but it should prevent us from colliding
|
||||
with the escape values by accident.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.Normalize(System.String)">
|
||||
<summary>
|
||||
convert all tabs to _tabWidth spaces;
|
||||
standardizes line endings from DOS (CR LF) or Mac (CR) to UNIX (LF);
|
||||
makes sure text ends with a couple of newlines;
|
||||
removes any blank lines (only spaces) in the text
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.Markdown.RepeatString(System.String,System.Int32)">
|
||||
<summary>
|
||||
this is to emulate what's evailable in PHP
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.Markdown.Version">
|
||||
<summary>
|
||||
current version of MarkdownSharp;
|
||||
see http://code.google.com/p/markdownsharp/ for the latest code or to contribute
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.#cctor">
|
||||
<summary>
|
||||
Static constructor
|
||||
</summary>
|
||||
<remarks>
|
||||
In the static constuctor we'll initialize what stays the same across all transforms.
|
||||
</remarks>
|
||||
</member>
|
||||
<!-- Badly formed XML comment ignored for member "M:MarkdownSharp.MarkdownOld.Transform(System.String)" -->
|
||||
<member name="M:MarkdownSharp.MarkdownOld.StripLinkDefinitions(System.String)">
|
||||
<summary>
|
||||
Strips link definitions from text, stores the URLs and titles in hash references.
|
||||
</summary>
|
||||
<remarks>Link defs are in the form: ^[id]: url "optional title"</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.HashHTMLBlocks(System.String)">
|
||||
<summary>
|
||||
Hashify HTML blocks
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.RunBlockGamut(System.String)">
|
||||
<summary>
|
||||
These are all the transformations that form block-level
|
||||
tags like paragraphs, headers, and list items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.RunSpanGamut(System.String)">
|
||||
<summary>
|
||||
These are all the transformations that occur *within* block-level
|
||||
tags like paragraphs, headers, and list items.
|
||||
</summary>
|
||||
</member>
|
||||
<!-- Badly formed XML comment ignored for member "M:MarkdownSharp.MarkdownOld.TokenizeHTML(System.String)" -->
|
||||
<!-- Badly formed XML comment ignored for member "M:MarkdownSharp.MarkdownOld.DoAnchors(System.String)" -->
|
||||
<!-- Badly formed XML comment ignored for member "M:MarkdownSharp.MarkdownOld.DoImages(System.String)" -->
|
||||
<member name="M:MarkdownSharp.MarkdownOld.ProcessListItems(System.String,System.String)">
|
||||
<summary>
|
||||
Process the contents of a single ordered or unordered list, splitting it
|
||||
into individual list items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.EncodeCode(System.String)">
|
||||
<summary>
|
||||
Encode/escape certain characters inside Markdown code runs.
|
||||
</summary>
|
||||
<remarks>
|
||||
The point is that in code, these characters are literals, and lose their
|
||||
special Markdown meanings.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.EncodeAmpsAndAngles(System.String)">
|
||||
<summary>
|
||||
Smart processing for ampersands and angle brackets that need to be encoded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.UnescapeSpecialChars(System.String)">
|
||||
<summary>
|
||||
Swap back in all the special characters we've hidden.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.Outdent(System.String)">
|
||||
<summary>
|
||||
Remove one level of line-leading tabs or spaces
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.RepeatString(System.String,System.Int32)">
|
||||
<summary>
|
||||
This is to emulate what's evailable in PHP
|
||||
</summary>
|
||||
<param name="text"></param>
|
||||
<param name="count"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:MarkdownSharp.MarkdownOld.ComputeMD5(System.String)">
|
||||
<summary>
|
||||
Calculate an MD5 hash of an arbitrary string
|
||||
</summary>
|
||||
<param name="text"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.MarkdownOptions.AutoHyperlink">
|
||||
<summary>
|
||||
when true, (most) bare plain URLs are auto-hyperlinked
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.MarkdownOptions.AutoNewLines">
|
||||
<summary>
|
||||
when true, RETURN becomes a literal newline
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.MarkdownOptions.EmptyElementSuffix">
|
||||
<summary>
|
||||
use ">" for HTML output, or " />" for XHTML output
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.MarkdownOptions.EncodeProblemUrlCharacters">
|
||||
<summary>
|
||||
when true, problematic URL characters like [, ], (, and so forth will be encoded
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.MarkdownOptions.LinkEmails">
|
||||
<summary>
|
||||
when false, email addresses will never be auto-linked
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MarkdownSharp.MarkdownOptions.StrictBoldItalic">
|
||||
<summary>
|
||||
when true, bold and italic require non-word characters on either side
|
||||
WARNING: this is a significant deviation from the markdown spec
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Reference in New Issue
Block a user