<!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>[879] sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook: Handbook plugin: add shortcodes for callout boxes:</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 { 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/879">879</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/879","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>2014-09-29 07:04:04 +0000 (Mon, 29 Sep 2014)</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'>Handbook plugin: add shortcodes for callout boxes:

* Adds shortcodes [info], [tip], [alert], [warning]
* Adds default styling

Fixes <a href="http://meta.trac.wordpress.org/ticket/1">#1</a>.
props DrewAPicture.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookhandbookphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookinccalloutboxesphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/callout-boxes.php</a></li>
<li>sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/stylesheets/</li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookstylesheetscalloutboxescss">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/stylesheets/callout-boxes.css</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookhandbookphp"></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/plugins/handbook/handbook.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/plugins/handbook/handbook.php    2014-09-29 06:24:35 UTC (rev 878)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php      2014-09-29 07:04:04 UTC (rev 879)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,6 +5,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">  * Author: Nacin
</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">+require_once dirname( __FILE__ ) . '/inc/callout-boxes.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/glossary.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/table-of-contents.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( __FILE__ ) . '/inc/email-post-changes.php';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,8 +29,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        new WPorg_Handbook( $type );
</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">+                add_action( 'wp_enqueue_scripts', array( __CLASS__, 'enqueue_styles' ) );
</ins><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">+        static public function enqueue_styles() {
+               wp_enqueue_style( 'wporg-handbook-css', plugins_url( '/stylesheets/callout-boxes.css', __FILE__ ), array(), '20140928' );
+       }
+
</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"> add_action( 'after_setup_theme', array( 'WPorg_Handbook_Init', 'init' ) );
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookinccalloutboxesphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/callout-boxes.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/plugins/handbook/inc/callout-boxes.php                           (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/callout-boxes.php     2014-09-29 07:04:04 UTC (rev 879)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,135 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Class to register shortcodes for callout boxes to be used in handbooks.
+ *
+ * @package handbook
+ */
+
+class WPorg_Handbook_Callout_Boxes {
+
+       /**
+        * Array of key => value pairs where the shortcode name is the key, and the
+        * localized callout box prefix is the value.
+        *
+        * @access public
+        * @var array
+        */
+       public $shortcodes = array();
+
+       /**
+        * Constructor.
+        *
+        * @access public
+        */
+       public function __construct() {
+               $this->shortcodes = array(
+                       'info'    => __( 'Note:',    'wporg' ),
+                       'tip'     => __( 'Tip:',     'wporg' ),
+                       'alert'   => __( 'Alert:',   'wporg' ),
+                       'warning' => __( 'Warning:', 'wporg' )
+               );
+
+               add_action( 'init', array( $this, 'register_shortcodes' ) );
+       }
+
+       /**
+        * Register the callout box shortcodes.
+        *
+        * @access public
+        */
+       public function register_shortcodes() {
+               foreach ( array_keys( $this->shortcodes ) as $name) {
+                       add_shortcode( $name, array( $this, "{$name}_shortcode" ) );
+               }
+       }
+
+       /**
+        * Output callback for the `[info]` shortcode.
+        *
+        * @access public
+        *
+        * @param array  $atts    Shortcode attributes.
+        * @param string $content Shortcode content.
+        * @return string Shortcode output as HTML markup.
+        */
+       public function info_shortcode( $atts, $content = '' ) {
+               return $this->build_callout_output( $content, 'info' );
+       }
+
+       /**
+        * Output callback for the `[tip]` shortcode.
+        *
+        * @access public
+        *
+        * @param array  $atts    Shortcode attributes.
+        * @param string $content Shortcode content.
+        * @return string Shortcode output as HTML markup.
+        */
+       public function tip_shortcode( $atts, $content = '' ) {
+               return $this->build_callout_output( $content, 'tip' );
+       }
+
+       /**
+        * Output callback for the `[alert]` shortcode.
+        *
+        * @access public
+        *
+        * @param array  $atts    Shortcode attributes.
+        * @param string $content Shortcode content.
+        * @return string Shortcode output as HTML markup.
+        */
+       public function alert_shortcode( $atts, $content = '' ) {
+               return $this->build_callout_output( $content, 'alert' );
+       }
+
+       /**
+        * Output callback for the `[warning]` shortcode.
+        *
+        * @access public
+        *
+        * @param array  $atts    Shortcode attributes.
+        * @param string $content Shortcode content.
+        * @return string Shortcode output as HTML markup.
+        */
+       public function warning_shortcode( $atts, $content = '' ) {
+               return $this->build_callout_output( $content, 'warning' );
+       }
+
+       /**
+        * Build callout box output for the given shortcode.
+        *
+        * @access protected
+        *
+        * @param string $content   Shortcode content.
+        * @param string $shortcode Shortcode name.
+        * @return string Shortcode output as HTML markup.
+        */
+       protected function build_callout_output( $content, $shortcode ) {
+               $class = $prefix = $output = '';
+
+               // Sanitize message content.
+               $content = wp_kses_post( $content );
+
+               if ( isset( $this->shortcodes[ $shortcode ] ) && ! empty( $content ) ) {
+                       // Shortcode-type CSS class.
+                       $class = sanitize_html_class( $shortcode );
+                       $class = empty( $class ) ? '' : "callout-{$class}";
+
+                       // Message prefix.
+                       $prefix = '<strong>' . $this->shortcodes[ $shortcode ] . '</strong>';
+
+                       // Content with prefix.
+                       $content = "{$prefix} {$content}";
+
+                       // Callout box output.
+                       $output .= "<div class='callout {$class}'>";
+                       $output .= '<div class="dashicons"></div>'; // Icon holder
+                       $output .= apply_filters( 'the_content', $content );
+                       $output .= '</div>';
+               }
+               return $output;
+       }
+}
+
+$callouts = new WPorg_Handbook_Callout_Boxes();
+
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/callout-boxes.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookstylesheetscalloutboxescss"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/stylesheets/callout-boxes.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/plugins/handbook/stylesheets/callout-boxes.css                           (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/stylesheets/callout-boxes.css     2014-09-29 07:04:04 UTC (rev 879)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,52 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.callout {
+  padding: 15px 40px 15px 46px;
+  margin-bottom: 1.5em;
+  overflow: auto;
+  position: relative;
+}
+.callout .dashicons {
+  position: absolute;
+  font-size: 2em;
+  top: 12px;
+  left: 10px;
+}
+.callout p {
+  margin-bottom: 0;
+}
+.callout-info {
+  background: #c8dffa;
+  border: 1px solid #6ba9f1;
+  border-bottom: 3px solid #2480eb;
+}
+.callout-info .dashicons:before {
+  content: "\f348";
+  color: #2480eb;
+}
+.callout-tip {
+  background: #e0f9d0;
+  border: 1px solid #a4ed76;
+  border-bottom: 3px solid #69e01d;
+}
+.callout-tip .dashicons:before {
+  content: "\f339";
+  color: #69e01d;
+}
+.callout-alert {
+  background: #fff9c7;
+  border: 1px solid #ffe92e;
+  border-bottom: 3px solid #c7b200;
+}
+.callout-alert .dashicons:before {
+  content: "\f109";
+  color: #c7b200;
+}
+.callout-warning {
+  background: #ffd8d8;
+  border: 1px solid #ff7272;
+  border-bottom: 3px solid #ff3f3f;
+}
+.callout-warning .dashicons:before {
+  content: "\f153";
+  color: #ff3f3f;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/stylesheets/callout-boxes.css
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>

</body>
</html>