Changeset 1556460

Timestamp:

12/16/2016 11:50:31 PM (8 years ago)

Author:

goldenapples

Message:

Use the WP.org-flavored markdown

Try to get code blocks working correctly in the readme by using the correct
idiosynratic markdown flavor.

File:

• speed-bumps/trunk/readme.txt (modified) (6 diffs)

speed-bumps/trunk/readme.txt

@@ -28 +28 @@
 The simplest way to have Speed Bumps process all of your content and insert speed bumps into content everywhere is simply adding the filter following registration:
 
-```
-register_speed_bump( 'speed_bump_sample', array(
+`register_speed_bump( 'speed_bump_sample', array(
     'string_to_inject' => function() { return '<div id="speed-bump-sample"></div>'; },
 ));
 add_filter( 'the_content', 'insert_speed_bumps', 1 );
-```
+`
 
 This registration results in the `string_to_inject` value being injected at the first opportunity based on the default rules (e.g. on posts longer than 1200 characters, following the third paragraph OR following the paragraph which contains the 75th word, whichever comes later).
 
 Let's say you wanted the speed bump higher in the content. You could modify the `from_start` parameter to declare that the speed bump can be inserted after the first paragraph (yes, like good engineers, we prefer zero-based indexing).
-```
-register_speed_bump( 'speed_bump_sample', array(
+
+register_speed_bump( 'speed_bump_sample', array(
     'string_to_inject' => function() { return '<div id="speed-bump-sample"></div>'; },
     'from_start' => 0,
 ));
-```
+`
 
 You can also selectively insert speed bumps into a string of content by calling Speed Bumps directly:
 
-```
-echo insert_speed_bumps( $content_to_be_inserted_into );
-```
+`echo insert_speed_bumps( $content_to_be_inserted_into );
+`
 
 == Frequently Asked Questions ==
@@ -70 +68 @@
 Simple, stupid example: You have a speed bump called "rickroll" which inserts a beautiful musical video throughout your content. You _really_ need this viral bump (publisher's words, not yours) so you disable minimum content length and the rules regarding acceptable speed bump distance from start/end of the post. Greedy!
 
-```
-register_speed_bump( 'rickroll', array(
+`register_speed_bump( 'rickroll', array(
     'string_to_inject' => function() { return '<iframe width="420" height="315" src="https://www.youtube.com/embed/dQw4w9WgXcQ" frameborder="0" allowfullscreen></iframe>'; },
     'minimum_content_length' => false,
@@ -78 +75 @@
 ));
 add_filter( 'the_content', 'insert_speed_bumps', 1 );
-```
+`
 
 But, maybe that's a little too extreme. You want to show it in certain situations, say, only when the previous paragraph contains the phrase 'give {something} up'. Here's how you would achieve that:
 
-```
-add_filter( 'speed_bumps_rickroll_constraints', 'give_you_up', 10, 4 );
+`add_filter( 'speed_bumps_rickroll_constraints', 'give_you_up', 10, 4 );
 
 function give_you_up( $can_insert, $context, $args, $already_inserted ) {
@@ -91 +87 @@
     return $can_insert;
 }
-```
+`
 
 You could also disable it altogether with this filter (although why you would disable so soon after addition, only Rick Astley himself could answer):
 
-```
-add_filter( 'speed_bumps_rickroll_constraints', '__return_false' );
-```
+`add_filter( 'speed_bumps_rickroll_constraints', '__return_false' );
+`
 
 = How to remove default rules? =
@@ -103 +98 @@
 Each rule is hooked to that speed bump's "constraints" filter. To remove a rule, simply remove the filter which defines that rule, like these lines which remove the default rules for your speed bump:
 
-```
+`
 remove_filter( 'speed_bumps_{id}_constraints', '\Speed_Bumps\Constraints\Text\Minimum_Text::content_is_long_enough_to_insert' );
 remove_filter( 'speed_bumps_{id}_constraints', '\Speed_Bumps\Constraints\Text\Minimum_Text::meets_minimum_distance_from_start' );
@@ -110 +105 @@
 remove_filter( 'speed_bumps_{id}_constraints', '\Speed_Bumps\Constraints\Content\Injection::meets_minimum_distance_from_other_inserts' );
 remove_filter( 'speed_bumps_{id}_constraints', '\Speed_Bumps\Constraints\Elements\Element_Constraints::meets_minimum_distance_from_elements' );
-```
+`
 
 == Changelog ==