Mercurial > public > sg101

diff gpp/templates/core/markdown_help.html @ 127:2d299909e074

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adding markdown help to comments and forums. Still need to add it to a few other places that use the markItUp editor.
author Brian Neal <bgneal@gmail.com>
date Mon, 16 Nov 2009 01:00:28 +0000
parents
children ca7d619ee27b
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gpp/templates/core/markdown_help.html	Mon Nov 16 01:00:28 2009 +0000
@@ -0,0 +1,167 @@
+<table>
+   <tr><th>&nbsp;</th><th>Type This</th><th>To See This</th></tr>
+   <tr>
+      <th>Paragrahs</th>
+      <td>
+<pre>Paragraphs must be separated by a blank line.
+
+Here is another paragraph.
+</pre></td>
+      <td>
+         <p>Paragraphs must be separated by a blank line.</p>
+         <p>Here is another paragraph.</p>
+      </td>
+   </tr>
+   <tr>
+      <th>Manual Line Breaks</th>
+      <td>
+<pre>To insert a line break  
+end a line with two or more spaces.
+</pre></td>
+      <td>
+         <p>To insert a line break <br />
+         end a line with two or more spaces.</p>
+      </td>
+   </tr>
+   <tr>
+      <th>Emphasis</th>
+      <td>
+<pre>*italic*
+_italic_
+**bold**
+__bold__</pre></td>
+      <td><i>italic</i><br />
+         <i>italic</i><br />
+         <b>bold</b><br />
+         <b>bold</b></td>
+   </tr>
+   <tr>
+      <th>Inline links</th>
+      <td>A link to [Google](http://google.com).</td>
+      <td>A link to <a href="http://google.com">Google</a>.</td>
+   </tr>
+   <tr>
+      <th>Reference links</th>
+      <td>A link to [Google][id]. Then anywhere else in the
+         text, define the link on its own line.<br/>
+         [id]: http://google.com </td>
+      <td>A link to <a href="http://google.com">Google</a>. Then
+      anywhere else in the text, define the link on its own line.</td>
+   </tr>
+   <tr>
+      <th>Inline Images</th>
+      <td>![alt text](/static/icons/emoticon_smile.png "Smile").</td>
+      <td><img src="/static/icons/emoticon_smile.png" alt="alt text" title="Smile" /></td>
+   </tr>
+   <tr>
+      <th>Reference Images</th>
+      <td>![alt text][id]<br />
+      [id]: /static/icons/emoticon_smile.png "Smile"</td>
+      </td>
+      <td><img src="/static/icons/emoticon_smile.png" alt="alt text" title="Smile" /></td>
+   </tr>
+   <tr>
+      <th>Bullet List</th>
+      <td>
+      <pre>* One
+* Two
+* Three</pre></td>
+      <td>
+         <ul>
+         <li>One</li>
+         <li>Two</li>
+         <li>Three</li>
+         </ul>
+      </td>
+   </tr>
+   <tr>
+      <th>Numbered List</th>
+      <td>
+      <pre>1. One
+1. Two
+1. Three</pre></td>
+      <td>
+         <ol>
+         <li>One</li>
+         <li>Two</li>
+         <li>Three</li>
+         </ol>
+      </td>
+   </tr>
+   <tr>
+      <th>Blockquotes</th>
+      <td><pre>John said:
+&gt; Email style angle brackets
+&gt; are used for quotes.</pre></td>
+      <td><p>John said:</p>
+         <blockquote><p>Email-style angle brackets are used for blockquotes.</p></blockquote></td>
+   </tr>
+   <tr>
+      <th>Code Spans</th>
+      <td><pre>`&lt;code&gt;` spans are delimited by backticks.</pre></td>
+      <td><p><code>&lt;code&gt;</code> spans are delimited by backticks.</p></td>
+   </tr>
+   <tr>
+      <th>Code Blocks</th>
+      <td><pre>First insert a blank line.
+
+    Then indent every line 
+    of a code block by at least
+    4 spaces. This is useful to 
+    display tablature.
+</pre></td>
+      <td>
+<p>First insert a blank line.</p>
+
+<pre><code>Then indent every line 
+of a code block by at least
+4 spaces. This is useful to 
+display tablature.
+</code></pre>
+      </td>
+   </tr>
+   <tr>
+      <th>Header 1</th>
+      <td>
+      <pre>Header 1
+========
+</pre></td>
+      <td><h1>Header 1</h1></td>
+   </tr>
+   <tr>
+      <th>Header 2</th>
+      <td>
+      <pre>Header 2
+--------
+</pre></td>
+      <td><h2>Header 2</h2></td>
+   </tr>
+   <tr>
+      <th>Header 1</th>
+      <td><pre># Header 1</pre></td>
+      <td><h1>Header 1</h1></td>
+   </tr>
+   <tr>
+      <th>Header 2</th>
+      <td><pre>## Header 2</pre></td>
+      <td><h2>Header 2</h2></td>
+   </tr>
+   <tr>
+      <th>Header 3</th>
+      <td><pre>### Header 3</pre></td>
+      <td><h3>Header 3</h3></td>
+   </tr>
+   <tr>
+      <th>Header 6</th>
+      <td><pre>###### Header 6</pre></td>
+      <td><h6>Header 6</h6></td>
+   </tr>
+</table>
+<p>
+More help:
+</p>
+<ul>
+   <li><a href="http://daringfireball.net/projects/markdown/basics" target="_blank">Markdown Basics</a></li>
+   <li><a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown Reference</a></li>
+</ul>
+<p>Hit <code>ESC</code> or click the <code>X</code> to close this window.</p>