| 1 |
=== Easy Footnotes === |
| 2 |
Contributors: yingling017, twinpictures |
| 3 |
Donate link: http://jasonyingling.me |
| 4 |
Tags: footnotes, read, blogging, hover, tooltips, editing, endnotes, Formatting, writing, bibliography, notes, reference |
| 5 |
Requires at least: 3.0.1 |
| 6 |
Tested up to: 5.0 |
| 7 |
Stable tag: 1.1.2 |
| 8 |
License: GPLv2 or later |
| 9 |
License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 10 |
|
| 11 |
Easy Footnotes lets you quickly and easily add footnotes throughout your WordPress posts using a simple shortcode in the text editor. |
| 12 |
|
| 13 |
== Description == |
| 14 |
|
| 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 |
|
| 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 |
|
| 19 |
That's all it takes to start adding footnotes to your WordPress blog! |
| 20 |
|
| 21 |
== Installation == |
| 22 |
|
| 23 |
1. Upload the 'easy-footnotes' folder to the '/wp-content/plugins/' directory. |
| 24 |
2. Activate the plugin through the 'Plugins' menu in WordPress |
| 25 |
3. That's it! Now simply start using the [efn_note]Footnote content goes here.[/efn_note] shortcode within your posts. |
| 26 |
|
| 27 |
== Frequently Asked Questions == |
| 28 |
|
| 29 |
= How do I insert a footnote into my post. = |
| 30 |
|
| 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 |
|
| 33 |
= That's awesome! = |
| 34 |
|
| 35 |
I know, but that's not really a question. |
| 36 |
|
| 37 |
= Oh right, why is that so awesome? = |
| 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. |
| 40 |
|
| 41 |
= How can I change the markup for the footnote label? = |
| 42 |
|
| 43 |
Just use the `efn_footnote_label` filter in your functions.php to edit the output. |
| 44 |
|
| 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> |
| 51 |
|
| 52 |
== Screenshots == |
| 53 |
|
| 54 |
1. Displaying a footnote on hover. |
| 55 |
2. Several footnotes (feetnote?) at the bottom of the post. |
| 56 |
|
| 57 |
== Changelog == |
| 58 |
|
| 59 |
= 1.1.2 = |
| 60 |
* Fixed issue with default settings not being set on new installations |
| 61 |
* Added conditional logic check if settings exist to avoid PHP Warnings |
| 62 |
* Fixed undefined index of $efn_output when not using Easy Footnotes label |
| 63 |
|
| 64 |
= 1.1.1 = |
| 65 |
* Added `efn_footnote_list_output` filter for editing entire Easy Footnote output after content |
| 66 |
* Updating SVN to include missing JS file |
| 67 |
|
| 68 |
= 1.1.0 = |
| 69 |
* Improved accessibility for keyboard navigation of footnotes |
| 70 |
* Started improving code to follow WordPress Coding Standards guidelines |
| 71 |
* Added second option for footnotes using `[efn_note]` to phase out non-prefixed `[note]` |
| 72 |
* Added `easy_footnote_label` hook to filter footnote labels |
| 73 |
* Added `before_footnote` and `after_footnote` filters to add content before or after footnote lists after content. |
| 74 |
|
| 75 |
= 1.0.16 = |
| 76 |
* Fixing footnote counts for the last time! (Hopefully) |
| 77 |
* Added post ID to footnote IDs to make them more unique |
| 78 |
* New setting to hide the footnotes after content in Settings > Easy Footnotes |
| 79 |
* Prep for a bigger update and beginning Gutenberg support |
| 80 |
|
| 81 |
= 1.0.15 = |
| 82 |
* Being a noob and not testing a link added in on settings page. It works now. |
| 83 |
|
| 84 |
= 1.0.14 = |
| 85 |
* CSS tweak in admin screen |
| 86 |
|
| 87 |
= 1.0.13 = |
| 88 |
* Fixing PHP notice on shortcode when content not found |
| 89 |
|
| 90 |
= 1.0.12 = |
| 91 |
* Changing how footnotes are numbered to avoid duplicates caused by `the_content` filtering being applied earlier in themes. |
| 92 |
|
| 93 |
= 1.0.11 = |
| 94 |
* Fixed bug to prevent tooltips from opening off the screen |
| 95 |
|
| 96 |
= 1.0.10 = |
| 97 |
* Added in extra sanitization for user inputs within admin |
| 98 |
|
| 99 |
= 1.0.9 = |
| 100 |
* Fixed issue causing notice of undefined index on admin screen. Adjustment to how footnote's handle html special chars. |
| 101 |
|
| 102 |
= 1.0.8 = |
| 103 |
* Added the Qtip2 unfocus event for hiding footnotes on iPad and other touch devices. |
| 104 |
|
| 105 |
= 1.0.7 = |
| 106 |
* 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 |
| 107 |
|
| 108 |
= 1.0.6 = |
| 109 |
* Added the ability to insert a title above the footnote section at the bottom of the post content. This is controlled in the Easy Footnotes Settings page that can be found under Settings in the WordPress Dashboard. |
| 110 |
|
| 111 |
= 1.0.5 = |
| 112 |
* Updating logic for appending footnotes to the bottom of posts. Now only appends to single posts, custom post types and pages that are using the main post query. Also fixed footnote count when multiple posts are shown in the content on one page, such as the home page. Footnotes outside of the single post also now link to the footnote within the single post. |
| 113 |
|
| 114 |
= 1.0.4 = |
| 115 |
* Fixed bug where footnotes were being appended to the end of the content on home pages and ignoring the more tag |
| 116 |
|
| 117 |
= 1.0.3 = |
| 118 |
* Added a delay of 400ms to the footnote closing so it stays open better when hovered |
| 119 |
|
| 120 |
= 1.0.2 = |
| 121 |
* I messed up the version tag on 1.0.1. Just upping ti 1.0.2 for precautions. |
| 122 |
|
| 123 |
= 1.0.1 = |
| 124 |
* Footnotes now stay open when moused over for interacting with links |
| 125 |
|
| 126 |
= 1.0.0 = |
| 127 |
* Initial release |
| 128 |
|
| 129 |
== Upgrade Notice == |
| 130 |
|
| 131 |
= 1.0.0 = |
| 132 |
Initial release |
| 133 |
|
| 134 |
= 1.0.1 = |
| 135 |
Footnotes now stay open when moused over. Allows for adding links into footnotes. |
| 136 |
|
| 137 |
= 1.0.2 = |
| 138 |
I messed up the version tag on 1.0.1. Just upping it 1.0.2 for precautions. |
| 139 |
|
| 140 |
= 1.0.3 = |
| 141 |
Added a 400ms delay to the footnote closing via qTip. This allows the footnote to stay open better when mousing into for access to links. |
| 142 |
|
| 143 |
= 1.0.4 = |
| 144 |
Fixed bug where footnotes were being appended to the end of the content on home pages and ignoring the more tag |
| 145 |
|
| 146 |
= 1.0.5 = |
| 147 |
Updated logic for appending footnotes to the bottom of single posts and pages. Now using is_singular and is_main_query as opposed to just is_single. This allows for appending posts to the bottom of posts, custom post types, and pages. Also fixed logic for numbering posts on the home page when showing multiple posts. Footnotes outside of the single post also now link to the footnote within the single post. |
| 148 |
|
| 149 |
= 1.0.6 = |
| 150 |
Added the ability to insert a title above the footnote section at the bottom of the post content. This is controlled in the Easy Footnotes Settings page that can be found under Settings in the WordPress Dashboard. |
| 151 |
|
| 152 |
= 1.0.7 = |
| 153 |
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 |
| 154 |
|
| 155 |
= 1.0.8 = |
| 156 |
Improved footnote usability on touch devices. |
| 157 |
|
| 158 |
= 1.0.9 = |
| 159 |
Fixed issue causing notice of undefined index on admin screen. Adjustment to how footnote's handle html special chars. |
| 160 |
|
| 161 |
= 1.0.10 = |
| 162 |
Sanitizing inputs |
| 163 |
|
| 164 |
= 1.0.11 = |
| 165 |
Fixed bug to prevent tooltips from opening off the screen |
| 166 |
|
| 167 |
= 1.0.12 = |
| 168 |
Changing how footnotes are numbered to avoid duplicates caused by `the_content` filtering being applied earlier in themes. |
| 169 |
|
| 170 |
= 1.0.13 = |
| 171 |
Fixing PHP notice on shortcode when content not found |
| 172 |
|
| 173 |
= 1.0.14 = |
| 174 |
CSS tweak in admin screen |
| 175 |
|
| 176 |
= 1.0.15 = |
| 177 |
Being a noob and not testing a link added in on settings page. It works now. |
| 178 |
|
| 179 |
= 1.0.16 = |
| 180 |
* Fixing footnote counts for the last time! (Hopefully) |
| 181 |
* Added post ID to footnote IDs to make them more unique |
| 182 |
* New setting to hide the footnotes after content in Settings > Easy Footnotes |
| 183 |
* Prep for a bigger update and beginning Gutenberg support |
| 184 |
|
