Changeset 4782

Timestamp:

01/25/2017 02:36:41 PM (9 years ago)

Author:

danielbachhuber

Message:

make/cli: Append a "Edit on GitHub" link to Handbook document titles

Also removes padding from pre code that's no longer necessary

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-cli

Files:

• assets (added)
• assets/images (added)
• assets/images/github-mark.svg (added)
• inc/class-handbook.php (modified) (5 diffs)
• wporg-cli.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-cli/inc/class-handbook.php

@@ -4 +4 @@
 
 class Handbook {
+
+    /**
+     * Append a "Edit on GitHub" link to Handbook document titles
+     */
+    public static function filter_the_title_edit_link( $title ) {
+        // Only apply to the main title for the document
+        if ( ! is_singular( 'handbook' )
+            || ! is_main_query()
+            || ! in_the_loop() ) {
+            return $title;
+        }
+
+        $markdown_source = self::get_markdown_edit_link( get_the_ID() );
+        if ( ! $markdown_source ) {
+            return $title;
+        }
+
+        return $title . ' <a class="github-edit" href="' . esc_url( $markdown_source ) . '"><img src="' . esc_url( plugins_url( 'assets/images/github-mark.svg', dirname( __FILE__ ) ) ) . '"> <span>Edit</span></a>';
+    }
+
     /**
      * WP-CLI Handbook pages are maintained in the GitHub repo, so the edit
@@ -9 +29 @@
      */
     public static function redirect_edit_link_to_github( $link, $post_id, $context ) {
+        if ( is_admin() ) {
+            return $link;
+        }
         $post = get_post( $post_id );
         if ( ! $post ) {
@@ -18 +41 @@
         }
 
-        $markdown_source = Markdown_Import::get_markdown_source( $post_id );
-        if ( is_wp_error( $markdown_source ) ) {
+        $markdown_source = self::get_markdown_edit_link( $post_id );
+        if ( ! $markdown_source ) {
             return $link;
         }
@@ -47 +70 @@
         }
 
-        $markdown_source = Markdown_Import::get_markdown_source( $post_id );
-        if ( is_wp_error( $markdown_source ) ) {
+        $markdown_source = self::get_markdown_edit_link( $post_id );
+        if ( ! $markdown_source ) {
             return $actions;
         }
@@ -85 +108 @@
         return $actions;
     }
+
+    private static function get_markdown_edit_link( $post_id ) {
+        $markdown_source = Markdown_Import::get_markdown_source( $post_id );
+        if ( is_wp_error( $markdown_source ) ) {
+            return '';
+        }
+        if ( 'github.com' !== parse_url( $markdown_source, PHP_URL_HOST )
+            || false !== stripos( $markdown_source, '/edit/master/' ) ) {
+            return $markdown_source;
+        }
+        $markdown_source = str_replace( '/blob/master/', '/edit/master/', $markdown_source );
+        return $markdown_source;
+    }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-cli/wporg-cli.php

@@ -18 +18 @@
 add_action( 'edit_form_after_title', array( 'WPOrg_Cli\Markdown_Import', 'action_edit_form_after_title' ) );
 add_action( 'save_post', array( 'WPOrg_Cli\Markdown_Import', 'action_save_post' ) );
-
+add_filter( 'the_title', array( 'WPOrg_Cli\Handbook', 'filter_the_title_edit_link' ) );
 add_filter( 'get_edit_post_link', array( 'WPOrg_Cli\Handbook', 'redirect_edit_link_to_github' ), 10, 3 );
 add_filter( 'o2_filter_post_actions', array( 'WPOrg_Cli\Handbook', 'redirect_o2_edit_link_to_github' ), 11, 2 );
@@ -26 +26 @@
     <style>
         pre code {
-            padding: 0;
             line-height: 16px;
+        }
+        a.github-edit {
+            margin-left: .5em;
+            font-size: .5em;
+            vertical-align: top;
+            display: inline-block;
+            border: 1px solid #eeeeee;
+            border-radius: 2px;
+            background: #eeeeee;
+            padding: .5em .6em .4em;
+            color: black;
+            margin-top: 0.1em;
+        }
+        a.github-edit > * {
+            opacity: 0.6;
+        }
+        a.github-edit:hover > * {
+            opacity: 1;
+            color: black;
+        }
+        a.github-edit img {
+            height: .8em;
         }
     </style>