diff options
| author | John MacFarlane <jgm@berkeley.edu> | 2014-05-27 10:39:13 -0700 |
|---|---|---|
| committer | John MacFarlane <jgm@berkeley.edu> | 2014-05-27 10:39:13 -0700 |
| commit | 265f0e3da12f9d8f7c9d3677a71b387fb5e6ff5f (patch) | |
| tree | dd6457c349ff2a0bb897c05db1cbcf5e257b9872 | |
| parent | f1cd6af5ec091c7077468c13640e2a20d799566e (diff) | |
| download | pandoc-265f0e3da12f9d8f7c9d3677a71b387fb5e6ff5f.tar.gz | |
Fixed documentation of attributes. Closes #1315.
| -rw-r--r-- | README | 12 |
1 files changed, 8 insertions, 4 deletions
@@ -971,10 +971,8 @@ of the line containing the header text: {#identifier .class .class key=value key=value} -Although this syntax allows assignment of classes and key/value attributes, -only identifiers currently have any affect in the writers (and only in some -writers: HTML, LaTeX, ConTeXt, Textile, AsciiDoc). Thus, for example, -the following headers will all be assigned the identifier `foo`: +Thus, for example, the following headers will all be assigned the identifier +`foo`: # My header {#foo} @@ -985,6 +983,12 @@ the following headers will all be assigned the identifier `foo`: (This syntax is compatible with [PHP Markdown Extra].) +Note that although this syntax allows assignment of classes and key/value +attributes, writers generally don't use all of this information. Identifiers, +classes, and key/value attributes are used in HTML and HTML-based formats such +as EPUB and slidy. Identifiers are used for labels and link anchors in the +LaTeX, ConTeXt, Textile, and AsciiDoc writers. + Headers with the class `unnumbered` will not be numbered, even if `--number-sections` is specified. A single hyphen (`-`) in an attribute context is equivalent to `.unnumbered`, and preferable in non-English |