From fe91e572bb6075907ae6093bdf54311f2dc3b8e8 Mon Sep 17 00:00:00 2001 From: Peter Dias Date: Wed, 13 Jan 2021 10:33:01 +0800 Subject: [PATCH 1/2] MDL-70296 core: Upgrade markdown lib --- lib/markdown/Markdown.php | 29 ++- lib/markdown/MarkdownExtra.php | 283 +++++++++++++++++++---------- lib/markdown/MarkdownInterface.php | 2 +- lib/markdown/Readme.md | 44 ++++- 4 files changed, 242 insertions(+), 116 deletions(-) diff --git a/lib/markdown/Markdown.php b/lib/markdown/Markdown.php index dc8477377cd..43b3c79e851 100644 --- a/lib/markdown/Markdown.php +++ b/lib/markdown/Markdown.php @@ -4,7 +4,7 @@ * * @package php-markdown * @author Michel Fortin - * @copyright 2004-2018 Michel Fortin + * @copyright 2004-2019 Michel Fortin * @copyright (Original Markdown) 2004-2006 John Gruber */ @@ -18,7 +18,7 @@ class Markdown implements MarkdownInterface { * Define the package version * @var string */ - const MARKDOWNLIB_VERSION = "1.8.0"; + const MARKDOWNLIB_VERSION = "1.9.0"; /** * Simple function interface - Initialize the parser and return the result @@ -85,25 +85,25 @@ class Markdown implements MarkdownInterface { /** * Optional filter function for URLs - * @var callable + * @var callable|null */ public $url_filter_func = null; /** * Optional header id="" generation callback function. - * @var callable + * @var callable|null */ public $header_id_func = null; /** * Optional function for converting code block content to HTML - * @var callable + * @var callable|null */ public $code_block_content_func = null; /** * Optional function for converting code span content to HTML. - * @var callable + * @var callable|null */ public $code_span_content_func = null; @@ -767,16 +767,15 @@ class Markdown implements MarkdownInterface { * @return string */ protected function _doAnchors_inline_callback($matches) { - $whole_match = $matches[1]; $link_text = $this->runSpanGamut($matches[2]); - $url = $matches[3] == '' ? $matches[4] : $matches[3]; + $url = $matches[3] === '' ? $matches[4] : $matches[3]; $title =& $matches[7]; // If the URL was of the form it got caught by the HTML // tag parser and hashed. Need to reverse the process before using // the URL. $unhashed = $this->unhash($url); - if ($unhashed != $url) + if ($unhashed !== $url) $url = preg_replace('/^<(.*)>$/', '\1', $unhashed); $url = $this->encodeURLAttribute($url); @@ -1218,7 +1217,7 @@ class Markdown implements MarkdownInterface { $codeblock = $matches[1]; $codeblock = $this->outdent($codeblock); - if ($this->code_block_content_func) { + if (is_callable($this->code_block_content_func)) { $codeblock = call_user_func($this->code_block_content_func, $codeblock, ""); } else { $codeblock = htmlspecialchars($codeblock, ENT_NOQUOTES); @@ -1237,7 +1236,7 @@ class Markdown implements MarkdownInterface { * @return string */ protected function makeCodeSpan($code) { - if ($this->code_span_content_func) { + if (is_callable($this->code_span_content_func)) { $code = call_user_func($this->code_span_content_func, $code); } else { $code = htmlspecialchars(trim($code), ENT_NOQUOTES); @@ -1576,11 +1575,11 @@ class Markdown implements MarkdownInterface { * This function is *not* suitable for attributes enclosed in single quotes. * * @param string $url - * @param string &$text Passed by reference + * @param string $text Passed by reference * @return string URL */ protected function encodeURLAttribute($url, &$text = null) { - if ($this->url_filter_func) { + if (is_callable($this->url_filter_func)) { $url = call_user_func($this->url_filter_func, $url); } @@ -1694,7 +1693,7 @@ class Markdown implements MarkdownInterface { * attribute special characters by Allan Odgaard. * * @param string $text - * @param string &$tail + * @param string $tail Passed by reference * @param integer $head_length * @return string */ @@ -1792,7 +1791,7 @@ class Markdown implements MarkdownInterface { * Handle $token provided by parseSpan by determining its nature and * returning the corresponding value that should replace it. * @param string $token - * @param string &$str + * @param string $str Passed by reference * @return string */ protected function handleSpanToken($token, &$str) { diff --git a/lib/markdown/MarkdownExtra.php b/lib/markdown/MarkdownExtra.php index 7f8f1f9110b..62d25f38e17 100644 --- a/lib/markdown/MarkdownExtra.php +++ b/lib/markdown/MarkdownExtra.php @@ -4,7 +4,7 @@ * * @package php-markdown * @author Michel Fortin - * @copyright 2004-2018 Michel Fortin + * @copyright 2004-2019 Michel Fortin * @copyright (Original Markdown) 2004-2006 John Gruber */ @@ -25,11 +25,10 @@ class MarkdownExtra extends \Michelf\Markdown { public $fn_id_prefix = ""; /** - * Optional title attribute for footnote links and backlinks. + * Optional title attribute for footnote links. * @var string */ - public $fn_link_title = ""; - public $fn_backlink_title = ""; + public $fn_link_title = ""; /** * Optional class attribute for footnote links and backlinks. @@ -42,10 +41,22 @@ class MarkdownExtra extends \Michelf\Markdown { * Content to be displayed within footnote backlinks. The default is '↩'; * the U+FE0E on the end is a Unicode variant selector used to prevent iOS * from displaying the arrow character as an emoji. + * Optionally use '^^' and '%%' to refer to the footnote number and + * reference number respectively. {@see parseFootnotePlaceholders()} * @var string */ public $fn_backlink_html = '↩︎'; + /** + * Optional title and aria-label attributes for footnote backlinks for + * added accessibility (to ensure backlink uniqueness). + * Use '^^' and '%%' to refer to the footnote number and reference number + * respectively. {@see parseFootnotePlaceholders()} + * @var string + */ + public $fn_backlink_title = ""; + public $fn_backlink_label = ""; + /** * Class name for table cell alignment (%% replaced left/center/right) * For instance: 'go-%%' becomes 'go-left' or 'go-right' or 'go-center' @@ -79,6 +90,27 @@ class MarkdownExtra extends \Michelf\Markdown { */ public $hashtag_protection = false; + /** + * Determines whether footnotes should be appended to the end of the document. + * If true, footnote html can be retrieved from $this->footnotes_assembled. + * @var boolean + */ + public $omit_footnotes = false; + + + /** + * 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; + /** * Parser implementation */ @@ -133,6 +165,12 @@ class MarkdownExtra extends \Michelf\Markdown { */ protected $footnote_counter = 1; + /** + * Ref attribute for links + * @var array + */ + protected $ref_attr = array(); + /** * Setting up Extra-specific variables. */ @@ -146,6 +184,7 @@ class MarkdownExtra extends \Michelf\Markdown { $this->abbr_desciptions = array(); $this->abbr_word_re = ''; $this->footnote_counter = 1; + $this->footnotes_assembled = null; foreach ($this->predef_abbr as $abbr_word => $abbr_desc) { if ($this->abbr_word_re) @@ -166,6 +205,9 @@ class MarkdownExtra extends \Michelf\Markdown { $this->abbr_desciptions = array(); $this->abbr_word_re = ''; + if ( ! $this->omit_footnotes ) + $this->footnotes_assembled = null; + parent::teardown(); } @@ -202,7 +244,9 @@ class MarkdownExtra extends \Michelf\Markdown { * @return string */ protected function doExtraAttributes($tag_name, $attr, $defaultIdValue = null, $classes = array()) { - if (empty($attr) && !$defaultIdValue && empty($classes)) return ""; + if (empty($attr) && !$defaultIdValue && empty($classes)) { + return ""; + } // Split on components preg_match_all('/[#.a-z][-_:a-zA-Z0-9=]+/', $attr, $matches); @@ -212,9 +256,9 @@ class MarkdownExtra extends \Michelf\Markdown { $attributes = array(); $id = false; foreach ($elements as $element) { - if ($element[0] == '.') { + if ($element[0] === '.') { $classes[] = substr($element, 1); - } else if ($element[0] == '#') { + } else if ($element[0] === '#') { if ($id === false) $id = substr($element, 1); } else if (strpos($element, '=') > 0) { $parts = explode('=', $element, 2); @@ -222,7 +266,9 @@ class MarkdownExtra extends \Michelf\Markdown { } } - if (!$id) $id = $defaultIdValue; + if ($id === false || $id === '') { + $id = $defaultIdValue; + } // Compose attributes as string $attr_str = ""; @@ -486,7 +532,6 @@ class MarkdownExtra extends \Michelf\Markdown { $tag = $parts[1]; // Tag to handle. $text = $parts[2]; // Remaining text after current tag. - $tag_re = preg_quote($tag); // For use in a regular expression. // Check for: Fenced code block marker. // Note: need to recheck the whole tag to disambiguate backtick @@ -508,14 +553,14 @@ class MarkdownExtra extends \Michelf\Markdown { } } // Check for: Indented code block. - else if ($tag[0] == "\n" || $tag[0] == " ") { + else if ($tag[0] === "\n" || $tag[0] === " ") { // Indented code block: pass it unchanged, will be handled // later. $parsed .= $tag; } // Check for: Code span marker // Note: need to check this after backtick fenced code blocks - else if ($tag[0] == "`") { + else if ($tag[0] === "`") { // Find corresponding end marker. $tag_re = preg_quote($tag); if (preg_match('{^(?>.+?|\n(?!\n))*?(?clean_tags_re . ')\b}', $tag) || - $tag[1] == '!' || $tag[1] == '?') + $tag[1] === '!' || $tag[1] === '?') { // Need to parse tag and following text using the HTML parser. // (don't check for markdown attribute) @@ -564,8 +609,11 @@ class MarkdownExtra extends \Michelf\Markdown { preg_match('{^) // Comments and Processing Instructions. if (preg_match('{^auto_close_tags_re . ')\b}', $tag) || - $tag[1] == '!' || $tag[1] == '?') + $tag[1] === '!' || $tag[1] === '?') { // Just add the tag to the block as if it was text. $block_text .= $tag; @@ -683,8 +732,11 @@ class MarkdownExtra extends \Michelf\Markdown { // Increase/decrease nested tag count. Only do so if // the tag's name match base tag's. if (preg_match('{^mode = $attr_m[2] . $attr_m[3]; - $span_mode = $this->mode == 'span' || $this->mode != 'block' && - preg_match('{^<(?:' . $this->contain_span_tags_re . ')\b}', $tag); + $mode = $attr_m[2] . $attr_m[3]; + $span_mode = $mode === 'span' || ($mode !== 'block' && + preg_match('{^<(?:' . $this->contain_span_tags_re . ')\b}', $tag)); // Calculate indent before tag. if (preg_match('/(?:^|\n)( *?)(?! ).*?$/', $block_text, $matches)) { @@ -729,8 +781,11 @@ class MarkdownExtra extends \Michelf\Markdown { } // Append tag content to parsed text. - if (!$span_mode) $parsed .= "\n\n$block_text\n\n"; - else $parsed .= "$block_text"; + if (!$span_mode) { + $parsed .= "\n\n$block_text\n\n"; + } else { + $parsed .= (string) $block_text; + } // Start over with a new block. $block_text = ""; @@ -875,16 +930,15 @@ class MarkdownExtra extends \Michelf\Markdown { * @return string */ protected function _doAnchors_inline_callback($matches) { - $whole_match = $matches[1]; $link_text = $this->runSpanGamut($matches[2]); - $url = $matches[3] == '' ? $matches[4] : $matches[3]; + $url = $matches[3] === '' ? $matches[4] : $matches[3]; $title =& $matches[7]; $attr = $this->doExtraAttributes("a", $dummy =& $matches[8]); // if the URL was of the form it got caught by the HTML // tag parser and hashed. Need to reverse the process before using the URL. $unhashed = $this->unhash($url); - if ($unhashed != $url) + if ($unhashed !== $url) $url = preg_replace('/^<(.*)>$/', '\1', $unhashed); $url = $this->encodeURLAttribute($url); @@ -967,7 +1021,7 @@ class MarkdownExtra extends \Michelf\Markdown { $alt_text = $matches[2]; $link_id = strtolower($matches[3]); - if ($link_id == "") { + if ($link_id === "") { $link_id = strtolower($alt_text); // for shortcut links like ![this][]. } @@ -980,8 +1034,9 @@ class MarkdownExtra extends \Michelf\Markdown { $title = $this->encodeAttribute($title); $result .= " title=\"$title\""; } - if (isset($this->ref_attr[$link_id])) + if (isset($this->ref_attr[$link_id])) { $result .= $this->ref_attr[$link_id]; + } $result .= $this->empty_element_suffix; $result = $this->hashPart($result); } @@ -999,9 +1054,8 @@ class MarkdownExtra extends \Michelf\Markdown { * @return string */ protected function _doImages_inline_callback($matches) { - $whole_match = $matches[1]; $alt_text = $matches[2]; - $url = $matches[3] == '' ? $matches[4] : $matches[3]; + $url = $matches[3] === '' ? $matches[4] : $matches[3]; $title =& $matches[7]; $attr = $this->doExtraAttributes("img", $dummy =& $matches[8]); @@ -1067,11 +1121,11 @@ class MarkdownExtra extends \Michelf\Markdown { * @return string */ protected function _doHeaders_callback_setext($matches) { - if ($matches[3] == '-' && preg_match('{^- }', $matches[1])) { + if ($matches[3] === '-' && preg_match('{^- }', $matches[1])) { return $matches[0]; } - $level = $matches[3][0] == '=' ? 1 : 2; + $level = $matches[3][0] === '=' ? 1 : 2; $defaultId = is_callable($this->header_id_func) ? call_user_func($this->header_id_func, $matches[1]) : null; @@ -1174,8 +1228,7 @@ class MarkdownExtra extends \Michelf\Markdown { * @param string $alignname * @return string */ - protected function _doTable_makeAlignAttr($alignname) - { + protected function _doTable_makeAlignAttr($alignname) { if (empty($this->table_align_class_tmpl)) { return " align=\"$alignname\""; } @@ -1223,8 +1276,9 @@ class MarkdownExtra extends \Michelf\Markdown { $text = "\n"; $text .= "\n"; $text .= "\n"; - foreach ($headers as $n => $header) + foreach ($headers as $n => $header) { $text .= " " . $this->runSpanGamut(trim($header)) . "\n"; + } $text .= "\n"; $text .= "\n"; @@ -1242,8 +1296,9 @@ class MarkdownExtra extends \Michelf\Markdown { $row_cells = array_pad($row_cells, $col_count, ''); $text .= "\n"; - foreach ($row_cells as $n => $cell) + foreach ($row_cells as $n => $cell) { $text .= " " . $this->runSpanGamut(trim($cell)) . "\n"; + } $text .= "\n"; } $text .= "\n"; @@ -1411,8 +1466,6 @@ class MarkdownExtra extends \Michelf\Markdown { */ protected function doFencedCodeBlocks($text) { - $less_than_tab = $this->tab_width; - $text = preg_replace_callback('{ (?:\n|\A) # 1: Opening marker @@ -1465,9 +1518,10 @@ class MarkdownExtra extends \Michelf\Markdown { array($this, '_doFencedCodeBlocks_newlines'), $codeblock); $classes = array(); - if ($classname != "") { - if ($classname[0] == '.') + if ($classname !== "") { + if ($classname[0] === '.') { $classname = substr($classname, 1); + } $classes[] = $this->code_class_prefix . $classname; } $attr_str = $this->doExtraAttributes($this->code_attr_on_pre ? "pre" : "code", $attrs, null, $classes); @@ -1608,65 +1662,95 @@ class MarkdownExtra extends \Michelf\Markdown { $text = preg_replace_callback('{F\x1Afn:(.*?)\x1A:}', array($this, '_appendFootnotes_callback'), $text); - if (!empty($this->footnotes_ordered)) { - $text .= "\n\n"; - $text .= "
\n"; - $text .= "empty_element_suffix . "\n"; - $text .= "
    \n\n"; - - $attr = ""; - if ($this->fn_backlink_class != "") { - $class = $this->fn_backlink_class; - $class = $this->encodeAttribute($class); - $attr .= " class=\"$class\""; + if ( ! empty( $this->footnotes_ordered ) ) { + $this->_doFootnotes(); + if ( ! $this->omit_footnotes ) { + $text .= "\n\n"; + $text .= "
    \n"; + $text .= "empty_element_suffix . "\n"; + $text .= $this->footnotes_assembled; + $text .= "
    "; } - if ($this->fn_backlink_title != "") { - $title = $this->fn_backlink_title; - $title = $this->encodeAttribute($title); - $attr .= " title=\"$title\""; - $attr .= " aria-label=\"$title\""; - } - $attr .= " role=\"doc-backlink\""; - $backlink_text = $this->fn_backlink_html; - $num = 0; + } + return $text; + } - while (!empty($this->footnotes_ordered)) { - $footnote = reset($this->footnotes_ordered); - $note_id = key($this->footnotes_ordered); - unset($this->footnotes_ordered[$note_id]); - $ref_count = $this->footnotes_ref_count[$note_id]; - unset($this->footnotes_ref_count[$note_id]); - unset($this->footnotes[$note_id]); - $footnote .= "\n"; // Need to append newline before parsing. - $footnote = $this->runBlockGamut("$footnote\n"); - $footnote = preg_replace_callback('{F\x1Afn:(.*?)\x1A:}', - array($this, '_appendFootnotes_callback'), $footnote); + /** + * Generates the HTML for footnotes. Called by appendFootnotes, even if + * footnotes are not being appended. + * @return void + */ + protected function _doFootnotes() { + $attr = array(); + if ($this->fn_backlink_class !== "") { + $class = $this->fn_backlink_class; + $class = $this->encodeAttribute($class); + $attr['class'] = " class=\"$class\""; + } + $attr['role'] = " role=\"doc-backlink\""; + $num = 0; - $attr = str_replace("%%", ++$num, $attr); - $note_id = $this->encodeAttribute($note_id); + $text = "
      \n\n"; + while (!empty($this->footnotes_ordered)) { + $footnote = reset($this->footnotes_ordered); + $note_id = key($this->footnotes_ordered); + unset($this->footnotes_ordered[$note_id]); + $ref_count = $this->footnotes_ref_count[$note_id]; + unset($this->footnotes_ref_count[$note_id]); + unset($this->footnotes[$note_id]); - // Prepare backlink, multiple backlinks if multiple references - $backlink = "$backlink_text"; - for ($ref_num = 2; $ref_num <= $ref_count; ++$ref_num) { - $backlink .= " $backlink_text"; + $footnote .= "\n"; // Need to append newline before parsing. + $footnote = $this->runBlockGamut("$footnote\n"); + $footnote = preg_replace_callback('{F\x1Afn:(.*?)\x1A:}', + array($this, '_appendFootnotes_callback'), $footnote); + + $num++; + $note_id = $this->encodeAttribute($note_id); + + // Prepare backlink, multiple backlinks if multiple references + // Do not create empty backlinks if the html is blank + $backlink = ""; + if (!empty($this->fn_backlink_html)) { + for ($ref_num = 1; $ref_num <= $ref_count; ++$ref_num) { + if (!empty($this->fn_backlink_title)) { + $attr['title'] = ' title="' . $this->encodeAttribute($this->fn_backlink_title) . '"'; + } + if (!empty($this->fn_backlink_label)) { + $attr['label'] = ' aria-label="' . $this->encodeAttribute($this->fn_backlink_label) . '"'; + } + $parsed_attr = $this->parseFootnotePlaceholders( + implode('', $attr), + $num, + $ref_num + ); + $backlink_text = $this->parseFootnotePlaceholders( + $this->fn_backlink_html, + $num, + $ref_num + ); + $ref_count_mark = $ref_num > 1 ? $ref_num : ''; + $backlink .= " $backlink_text"; } - // Add backlink to last paragraph; create new paragraph if needed. + $backlink = trim($backlink); + } + + // Add backlink to last paragraph; create new paragraph if needed. + if (!empty($backlink)) { if (preg_match('{

      $}', $footnote)) { $footnote = substr($footnote, 0, -4) . " $backlink

      "; } else { $footnote .= "\n\n

      $backlink

      "; } - - $text .= "
    1. \n"; - $text .= $footnote . "\n"; - $text .= "
      2. \n\n"; } - $text .= "
    \n"; - $text .= "
"; + $text .= "
  • \n"; + $text .= $footnote . "\n"; + $text .= "
    • \n\n"; } - return $text; + $text .= "\n"; + + $this->footnotes_assembled = $text; } /** @@ -1693,12 +1777,12 @@ class MarkdownExtra extends \Michelf\Markdown { } $attr = ""; - if ($this->fn_link_class != "") { + if ($this->fn_link_class !== "") { $class = $this->fn_link_class; $class = $this->encodeAttribute($class); $attr .= " class=\"$class\""; } - if ($this->fn_link_title != "") { + if ($this->fn_link_title !== "") { $title = $this->fn_link_title; $title = $this->encodeAttribute($title); $attr .= " title=\"$title\""; @@ -1717,6 +1801,23 @@ class MarkdownExtra extends \Michelf\Markdown { return "[^" . $matches[1] . "]"; } + /** + * Build footnote label by evaluating any placeholders. + * - ^^ footnote number + * - %% footnote reference number (Nth reference to footnote number) + * @param string $label + * @param int $footnote_number + * @param int $reference_number + * @return string + */ + protected function parseFootnotePlaceholders($label, $footnote_number, $reference_number) { + return str_replace( + array('^^', '%%'), + array($footnote_number, $reference_number), + $label + ); + } + /** * Abbreviations - strips abbreviations from text, stores titles in hash @@ -1783,12 +1884,10 @@ class MarkdownExtra extends \Michelf\Markdown { $desc = $this->abbr_desciptions[$abbr]; if (empty($desc)) { return $this->hashPart("$abbr"); - } else { - $desc = $this->encodeAttribute($desc); - return $this->hashPart("$abbr"); } - } else { - return $matches[0]; + $desc = $this->encodeAttribute($desc); + return $this->hashPart("$abbr"); } + return $matches[0]; } } diff --git a/lib/markdown/MarkdownInterface.php b/lib/markdown/MarkdownInterface.php index 7fc0da06e29..0064524459c 100644 --- a/lib/markdown/MarkdownInterface.php +++ b/lib/markdown/MarkdownInterface.php @@ -4,7 +4,7 @@ * * @package php-markdown * @author Michel Fortin - * @copyright 2004-2018 Michel Fortin + * @copyright 2004-2019 Michel Fortin * @copyright (Original Markdown) 2004-2006 John Gruber */ diff --git a/lib/markdown/Readme.md b/lib/markdown/Readme.md index c05cd93d475..e1eb3066016 100644 --- a/lib/markdown/Readme.md +++ b/lib/markdown/Readme.md @@ -1,7 +1,7 @@ PHP Markdown ============ -PHP Markdown Lib 1.8.0 - 14 Jan 2018 +PHP Markdown Lib 1.9.0 - 1 Dec 2019 by Michel Fortin @@ -163,26 +163,54 @@ potential side effects, and future extensibility -- before deciding on acceptance or rejection. If you make a pull request that includes changes to the parser please add -tests for what is being changed to [MDTest][] and make a pull request there -too. +tests for what is being changed to the `test/` directory. This can be as +simple as adding a `.text` (input) file with a corresponding `.xhtml` +(output) file to proper category under `./test/resources/`. - [MDTest]: https://github.com/michelf/mdtest/ +Traditionally tests were in a separate repository, [MDTest](https://github.com/michelf/mdtest) +but they are now located here, alongside the source code. Donations --------- If you wish to make a donation that will help me devote more time to -PHP Markdown, please visit [michelf.ca/donate] or send Bitcoin to -[1HiuX34czvVPPdhXbUAsAu7pZcesniDCGH]. +PHP Markdown, please visit [michelf.ca/donate]. [michelf.ca/donate]: https://michelf.ca/donate/#!Thanks%20for%20PHP%20Markdown - [1HiuX34czvVPPdhXbUAsAu7pZcesniDCGH]: bitcoin:1HiuX34czvVPPdhXbUAsAu7pZcesniDCGH Version History --------------- +PHP Markdown Lib 1.9.0 (1 Dec 2019) + +* Added `fn_backlink_label` configuration variable to put some text in the + `aria-label` attribute. + (Thanks to Sunny Walker for the implementation.) + +* Occurances of "`^^`" in `fn_backlink_html`, `fn_backlink_class`, + `fn_backlink_title`, and `fn_backlink_label` will be replaced by the + corresponding footnote number in the HTML output. Occurances of "`%%`" will be + replaced by a number for the reference (footnotes can have multiple references). + (Thanks to Sunny Walker for the implementation.) + +* Added configuration variable `omit_footnotes`. When `true` footnotes are not + appended at the end of the generated HTML and the `footnotes_assembled` + variable will contain the HTML for the footnote list, allowing footnotes to be + 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 `
    ` or `
    ` 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. + +* Fixed deprecation warnings from PHP about usage of curly braces to access + characters in text strings. + (Thanks to Remi Collet and Frans-Willem Post.) + + PHP Markdown Lib 1.8.0 (14 Jan 2018) * Autoloading with Composer now uses PSR-4. @@ -371,7 +399,7 @@ Copyright and License --------------------- PHP Markdown Lib -Copyright (c) 2004-2016 Michel Fortin +Copyright (c) 2004-2019 Michel Fortin All rights reserved. From 238e0646e2d058335ef4e79a8b8a4ef8ac01dbcf Mon Sep 17 00:00:00 2001 From: Peter Dias Date: Wed, 13 Jan 2021 10:34:04 +0800 Subject: [PATCH 2/2] MDL-70296 core: Update the moodle's readme, xml and upgrade files --- lib/markdown/readme_moodle.txt | 10 +++------- lib/thirdpartylibs.xml | 4 ++-- lib/upgrade.txt | 1 + 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/lib/markdown/readme_moodle.txt b/lib/markdown/readme_moodle.txt index c8016b082be..befa87681e9 100644 --- a/lib/markdown/readme_moodle.txt +++ b/lib/markdown/readme_moodle.txt @@ -5,15 +5,11 @@ Procedure: * copy the classes and readme file to lib/markdown/* , Note .inc files need not be copied. * update function markdown_to_html() in weblib.php if necessary, note that we require the php files manually for performance reasons -* reapply the following commit if it's not present in the release we are upgrading to: - https://github.com/michelf/php-markdown/commit/a35858f0409e5f01474f5cd562d17289fe8e5435 - (if there is any problem you can, alternatively, reapply MDL-66964 php fix commit itself)) - (revove this step once the release includes the commit) - * run phpunit tests (all PHP versions) Petr Skoda -* Currently using the 1.8.0 release + (php74 fixup commit) +* Removed fixup step in procedure +* Currently using the 1.9.0 release(includes php74 fixup commit) -Mathew May +Peter Dias diff --git a/lib/thirdpartylibs.xml b/lib/thirdpartylibs.xml index 768a7af3d57..b9aa552dda2 100644 --- a/lib/thirdpartylibs.xml +++ b/lib/thirdpartylibs.xml @@ -163,9 +163,9 @@ markdown - Markdown original+extra + Markdown original BSD - 1.8.0 + 1.9.0 diff --git a/lib/upgrade.txt b/lib/upgrade.txt index 499aedabe96..5810ef0f718 100644 --- a/lib/upgrade.txt +++ b/lib/upgrade.txt @@ -15,6 +15,7 @@ information provided here is intended especially for developers. * Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT, which were deprecated in 3.7, have been removed. * \core_table\local\filter\filterset::JOINTYPE_DEFAULT is being changed from 1 (ANY) to 2 (ALL). Filterset implementations can override the default filterset join type by overriding \core_table\local\filter\filterset::get_join_type() instead. +* Markdown lib has been upgraded to the latest version - 1.9.0 === 3.10 === * PHPUnit has been upgraded to 8.5. That comes with a few changes: