• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1title: Abbreviations Extension
2
3Abbreviations
4=============
5
6Summary
7-------
8
9The Abbreviations extension adds the ability to define abbreviations.
10Specifically, any defined abbreviation is wrapped in  an `<abbr>` tag.
11
12The Abbreviations extension is included in the standard Markdown library.
13
14Syntax
15------
16
17Abbreviations are defined using the syntax established in
18[PHP Markdown Extra][php].
19
20[php]: http://www.michelf.com/projects/php-markdown/extra/#abbr
21
22Thus, the following text (taken from the above referenced PHP documentation):
23
24```md
25The HTML specification
26is maintained by the W3C.
27
28*[HTML]: Hyper Text Markup Language
29*[W3C]:  World Wide Web Consortium
30```
31
32will be rendered as:
33
34```html
35<p>The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
36is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>
37```
38
39Usage
40-----
41
42See [Extensions](index.md) for general extension usage. Use `abbr` as the name
43of the extension.
44
45This extension does not accept any special configuration options.
46
47A trivial example:
48
49```python
50markdown.markdown(some_text, extensions=['abbr'])
51```
52