aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/abbreviations.md
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2011-08-23 10:53:49 -0400
committerWaylan Limberg <waylan@gmail.com>2011-08-23 10:53:49 -0400
commita6fd7b5cba69cad049046b3a372d0f2d6c495abe (patch)
tree42a8987d08eb5a05eb2b3cb1399540583e8cbf67 /docs/extensions/abbreviations.md
parente5b2813bbf02710c7deb148896085a3dac4828dc (diff)
downloadmarkdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.tar.gz
markdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.tar.bz2
markdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.zip
Renamed *.txt -> *.md in docs.
Diffstat (limited to 'docs/extensions/abbreviations.md')
-rw-r--r--docs/extensions/abbreviations.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/extensions/abbreviations.md b/docs/extensions/abbreviations.md
new file mode 100644
index 0000000..fa54d3c
--- /dev/null
+++ b/docs/extensions/abbreviations.md
@@ -0,0 +1,53 @@
+Abbreviations
+-------------
+
+Summary
+-------
+
+The Markdown Abbreviation Extension adds the ability to define abbreviations.
+Specifically, any defined abbreviation is wrapped in an `<abbr>` tag.
+
+The Abbreviation extension is included in the standard Markdown library.
+
+Syntax
+------
+
+Abbreviations are defined using the syntax established in
+[PHP Markdown Extra][php].
+
+[php]: http://www.michelf.com/projects/php-markdown/extra/#abbr
+
+Thus, the following text (taken from the above referenced PHP documentation):
+
+ The HTML specification
+ is maintained by the W3C.
+
+ *[HTML]: Hyper Text Markup Language
+ *[W3C]: World Wide Web Consortium
+
+will be rendered like so:
+
+ <p>The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
+ is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>
+
+Usage
+-----
+
+From the Python interpreter:
+
+ >>> import markdown
+ >>> text = """
+ ... Some text with an ABBR.
+ ...
+ ... *[ABBR]: Abbreviation
+ ... """
+ >>> html = markdown.markdown(text, ['abbr'])
+
+To use with other extensions, just add them to the list, like this:
+
+ >>> html = markdown.markdown(text, ['abbr', 'footnotes'])
+
+Abbreviations can also be called from the command line using Markdown's `-x`
+parameter, like so:
+
+ markdown.py -x abbr source.txt > output.html