| @@ -1,19 +1,19 @@ | ||
| 1 | 1 | === Easy Footnotes === |
| 2 | -Contributors: yingling017 | |
| 2 | +Contributors: yingling017, twinpictures | |
| 3 | 3 | Donate link: http://jasonyingling.me |
| 4 | 4 | Tags: footnotes, read, blogging, hover, tooltips, editing, endnotes, Formatting, writing, bibliography, notes, reference |
| 5 | 5 | Requires at least: 3.0.1 |
| 6 | -Tested up to: 4.1 | |
| 7 | -Stable tag: 1.0.8 | |
| 6 | +Tested up to: 5.0 | |
| 7 | +Stable tag: 1.1.1 | |
| 8 | 8 | License: GPLv2 or later |
| 9 | 9 | License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 10 | 10 | |
| 11 | -Easy Footnotes let's you quickly and easily add footnotes throughout your WordPress posts using a simple shortcode in the text editor. | |
| 11 | +Easy Footnotes lets you quickly and easily add footnotes throughout your WordPress posts using a simple shortcode in the text editor. | |
| 12 | 12 | |
| 13 | 13 | == Description == |
| 14 | 14 | |
| 15 | -Easy Footnotes let's you add footnotes throughout your WordPress posts by using the shortcode [note]Footnote content.[/note]. Easy Footnotes will automatically add the number of the footnote where the shortcode was entered and add the full footnote text to the bottom of your post in an ordered list with a corresponding number. | |
| 15 | +Easy Footnotes lets you add footnotes throughout your WordPress posts by using the shortcode [efn_note]Footnote content.[/efn_note]. Easy Footnotes will automatically add the number of the footnote where the shortcode was entered and add the full footnote text to the bottom of your post in an ordered list with a corresponding number. | |
| 16 | 16 | |
| 17 | 17 | Hovering the footnote label will show the user the full text of the footnote using the jQuery Qtip2 plugin. Clicking on the footnote label will take the user down the page to the corresponding footnote at the bottom of the WordPress post. Each footnote at the bottom of the post has a icon that can be clicked to return to that particular footnote within the post copy. |
| 18 | 18 | |
| 19 | 19 | That's all it takes to start adding footnotes to your WordPress blog! |
| @@ -21,15 +21,15 @@ | ||
| 21 | 21 | == Installation == |
| 22 | 22 | |
| 23 | 23 | 1. Upload the 'easy-footnotes' folder to the '/wp-content/plugins/' directory. |
| 24 | 24 | 2. Activate the plugin through the 'Plugins' menu in WordPress |
| 25 | -3. That's it! Now simply start using the [note]Footnote content goes here.[/note] shortcode within your posts. | |
| 25 | +3. That's it! Now simply start using the [efn_note]Footnote content goes here.[/efn_note] shortcode within your posts. | |
| 26 | 26 | |
| 27 | 27 | == Frequently Asked Questions == |
| 28 | 28 | |
| 29 | 29 | = How do I insert a footnote into my post. = |
| 30 | 30 | |
| 31 | -Simply use the shortcode [note]Footnote content goes here[/note] and Easy Footnotes will enter numeric footnotes into your post that open on hover and take the user to the footnote at the bottom of the page on click. | |
| 31 | +Simply use the shortcode [efn_note]Footnote content goes here[/efn_note] and Easy Footnotes will enter numeric footnotes into your post that open on hover and take the user to the footnote at the bottom of the page on click. | |
| 32 | 32 | |
| 33 | 33 | = That's awesome! = |
| 34 | 34 | |
| 35 | 35 | I know, but that's not really a question. |
| @@ -35,31 +35,67 @@ | ||
| 35 | 35 | I know, but that's not really a question. |
| 36 | 36 | |
| 37 | 37 | = Oh right, why is that so awesome? = |
| 38 | 38 | |
| 39 | -Because it's easy. And it's integrated with the qTip2 jQuery plugin to display your footnotes in lovely tooltips on hover. Plus it automatically numbers your footnotes in the order you enter them into your post. | |
| 39 | +Because it's easy. And it's integrated with the qTip2 jQuery plugin to display your footnotes in lovely tooltips on hover. Plus it automatically numbers your footnotes in the order you enter them into your post. | |
| 40 | 40 | |
| 41 | -= Any plans for the future? = | |
| 41 | += How can I change the markup for the footnote label? = | |
| 42 | 42 | |
| 43 | -Yeah, I'll be integrating more of qTip's options for displaying the tooltips. Give users the ability to set their own icons and labels. And much more as I get user feedback. | |
| 43 | +Just use the `efn_footnote_label` filter in your functions.php to edit the output. | |
| 44 | 44 | |
| 45 | -= That sounds great, but I was thinking more personally. You know, are you up to anything tonight? Want to grab some pizza? = | |
| 45 | +<pre> | |
| 46 | +<code>function efn_change_label_markup( $output, $label ) { | |
| 47 | + return '<h5>' . $label . '</h5>'; | |
| 48 | +} | |
| 49 | +add_filter( 'efn_footnote_label', 'change_efn_label', 10, 2 );</code> | |
| 50 | +</pre> | |
| 46 | 51 | |
| 47 | -How did you even get in here? | |
| 52 | +== Screenshots == | |
| 48 | 53 | |
| 49 | -= It's cool I'll let myself out. One last question though. Any advice on filling up a new plugins FAQ section? = | |
| 54 | +1. Displaying a footnote on hover. | |
| 55 | +2. Several footnotes (feetnote?) at the bottom of the post. | |
| 50 | 56 | |
| 51 | -Maecenas sed diam eget risus varius blandit sit amet non magna. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Maecenas faucibus mollis interdum. | |
| 57 | +== Changelog == | |
| 52 | 58 | |
| 59 | += 1.1.1 = | |
| 60 | +* Added `efn_footnote_list_output` filter for editing entire Easy Footnote output after content | |
| 61 | +* Updating SVN to include missing JS file | |
| 53 | 62 | |
| 54 | -== Screenshots == | |
| 63 | += 1.1.0 = | |
| 64 | +* Improved accessibility for keyboard navigation of footnotes | |
| 65 | +* Started improving code to follow WordPress Coding Standards guidelines | |
| 66 | +* Added second option for footnotes using `[efn_note]` to phase out non-prefixed `[note]` | |
| 67 | +* Added `easy_footnote_label` hook to filter footnote labels | |
| 68 | +* Added `before_footnote` and `after_footnote` filters to add content before or after footnote lists after content. | |
| 55 | 69 | |
| 56 | -1. Displaying a footnote on hover. | |
| 57 | -2. Several footnotes (feetnote?) at the bottom of the post. | |
| 70 | += 1.0.16 = | |
| 71 | +* Fixing footnote counts for the last time! (Hopefully) | |
| 72 | +* Added post ID to footnote IDs to make them more unique | |
| 73 | +* New setting to hide the footnotes after content in Settings > Easy Footnotes | |
| 74 | +* Prep for a bigger update and beginning Gutenberg support | |
| 58 | 75 | |
| 59 | -== Changelog == | |
| 76 | += 1.0.15 = | |
| 77 | +* Being a noob and not testing a link added in on settings page. It works now. | |
| 60 | 78 | |
| 61 | -= 1.0.7 = | |
| 79 | += 1.0.14 = | |
| 80 | +* CSS tweak in admin screen | |
| 81 | + | |
| 82 | += 1.0.13 = | |
| 83 | +* Fixing PHP notice on shortcode when content not found | |
| 84 | + | |
| 85 | += 1.0.12 = | |
| 86 | +* Changing how footnotes are numbered to avoid duplicates caused by `the_content` filtering being applied earlier in themes. | |
| 87 | + | |
| 88 | += 1.0.11 = | |
| 89 | +* Fixed bug to prevent tooltips from opening off the screen | |
| 90 | + | |
| 91 | += 1.0.10 = | |
| 92 | +* Added in extra sanitization for user inputs within admin | |
| 93 | + | |
| 94 | += 1.0.9 = | |
| 95 | +* Fixed issue causing notice of undefined index on admin screen. Adjustment to how footnote's handle html special chars. | |
| 96 | + | |
| 97 | += 1.0.8 = | |
| 62 | 98 | * Added the Qtip2 unfocus event for hiding footnotes on iPad and other touch devices. |
| 63 | 99 | |
| 64 | 100 | = 1.0.7 = |
| 65 | 101 | * Fixed issue where Footnote title was showing on pages without any footnotes once activated through the settings. Also changed the priority of the add_filter('the_content') call to be 20 in order to show above Jetpack Related Posts |
| @@ -111,5 +147,32 @@ | ||
| 111 | 147 | = 1.0.7 = |
| 112 | 148 | Fixed issue where Footnote title was showing on pages without any footnotes once activated through the settings. Also changed the priority of the add_filter('the_content') call to be 20 in order to show above Jetpack Related Posts |
| 113 | 149 | |
| 114 | 150 | = 1.0.8 = |
| 115 | -Improved footnote usability on touch devices. | |
| 151 | +Improved footnote usability on touch devices. | |
| 152 | + | |
| 153 | += 1.0.9 = | |
| 154 | +Fixed issue causing notice of undefined index on admin screen. Adjustment to how footnote's handle html special chars. | |
| 155 | + | |
| 156 | += 1.0.10 = | |
| 157 | +Sanitizing inputs | |
| 158 | + | |
| 159 | += 1.0.11 = | |
| 160 | +Fixed bug to prevent tooltips from opening off the screen | |
| 161 | + | |
| 162 | += 1.0.12 = | |
| 163 | +Changing how footnotes are numbered to avoid duplicates caused by `the_content` filtering being applied earlier in themes. | |
| 164 | + | |
| 165 | += 1.0.13 = | |
| 166 | +Fixing PHP notice on shortcode when content not found | |
| 167 | + | |
| 168 | += 1.0.14 = | |
| 169 | +CSS tweak in admin screen | |
| 170 | + | |
| 171 | += 1.0.15 = | |
| 172 | +Being a noob and not testing a link added in on settings page. It works now. | |
| 173 | + | |
| 174 | += 1.0.16 = | |
| 175 | +* Fixing footnote counts for the last time! (Hopefully) | |
| 176 | +* Added post ID to footnote IDs to make them more unique | |
| 177 | +* New setting to hide the footnotes after content in Settings > Easy Footnotes | |
| 178 | +* Prep for a bigger update and beginning Gutenberg support | |
