src/cm/templates/static/help_format.html
author Simon Descarpentries <sid@sopinspace.com>
Mon, 21 Oct 2013 16:37:07 +0200
changeset 553 bf26fb47a14c
parent 0 40c8f766c9b8
permissions -rw-r--r--
To allow scrolling in Safari mobile, we set the content of text_view_comments frame in a jQuery UI layout. So the automated scrolling operations in c_sync.js must be adjustable to the right part to scroll. Also, if a comment have to be shown outside of the current viewport, we scroll the correct part to that viewport and then set the comment top Y offset to juste what it needs to avoid the "Add comment" button after scrolling operation. If not in Safari mobile, we add an offset here to avoid comment to display under the "Add comment" button.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     1
<h3>Phrase Emphasis</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     2
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     3
<pre><code>*italic*   **bold**
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     4
_italic_   __bold__
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     5
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     6
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     7
<h3>Links</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     8
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     9
<p>Inline:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    10
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    11
<pre><code>An [example](http://url.com/ "Title")
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    12
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    13
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    14
<p>Reference-style labels (titles are optional):</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    15
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    16
<pre><code>An [example][id]. Then, anywhere
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    17
else in the doc, define the link:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    18
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    19
   [id]: http://example.com/  "Title"
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    20
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    21
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    22
<h3>Images</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    23
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    24
<p>Inline (titles are optional):</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    25
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    26
<pre><code>![alt text](/path/img.jpg "Title")
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    27
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    28
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    29
<p>Reference-style:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    30
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    31
<pre><code>![alt text][id]
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    32
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    33
    [id]: /url/to/img.jpg "Title"
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    34
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    35
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    36
<h3>Headers</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    37
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    38
<p>Setext-style:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    39
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    40
<pre><code>Header 1
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    41
========
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    42
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    43
Header 2
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    44
--------
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    45
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    46
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    47
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    48
<p>atx-style (closing #'s are optional):</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    49
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    50
<pre><code># Header 1 #</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    51
<pre><code>## Header 2 ##</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    52
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    53
<h3>Lists</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    54
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    55
<p>Ordered, without paragraphs:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    56
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    57
<pre><code>1.  Foo
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    58
2.  Bar
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    59
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    60
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    61
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    62
<p>Unordered, with paragraphs:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    63
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    64
<pre><code>*   A list item.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    65
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    66
    With multiple paragraphs.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    67
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    68
*   Bar
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    69
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    70
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    71
<p>You can nest them:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    72
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    73
<pre><code>*   First list
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    74
*   Illas
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    75
    1. first item
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    76
    2. second item
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    77
       * nested item
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    78
    3. third item
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    79
*   back to first list
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    80
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    81
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    82
<h3>Blockquotes</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    83
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    84
<pre><code>&gt; Email-style angle brackets
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    85
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    86
&gt; are used for blockquotes.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    87
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    88
&gt; &gt; And, they can be nested.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    89
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    90
&gt; &gt;
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    91
&gt; * You can quote a list.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    92
&gt; * Etc.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    93
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    94
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    95
<h3>Code Spans</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    96
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    97
<pre><code>`&lt;code&gt;` spans are delimited
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    98
by backticks.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    99
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   100
You can include literal backticks
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   101
like `` `this` ``.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   102
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   103
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   104
<h3>Preformatted Code Blocks</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   105
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   106
<p>Indent every line of a code block by at least 4 spaces or 1 tab, and use a colon at the end of the preceding paragraph.</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   107
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   108
<pre><code>This is a normal paragraph:
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   109
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   110
    This is a preformatted
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   111
    code block.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   112
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   113
Preceded by a space, the colon
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   114
disappears. :
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   115
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   116
    This is a preformatted
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   117
    code block.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   118
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   119
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   120
<h3>Horizontal Rules</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   121
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   122
<p>Three or more dashes or asterisks:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   123
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   124
<pre><code>---
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   125
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   126
* * *
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   127
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   128
- - - -
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   129
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   130
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   131
<h3>Manual Line Breaks</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   132
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   133
<p>End a line with two or more spaces:</p>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   134
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   135
<pre><code>Roses are red,
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   136
Violets are blue.
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   137
</code></pre>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   138
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
   139