<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[10068] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer: Developer theme: Convert lists (defined using `*` or `-` for items) appearing in descriptions into actual HTML lists.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/10068">10068</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/10068","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-13 22:40:31 +0000 (Mon, 13 Jul 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Developer theme: Convert lists (defined using `*` or `-` for items) appearing in descriptions into actual HTML lists.
Props ocean90, coffee2code.
See <a href="http://meta.trac.wordpress.org/ticket/5304">#5304</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincformattingphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperscssmainscss">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/scss/main.scss</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperstylesheetsmaincss">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/stylesheets/main.css</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincformattingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php 2020-07-13 21:44:22 UTC (rev 10067)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php 2020-07-13 22:40:31 UTC (rev 10068)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,6 +39,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'devhub-format-description', array( __CLASS__, 'autolink_references' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'devhub-format-description', array( __CLASS__, 'fix_param_hash_formatting' ), 9 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'devhub-format-description', array( __CLASS__, 'fix_param_description_html_as_code' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'devhub-format-description', array( __CLASS__, 'convert_lists_to_markup' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'devhub-format-hash-param-description', array( __CLASS__, 'autolink_references' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'devhub-format-hash-param-description', array( __CLASS__, 'fix_param_description_parsedown_bug' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -317,14 +318,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $text = str_replace( array( "<{$tag}>", "</{$tag}>" ), array( "<{$tag}>", "</{$tag}>" ), $text );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Convert asterisks to a list.
- // Inline lists in param descriptions aren't handled by parser.
- // Example: https://developer.wordpress.org/reference/functions/add_menu_page/
- if ( false !== strpos( $text, ' * ' ) ) {
- // Display as simple plaintext list.
- $text = str_replace( ' * ', '<br /> * ', $text );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Convert any @link or @see to actual link.
</span><span class="cx" style="display: block; padding: 0 10px"> $text = self::make_doclink_clickable( $text );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,6 +477,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Converts simple Markdown-like lists into list markup.
+ *
+ * Necessary in cases like hash param descriptions which don't see Markdown
+ * list processing during parsing.
+ *
+ * Recognizes lists where list items are denoted with an asterisk or dash.
+ *
+ * Does not handle nesting of lists.
+ *
+ * @param string $text The text to process for lists.
+ * @return string
+ */
+ public static function convert_lists_to_markup( $text ) {
+ $inline_list = false;
+ $li = '<br /> * ';
+
+ // Convert asterisks to a list.
+ // Example: https://developer.wordpress.org/reference/functions/add_menu_page/
+ if ( false !== strpos( $text, ' * ' ) ) {
+ // Display as simple plaintext list.
+ $text = str_replace( ' * ', "\n" . $li, $text );
+ $inline_list = true;
+ }
+
+ // Convert dashes to a list.
+ // Example: https://developer.wordpress.org/reference/classes/wp_term_query/__construct/
+ // Example: https://developer.wordpress.org/reference/hooks/password_change_email/
+ if ( false !== strpos( $text, ' - ' ) ) {
+ // Display as simple plaintext list.
+ $text = str_replace( ' - ', "\n" . $li, $text );
+ $inline_list = true;
+ }
+
+ // If list detected.
+ if ( $inline_list ) {
+ // Replace first item, ensuring the opening 'ul' tag is prepended.
+ $text = preg_replace( '~^' . preg_quote( $li ) . '(.+)$~mU', "<ul><li>\$1</li>\n", $text, 1 );
+ // Wrap subsequent list items in 'li' tags.
+ $text = preg_replace( '~^' . preg_quote( $li ) . '(.+)$~mU', "<li>\$1</li>\n", $text );
+ $text = trim( $text );
+
+ // Close the list if it hasn't been closed before start of next hash parameter.
+ //$text = preg_replace( '~(</li>)(\s+</li>)~smU', '$1</ul>$2', $text );
+ $text = preg_replace( '~(</li>)(\s*</li>)~smU', '$1</ul>$2', $text );
+
+ // Closethe list if it hasn't been closed and it's the end of the description.
+ if ( '</li>' === substr( trim( $text ), -5 ) ) {
+ $text .= '</ul>';
+ }
+ }
+
+ return $text;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Formats the output of params defined using hash notation.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This is a temporary measure until the parser parses the hash notation
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperscssmainscss"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/scss/main.scss</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/scss/main.scss 2020-07-13 21:44:22 UTC (rev 10067)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/scss/main.scss 2020-07-13 22:40:31 UTC (rev 10068)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1087,13 +1087,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> .default {
</span><span class="cx" style="display: block; padding: 0 10px"> font-style: italic;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ ul {
+ margin-left: 25px;
+ margin-left: 2.5rem;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> .param-hash {
</span><span class="cx" style="display: block; padding: 0 10px"> margin-left: 1.2em;
</span><span class="cx" style="display: block; padding: 0 10px"> margin-bottom: 0.5em;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- li {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ > li {
</ins><span class="cx" style="display: block; padding: 0 10px"> margin-top: 1em;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ li li {
+ list-style-type: circle;
+ }
+ .param-hash > li {
+ list-style-type: disc;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> .learn-more {
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperstylesheetsmaincss"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/stylesheets/main.css</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/stylesheets/main.css 2020-07-13 21:44:22 UTC (rev 10067)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/stylesheets/main.css 2020-07-13 22:40:31 UTC (rev 10068)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1476,15 +1476,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> font-style: italic;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.devhub-wrap .wp-parser-class .parameters dd ul, .devhub-wrap .wp-parser-function .parameters dd ul, .devhub-wrap .wp-parser-hook .parameters dd ul, .devhub-wrap .wp-parser-method .parameters dd ul {
+ margin-left: 25px;
+ margin-left: 2.5rem;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> .devhub-wrap .wp-parser-class .parameters .param-hash, .devhub-wrap .wp-parser-function .parameters .param-hash, .devhub-wrap .wp-parser-hook .parameters .param-hash, .devhub-wrap .wp-parser-method .parameters .param-hash {
</span><span class="cx" style="display: block; padding: 0 10px"> margin-left: 1.2em;
</span><span class="cx" style="display: block; padding: 0 10px"> margin-bottom: 0.5em;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-.devhub-wrap .wp-parser-class .parameters .param-hash li, .devhub-wrap .wp-parser-function .parameters .param-hash li, .devhub-wrap .wp-parser-hook .parameters .param-hash li, .devhub-wrap .wp-parser-method .parameters .param-hash li {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.devhub-wrap .wp-parser-class .parameters .param-hash > li, .devhub-wrap .wp-parser-function .parameters .param-hash > li, .devhub-wrap .wp-parser-hook .parameters .param-hash > li, .devhub-wrap .wp-parser-method .parameters .param-hash > li {
</ins><span class="cx" style="display: block; padding: 0 10px"> margin-top: 1em;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.devhub-wrap .wp-parser-class .parameters .param-hash li li, .devhub-wrap .wp-parser-function .parameters .param-hash li li, .devhub-wrap .wp-parser-hook .parameters .param-hash li li, .devhub-wrap .wp-parser-method .parameters .param-hash li li {
+ list-style-type: circle;
+}
+
+.devhub-wrap .wp-parser-class .parameters .param-hash .param-hash > li, .devhub-wrap .wp-parser-function .parameters .param-hash .param-hash > li, .devhub-wrap .wp-parser-hook .parameters .param-hash .param-hash > li, .devhub-wrap .wp-parser-method .parameters .param-hash .param-hash > li {
+ list-style-type: disc;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> .devhub-wrap .wp-parser-class .learn-more, .devhub-wrap .wp-parser-function .learn-more, .devhub-wrap .wp-parser-hook .learn-more, .devhub-wrap .wp-parser-method .learn-more {
</span><span class="cx" style="display: block; padding: 0 10px"> background-color: #f1f1f1;
</span><span class="cx" style="display: block; padding: 0 10px"> border: 1px solid #dfdfdf;
</span></span></pre>
</div>
</div>
</body>
</html>