Changeset 677 for sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php

Timestamp:

06/05/2014 09:46:52 PM (11 years ago)

Author:

coffee2code

Message:

Code Reference: Improvements to inline source code display. Fixes #176

• More efficient implementation of get_source_code()
• Add get_source_code_root_dir() which gets 'wp_parser_root_import_dir' option value if set by parser, else ABSPATH
• Add post_type_has_source_code()
• Use 'wporg' as the text domain
• Slight tweak to JS height comparison to ensure functions that just fit don't trigger expansion handling
• Allow x scrollbar for .source-code-container and adjust heights to account for its possible display
• Add extra height to collapsed state of .source-code-container to partially show the first hidden line to better indicate there is more code
• Add right border to .source-code-container so it is easier to tell if code is being clipped
• Change 'View source' link to 'View source code:' label with explicit links to inline source and/or WP Trac code browser
• Source code is stored in post meta; parse and store it as requested if it isn't
• Sanity check to ensure proper conditions exist for parsing
• Add optional 'force_parse' arg to get_source_code() to force reparsing of source file

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php

@@ -29 +29 @@
         ?>
         <section class="source">
-            <p><strong><?php _e( 'Source file:', 'wporg' ); ?> </strong><a href="<?php echo get_source_file_archive_link( $source_file ); ?>"><?php echo esc_html( $source_file ); ?></a></p>
-            <p><a href="<?php echo get_source_file_link(); ?>"><?php _e( 'View source&hellip;', 'wporg' ); ?></a></p>
+            <p>
+                <strong><?php _e( 'Source file:', 'wporg' ); ?></strong>
+                <a href="<?php echo get_source_file_archive_link( $source_file ); ?>"><?php echo esc_html( $source_file ); ?></a><br />
+                <strong><?php _e( 'View source code:', 'wporg' ); ?></strong>
+                <?php if ( post_type_has_source_code() ) { ?>
+                <a href="#source-code"><?php _e( 'below', 'wporg' ); ?></a> or
+                <?php } ?>
+                <a href="<?php echo get_source_file_link(); ?>"><?php _e( 'on the WP Trac code browser&hellip;', 'wporg' ); ?></a>
+            </p>
         </section>
     <?php endif; ?>
@@ -117 +124 @@
     endif; ?>
 
-    <?php if ( 'wp-parser-function' === get_post_type() || 'wp-parser-method' === get_post_type() ) : ?>
+    <?php if ( post_type_has_source_code() ) : ?>
         <hr />
+        <a id="source-code"></a>
         <section class="source-content">
             <h2><?php _e( 'Source', 'wporg' ); ?></h2>
@@ -124 +132 @@
                 <pre class="brush: php; toolbar: false;"><?php echo esc_html( get_source_code() ); ?></pre>
             </div>
-            <p><a href="#" class="show-complete-source"><?php _e( 'View full source code&hellip;', 'wporg-developer' ); ?></a></p>
+            <p><a href="#" class="show-complete-source"><?php _e( 'View full source code&hellip;', 'wporg' ); ?></a></p>
         </section>
     <?php endif; ?>