diff options
| author | Waylan Limberg <waylan@gmail.com> | 2014-01-01 16:25:07 -0500 |
|---|---|---|
| committer | Waylan Limberg <waylan@gmail.com> | 2014-01-01 16:25:07 -0500 |
| commit | 8be64bb9ffa2a6f7f4f69e98dc6c415a1243e884 (patch) | |
| tree | 0d804b22ec0791537dabb58a59d377c38881361c /docs/extensions | |
| parent | 2587fae92e504795c146055c595a9bc538a9665f (diff) | |
| download | python-markdown-8be64bb9ffa2a6f7f4f69e98dc6c415a1243e884.tar.gz | |
Updated footnote documentation for clarity.
This addresses a misunderstanding reported in issue #273. The behavior has not changed. The docs just better reflect the actual behavior better. Apparently using the word "definition" both for footnotes and definition lists was an unfortunate coincidence that created confusion. We now use the term "footnote content".
Diffstat (limited to 'docs/extensions')
| -rw-r--r-- | docs/extensions/footnotes.txt | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/docs/extensions/footnotes.txt b/docs/extensions/footnotes.txt index 1d6593c..d888ba1 100644 --- a/docs/extensions/footnotes.txt +++ b/docs/extensions/footnotes.txt @@ -26,17 +26,30 @@ the output. Example: - Footnotes[^1] have a label[^label] and a definition[^!DEF]. + Footnotes[^1] have a label[^@#$%] and the footnote's content. - [^1]: This is a footnote - [^label]: A footnote on "label" - [^!DEF]: The definition of a footnote. + [^1]: This is a footnote's content. + [^@#$%]: A footnote on the label: "@#$%". -A footnote definition may contain multiple lines, paragraphs, code blocks, -blockquotes and most any other markdown syntax. The additional line simply -must be indented at least an additional four spaces. +A footnote label must start with a carot `^` and may contain any inline text +(including spaces) between a set of square brackets `[]`. Only the first +carot has any special meaning. - [^1]: The first paragraph of the definition. +A footnote's content must start with the label followed by a colon and at least +one space. The label used to define the content must exactly match the label used +in the body (inlcuding capitalization and whitespace). The content would then +follow the label either on the same line or on the next line. The content may +contain multiple lines, paragraphs, code blocks, blockquotes and most any other +markdown syntax. The additional lines must be indented one level (four spaces or +one tab). + +When working with mutiple blocks, it may be helpful to start the content on a +seperate line from the label which defines the content. This way the entire block +is indented consistantly and any errors are more easily disernable by the author. + + + [^1]: + The first paragraph of the definition. Paragraph two of the definition. |