summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabio Bas <ctrlaltca@gmail.com>2014-02-12 16:08:12 +0100
committerFabio Bas <ctrlaltca@gmail.com>2014-08-23 12:41:45 +0200
commit8e4409a70876175ba8dc54e1a084c37a7861bfbf (patch)
treea7a2360f4d9442b24011a0f68919f17ee65c0eaa
parentaee7d6426cf1970308038dd032548c1efebd2f6e (diff)
Added quickstart doc for TMarkdown
-rw-r--r--demos/quickstart/protected/pages/Controls/Markdown.page40
-rwxr-xr-xdemos/quickstart/protected/pages/Controls/Samples/TMarkdown/Home.page31
-rwxr-xr-xdemos/quickstart/protected/pages/Controls/Standard.page4
3 files changed, 75 insertions, 0 deletions
diff --git a/demos/quickstart/protected/pages/Controls/Markdown.page b/demos/quickstart/protected/pages/Controls/Markdown.page
new file mode 100644
index 00000000..d7cc00c6
--- /dev/null
+++ b/demos/quickstart/protected/pages/Controls/Markdown.page
@@ -0,0 +1,40 @@
+<com:TContent ID="body" >
+
+<h1>TMarkdown</h1>
+<com:DocLink ClassPath="System.Web.UI.WebControls.TMarkdown" />
+
+<p class="block-content">
+<tt>TMarkdown</tt> is a text formatter that produces html content from plain text. The formatter follows the <a href="http://www.wikipedia.org/wiki/Markdown">Markdown</a> syntax and the <a href="https://help.github.com/articles/github-flavored-markdown">GFM</a> (GitHub Flavored Markdown) extension.
+</p>
+<p class="block-content">
+Any content in the body of <tt>TMarkdown</tt>, including both static text and the rendering results of its child controls, is first converted using the Markdown syntax. Then, to any code block found in the html, syntax highlighting is applied. The code being highlighted follows the syntax of the specified <tt>Language</tt>, which can be 'php' (default), 'prado', 'css', 'html', etc. Here, 'prado' stands for the syntax of PRADO control templates. If the language is not specified in the <tt>Language</tt> property, it can be evinced from the Markdown syntax.
+</p>
+<p class="block-content">
+If line numbers are desired in front of each line, set <tt>ShowLineNumbers</tt> to true.
+</p>
+<p class="block-content">
+To use <tt>TMarkdown</tt>, simply enclose the contents to be formatted within the body of a <tt>TMarkdown</tt> control. The following example formats some text and piece of PHP code,
+</p>
+<com:TTextHighlighter Language="prado" CssClass="source block-content" >
+&lt;com:TMarkdown ShowLineNumbers="true" &gt;
+PRADO Markdown Test
+===================
+
+Some text and a list:
+* item 1
+* item 2
+
+Now, some code:
+
+```php
+public function test() {
+ // comment
+ echo "look me i'm colorful";
+}
+```
+&lt;/com:TMarkdown&gt;
+</com:TTextHighlighter>
+
+<com:RunBar PagePath="Controls.Samples.TMarkdown.Home" />
+
+</com:TContent>
diff --git a/demos/quickstart/protected/pages/Controls/Samples/TMarkdown/Home.page b/demos/quickstart/protected/pages/Controls/Samples/TMarkdown/Home.page
new file mode 100755
index 00000000..4cd0f86b
--- /dev/null
+++ b/demos/quickstart/protected/pages/Controls/Samples/TMarkdown/Home.page
@@ -0,0 +1,31 @@
+<com:TContent ID="body">
+
+<h1>TMarkdown Samples</h1>
+
+<table class="sampletable">
+
+<tr><td class="samplenote">
+Formatting text and code:
+</td><td class="sampleaction">
+<com:TMarkdown ShowLineNumbers="true">
+PRADO Markdown Test
+===================
+
+Some text and a list:
+* item 1
+* item 2
+
+Now, some code:
+
+```php
+public function test() {
+ // comment
+ echo "look me i'm colorful";
+}
+```
+</com:TMarkdown>
+</td></tr>
+
+</table>
+
+</com:TContent>
diff --git a/demos/quickstart/protected/pages/Controls/Standard.page b/demos/quickstart/protected/pages/Controls/Standard.page
index bac51351..43fecfb3 100755
--- a/demos/quickstart/protected/pages/Controls/Standard.page
+++ b/demos/quickstart/protected/pages/Controls/Standard.page
@@ -106,6 +106,10 @@
</li>
<li>
+ <a href="?page=Controls.Markdown">TMarkdown</a> formats its body content following the <a href="http://www.wikipedia.org/wiki/Markdown">Markdown</a> syntax.
+ </li>
+
+ <li>
<a href="?page=Controls.MultiView">TMultiView</a> represents a container for a group of <tt>TView</tt> controls, each of which is container for other controls. At any time, at most one <tt>TView</tt> is visible.
</li>