forum/skins/default/templates/markdown_help.html

   1 {% extends "base_content.html" %}
   2 {% load extra_tags %}
   3 {% load humanize %}
   4 {% load i18n %}
   5
   6 {% block fulltitle %}{% spaceless %}{% trans "Markdown Help" %}{% endspaceless %}{% endblock %}
   7
   8 {% block forejs %}
   9     <link rel="stylesheet" type="text/css" media="all" href="{% media  "/media/style/markdown_help.css" %}" />
  10 {% endblock %}
  11
  12 {% block content %}
  13     <div id="main-wrapper"><br /><br />
  14         <div id="heading">
  15             <h1>Markdown Syntax</h1>
  16             <p>This document describes some of the more important parts of Markdown (for writers, that is).  There's a lot more to the syntax than is mentioned here, though.  To get the full syntax documentation, go to John Gruber's <a href="http://daringfireball.net/projects/markdown/syntax" rel="nofollow">Markdown Syntax</a> page</p>
  17         </div>
  18
  19         <div class="section">
  20             <h2 class="section-title">Headers</h2>
  21             <div class="section-description">
  22                 For top-level headers underline the text with equal signs.  For second-level headers use dashes to underline.
  23             </div>
  24             <table class="section-example"><tr>
  25                 <td>
  26                     <code>This is an H1 </code><br />
  27                     <code>============= </code>
  28                 </td>
  29                 <td>
  30                     <h1>This is an H1</h1>
  31                 </td>
  32             </tr></table>
  33
  34             <table class="section-example"><tr>
  35                 <td>
  36                     <code>This is an H2</code><br />
  37                     <code>-------------</code>
  38                 </td>
  39                 <td>
  40                     <h2>This is an H2</h2>
  41                 </td>
  42              </tr></table>
  43
  44             <div class="section-description">
  45                 If you would rather, you can prefix headers with a hash (#) symbol instead.  The number of hash symbols indicates the header level.  For example, a single hash indicates a header level of one while two indicates the second header level:
  46             </div>
  47             <table class="section-example"><tr>
  48                 <td>
  49                     <code># This is H1</code>
  50                 </td>
  51                 <td>
  52                     <h1>This is an H1</h1>
  53                 </td>
  54             </tr></table>
  55
  56             <table class="section-example"><tr>
  57                 <td>
  58                     <code>## This is H2</code>
  59                 </td>
  60                 <td>
  61                     <h2>This is an H2</h2>
  62                 </td>
  63             </tr></table>
  64
  65             <table class="section-example"><tr>
  66                 <td>
  67                     <code>### This is H3</code>
  68                 </td>
  69                 <td>
  70                     <h3>This is an H3</h3>
  71                 </td>
  72              </tr></table>
  73
  74             <div class="section-description">
  75                 Which you choose is a matter of style.  Whichever you thinks looks better in the text document.  In both cases, the final, fully formatted, document looks the same.
  76             </div>
  77         </div>
  78
  79         <div class="section">
  80             <h2 class="section-title">Paragraphs</h2>
  81             <div class="section-description">
  82                 Paragraphs are surrounded by blank lines.
  83             </div>
  84             <div class="section-example">
  85                 <code>This is paragraph one.</code>
  86             </div><br />
  87             <div class="section-example">
  88                 <code>This is paragraph two.</code>
  89             </div>
  90         </div>
  91
  92         <div class="section">
  93             <h2 class="section-title">Links</h2>
  94             <div class="section-description">
  95                 There are two parts to every link.
  96                 The first is the actual text that the user will see and it is surrounded by brackets.
  97                 The second is address of the page you wish to link to and it is surrounded in parenthesis.
  98             </div>
  99             <table class="section-example"><tr>
 100                 <td>
 101                     <code>[link text](http://example.com/)</code>
 102                 </td>
 103                 <td>
 104                     <a>link text</a>
 105                 </td>
 106             </tr></table>
 107         </div>
 108
 109         <div class="section">
 110             <h2 class="section-title">Formatting</h2>
 111             <div class="section-description">
 112                 To indicate bold text surround the text with two star (*) symbols or two underscore (_) symbols:
 113             </div>
 114             <table class="section-example"><tr>
 115                 <td>
 116                     <code>**This is bold**</code>
 117                 </td>
 118                 <td>
 119                     <strong>This is bold</strong>
 120                 </td>
 121             </tr></table>
 122             <table class="section-example"><tr>
 123                 <td>
 124                     <code>__This is also bold__</code>
 125                  </td>
 126                  <td>
 127                      <strong>This is also bold</strong>
 128                  </td>
 129              </tr></table>
 130
 131             <div class="section-description">
 132                 To indicate italicized text surround the text with a single star (*) symbol or underscore (_) symbol:
 133             </div>
 134             <table class="section-example"><tr>
 135                 <td>
 136                     <code>*This is italics*</code>
 137                 </td>
 138                 <td>
 139                     <i>This is italics</i>
 140                 </td>
 141             </tr></table>
 142             <table class="section-example"><tr>
 143                 <td>
 144                     <code>_This is also italics_</code>
 145                  </td>
 146                  <td>
 147                      <i>This is also italics</i>
 148                  </td>
 149              </tr></table>
 150
 151             <div class="section-description">
 152                 To indicate italicized and bold text surround the text with three star (*) symbol or underscore (_) symbol:
 153             </div>
 154             <table class="section-example"><tr>
 155                 <td>
 156                     <code>***This is bold and italics***</code>
 157                 </td>
 158                 <td>
 159                     <strong><i>This is italics</i></strong>
 160                 </td>
 161             </tr></table>
 162             <table class="section-example"><tr>
 163                 <td>
 164                     <code>___This is also bold and italics___</code>
 165                 </td>
 166                 <td>
 167                     <strong><i>This is italics</i></strong>
 168                 </td>
 169             </tr></table>
 170         </div>
 171
 172
 173         <div class="section">
 174             <h2 class="section-title">Blockquotes</h2>
 175             <div class="section-description">
 176                 To create an indented area use the right angle bracket (&gt;) character before each line to be included in the blockquote.
 177             </div>
 178             <table class="section-example"><tr>
 179                 <td>
 180                     <code>&gt; This is part of a blockquote.</code><br />
 181                     <code>&gt; This is part of the same blockquote.</code>
 182                 </td>
 183                 <td>
 184                     <p style="padding-left:15px;">This is part of a blockquote.<br />This is part of the same blockquote.</p>
 185                 </td>
 186             </tr></table>
 187
 188             <div class="section-description">
 189                 Rather than putting it in front of each line to include in the block quote you can put it at the beginning and end the quote with a newline.
 190             </div>
 191             <table class="section-example"><tr>
 192                 <td>
 193                     <code>&gt; This is part of a blockquote.</code><br />
 194                     <code>This continues the blockquote even though there's no bracket.</code><br /><br />
 195                     <code>The blank line ends the blockquote.</code>
 196                 </td>
 197                 <td>
 198                     <p style="padding-left:15px;">This is part of a blockquote. <br /> This continues the blockquote even though there's no bracket.</p>
 199                     <p>The blank line ends the blockquote.</p>
 200                 </td>
 201             </tr></table>
 202         </div>
 203
 204         <div class="section">
 205              <h2 class="section-title">Lists</h2>
 206              <div class="section-description">
 207                  To create a numbered list in Markdown, prefix each item in the list with a number followed by a period and space.  The number you use actually doesn't matter.
 208              </div>
 209              <table class="section-example"><tr>
 210                  <td>
 211                     <code>1. Item 1</code><br />
 212                     <code>2. Item 2</code><br />
 213                     <code>3. Item 3</code>
 214                  </td>
 215                  <td>
 216                     <ol>
 217                         <li>Item 1</li>
 218                         <li>Item 2</li>
 219                         <li>Item 3</li>
 220                     </ol>
 221                  </td>
 222              </tr></table>
 223
 224              <div class="section-description">
 225                  To create a bulleted list, prefix each item in the list with a star (*) character.
 226              </div>
 227              <table class="section-example"><tr>
 228                  <td>
 229                     <code>* A list item</code><br />
 230                     <code>* Another list item</code><br />
 231                     <code>* A third list item</code>
 232                  </td>
 233                  <td>
 234                     <ul>
 235                         <li>A list item</li>
 236                         <li>Another list item</li>
 237                         <li>A third list item</li>
 238                     </ul>
 239                  </td>
 240              </tr></table>
 241         </div>
 242
 243         <div class="section">
 244             <h2 class="section-title">A Lot More</h2>
 245             <div class="section-description">There's a lot more to the Markdown syntax than is mentioned here.  But for creative writers, this covers a lot of the necessities.  To find out more about Markdown than you'd ever want to really know, <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank" rel="nofollow">go to the Markdown page where it all started</a>.</div>
 246         </div>
 247     </div>
 248 {% endblock %}