Adding note about role="doc-endnotes" when using footnote_assembled.

This commit is contained in:
Michel Fortin 2018-03-16 23:49:14 -04:00
parent 5c5112694d
commit dfaa413aab
2 changed files with 12 additions and 1 deletions

View file

@ -90,6 +90,12 @@ class MarkdownExtra extends \Michelf\Markdown {
/**
* After parsing, the HTML for the list of footnotes appears here.
* This is available only if $omit_footnotes == true.
*
* Note: when placing the content of `footnotes_assembled` on the page,
* consider adding the attribute `role="doc-endnotes"` to the `div` or
* `section` that will enclose the list of footnotes so they are
* reachable to accessibility tools the same way they would be with the
* default HTML output.
* @var null|string
*/
public $footnotes_assembled = null;

View file

@ -181,7 +181,7 @@ PHP Markdown, please visit [michelf.ca/donate].
Version History
---------------
Current
Current Version
* Added configuration variable `omit_footnotes`. When `true` footnotes are not
appended at the end of the generated HTML and the `footnotes_assembled`
@ -189,6 +189,11 @@ Current
moved somewhere else on the page.
(Thanks to James K. for the implementation.)
Note: when placing the content of `footnotes_assembled` on the page, consider
adding the attribute `role="doc-endnotes"` to the `<div>` or `<section>` that will
enclose the list of footnotes so they are reachable to accessibility tools the
same way they would be with the default HTML output.
PHP Markdown Lib 1.8.0 (14 Jan 2018)