python-markdown-doc 2.6.9-1 / usr / share / doc / python-markdown-doc / docs / extensions / smarty.html

This file is indexed.

/usr/share/doc/python-markdown-doc/docs/extensions/smarty.html is in python-markdown-doc 2.6.9-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<!DOCTYPE html>
<html>
<head>
<meta charset=utf-8>
<title>SmartyPants Extension &#8212; Python Markdown</title>
<link rel="stylesheet" href="../default.css" type="text/css">
</head>
<body>

<div class="related">
  <h3>Navigation</h3>
  <ul>
    <li class="right" style="margin-right: 10px">
      <a href="../siteindex.html" title="General Index">index</a></li>
    <li class="right">
      <a href="toc.html" title="Table of Contents Extension"
         accesskey="N">next</a> |</li>
    <li class="right">
      <a href="sane_lists.html" title="Sane Lists Extension"
         accesskey="P">previous</a> |</li>
    <li><img src="../py.png" alt=""
             style="vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="../index.html">Python Markdown v2.6.9 documentation</a> &raquo;</li>
    <li><a href="index.html">Extensions</a> &raquo;</li>
<li><a href="smarty.html">SmartyPants Extension</a> &raquo;</li>
  </ul>
</div> <!-- .related -->

<div class="document">
  <div class="documentwrapper">
    <div class="bodywrapper">
      <div class="body">
<h1 id="smartypants">SmartyPants<a class="headerlink" href="#smartypants" title="Permanent link">&para;</a></h1>
<h2 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">&para;</a></h2>
<p>The SmartyPants extension converts ASCII dashes, quotes and ellipses to
their HTML entity equivalents.</p>
<table>
<thead>
<tr>
<th>ASCII symbol</th>
<th>Replacements</th>
<th>HTML Entities</th>
<th>Substitution Keys</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>'</code></td>
<td>&lsquo; &rsquo;</td>
<td><code>&amp;lsquo;</code> <code>&amp;rsquo;</code></td>
<td><code>'left-single-quote'</code>, <code>'right-single-quote'</code></td>
</tr>
<tr>
<td><code>"</code></td>
<td>&ldquo; &rdquo;</td>
<td><code>&amp;ldquo;</code> <code>&amp;rdquo;</code></td>
<td><code>'left-double-quote'</code>, <code>'right-double-quote'</code></td>
</tr>
<tr>
<td><code>&lt;&lt; &gt;&gt;</code></td>
<td>&laquo; &raquo;</td>
<td><code>&amp;laquo;</code> <code>&amp;raquo;</code></td>
<td><code>'left-angle-quote'</code>, <code>'right-angle-quote'</code></td>
</tr>
<tr>
<td><code>...</code></td>
<td>&hellip;</td>
<td><code>&amp;hellip;</code></td>
<td><code>'ellipsis'</code></td>
</tr>
<tr>
<td><code>--</code></td>
<td>&ndash;</td>
<td><code>&amp;ndash;</code></td>
<td><code>'ndash'</code></td>
</tr>
<tr>
<td><code>---</code></td>
<td>&mdash;</td>
<td><code>&amp;mdash;</code></td>
<td><code>'mdash'</code></td>
</tr>
</tbody>
</table>
<p>Using the configuration option &lsquo;substitutions&rsquo; you can overwrite the
default substitutions. Just pass a dict mapping (a subset of) the 
keys to the substitution strings.</p>
<p>For example, one might use the following configuration to get correct quotes for 
the German language:</p>
<pre><code>extension_configs = {
    'markdown.extensions.smarty': {
        'substitutions': {
            'left-single-quote': '&amp;sbquo;', # sb is not a typo!
            'right-single-quote': '&amp;lsquo;',
            'left-double-quote': '&amp;bdquo;',
            'right-double-quote': '&amp;ldquo;'
        }
    }
}
</code></pre>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This extension re-implements the Python <a href="http://pythonhosted.org/smartypants/">SmartyPants</a> 
library by integrating it into the markdown parser.
While this does not provide any additional features,
it does offer a few advantages. Notably, it will not 
try to work on highlighted code blocks (using the 
<a href="code_hilite.html">CodeHilite</a> Extension) like the third party library 
has been known to do.</p>
</div>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
<p>See <a href="index.html">Extensions</a> for general extension usage, specify 
<code>markdown.extensions.smarty</code> as the name of the extension.</p>
<p>See the <a href="../reference.html#extensions">Library Reference</a> for information about
configuring extensions.</p>
<p>The following options are provided to configure the output:</p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>smart_dashes</code></td>
<td><code>True</code></td>
<td>whether to convert dashes</td>
</tr>
<tr>
<td><code>smart_quotes</code></td>
<td><code>True</code></td>
<td>whether to convert straight quotes</td>
</tr>
<tr>
<td><code>smart_angled_quotes</code></td>
<td><code>False</code></td>
<td>whether to convert angled quotes</td>
</tr>
<tr>
<td><code>smart_ellipses</code></td>
<td><code>True</code></td>
<td>whether to convert ellipses</td>
</tr>
<tr>
<td><code>substitutions</code></td>
<td><code>{}</code></td>
<td>overwrite default substitutions</td>
</tr>
</tbody>
</table>
<h2 id="further-reading">Further reading<a class="headerlink" href="#further-reading" title="Permanent link">&para;</a></h2>
<p>SmartyPants extension is based on the original SmartyPants implementation
by John Gruber. Please read it&rsquo;s <a href="http://daringfireball.net/projects/smartypants/">documentation</a> for details.</p>
      </div> <!-- .body -->
    </div> <!-- .bodywrapper -->
  </div> <!-- .documentwrapper -->

  <div class="sphinxsidebar">
    <div class="sphinxsidebarwrapper">
    <h3>Table Of Contents</h3>
    <div class="toc">
<ul>
<li><a href="#smartypants">SmartyPants</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#further-reading">Further reading</a></li>
</ul>
</li>
</ul>
</div>


    <h4>Previous topic</h4>
      <p class="topless"><a href="sane_lists.html"
         title="previous chapter">Sane Lists Extension</a></p>
    <h4>Next topic</h4>
      <p class="topless"><a href="toc.html"
         title="next chapter">Table of Contents Extension</a></p>
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="https://github.com/Python-Markdown/markdown/issues"
             >Report a Bug</a></li>
      <li><a href="smarty.txt"
             rel="nofollow">Show Source</a></li>
    </ul>
    </div> <!-- .sphinxsidebarwrapper -->
  </div> <!-- .sphinxsidebar -->

  <div class="clearer"></div>
</div> <!-- .document -->

<div class="related">
  <h3>Navigation</h3>
  <ul>
    <li class="right" style="margin-right: 10px">
      <a href="../siteindex.html" title="General Index">index</a></li>
    <li class="right">
      <a href="toc.html" title="Table of Contents Extension"
         accesskey="N">next</a> |</li>
    <li class="right">
      <a href="sane_lists.html" title="Sane Lists Extension"
         accesskey="P">previous</a> |</li>
    <li><img src="../py.png" alt=""
             style="vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="../index.html">Python Markdown v2.6.9 documentation</a> &raquo;</li>
    <li><a href="index.html">Extensions</a> &raquo;</li>
<li><a href="smarty.html">SmartyPants Extension</a> &raquo;</li>
  </ul>
</div> <!-- .related -->

<div class="footer">&copy; 2010-2012 Python Markdown Project</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.