Get WordPress

Plugin Directory

Changeset 3069814

Timestamp:
04/12/2024 10:57:21 PM (4 months ago)
Author:
lumiblog
Message:

corrected readmetxt

Location:
footnotes-made-easy
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • footnotes-made-easy/tags/3.0.3/readme.txt

    r3069812 r3069814  
    1071075. Live preview of a post page showing the list of footnotes at the bottom of the post
    108108
    109 == Change Log ==
    110 
    111 I use semantic versioning, with the first release being 1.0.
    112 
    113 = 3.0.3 =
    114 * Maintenance: Updated README to grammatically correct the content.
    115 * Maintenance: PHP 8.2 Compatibility test passed.
    116 * Maintenance: AD UI Box added to the plugin's settings/options page.
    117 
    118 = 3.0.2 =
    119 * Maintenance: Updated this README to include the new contributor, and more FAQs. Also updated the image assets (banner and icon)
    120 
    121 = 3.0.1 =
    122 * Maintenance: Removed all the adoption notices.
    123 
    124 = 3.0 =
    125 * Maintenance: Re-release of v1.0.4, to replace the updates added by another developer.
    126 
    127 = 1.0.4 =
    128 * Bug: Well, I messed that release up and left some test dates in place. Apologies. This fixes it all now.
    129 
    130 = 1.0.3 =
    131 * Maintenance: Added notices about the plugin closure
    132 
    133 = 1.0.2 =
    134 * Bug: Fixed some bugs around settings getting saved (thanks to [Rufus87](https://wordpress.org/support/users/rufus87/))
    135 * Enhancement: Improved code to better meet VIP coding standards (not 100% yet but looking better!)
    136 * Enhancement: Added Github links to plugin meta. Added other useful meta as well
    137 * Enhancement: Minor enhancements to the way that field headings are shown in the settings
    138 * Enhancement: Added a further check to the settings savings function, to ensure it's not called when it's not needed (thanks to [seuser](https://wordpress.org/support/users/seuser/))
    139 * Maintenance: Increased minimum PHP level 5.6 after reports of issues at 5.4. Upgrade people!
    140 * Maintenance: Removed some redundant code from where there used to be a button on the settings screen to reset all the options
    141 
    142 = 1.0.1 =
    143 * Maintenance: Updated this README to display better in the new plugin repository. Also updated the image assets (banner and icon)
    144 * Maintenance: Minimum WordPress requirement is now 4.6. This means various checks and bits of code could be removed, including the languages folder, as this is now handled natively.
    145 
    146 = 1.0 =
    147 * Initial release
    148 
    149 == Upgrade Notice ==
    150 
    151 = 3.0.3 =
    152 * Maintenance: Updated readme text, added AD UI Box. === Footnotes Made Easy ===
    153 Contributors: lumiblog, dartiss
    154 Tags: bibliography, footnotes, formatting, reference
    155 Donate link: https://wpcorner.co/donate
    156 Requires at least: 4.6
    157 Tested up to: 6.5
    158 Requires PHP: 7.4
    159 Stable tag: 3.0.3
    160 License: GPLv2 or later
    161 License URI: http://www.gnu.org/licenses/gpl-2.0.html
    162 
    163 Allows post authors to easily add and manage footnotes in posts.
    164 
    165 == Description ==
    166 
    167 Footnotes Made Easy is a simple, but powerful, method of adding footnotes to your posts and pages.
    168 
    169 **Key features include...**
    170 
    171 * Simple footnote insertion via double parentheses
    172 * Combine identical notes
    173 * Solution for paginated posts
    174 * Suppress Footnotes on specific page types
    175 * Option to display ‘pretty’ tooltips using jQuery
    176 * Lots of configuration options
    177 * And much, much more!
    178 
    179 **Footnotes Made Easy is a fork of [WP Footnotes](https://github.com/drzax/wp-footnotes "Github - wp-footnotes"), a plugin by Simon Elvery which was abandoned some years ago**.
    180 
    181 **Please visit the [Github page](https://github.com/wpcorner/footnotes-made-easy/ "Github") for the latest code development, planned enhancements and known issues**.
    182 
    183 == Getting Started ==
    184 
    185 Creating a footnote is incredibly simple - you just need to include your footnote in double parentheses, such as this...
    186 
    187 This is a sentence ((and this is your footnote)).
    188 
    189 The footnote will then appear at the bottom of your post/page.
    190 
    191 **Important note:** Make sure you include a space before your opening double parentheses or the footnote won't work!
    192 
    193 == Options ==
    194 
    195 You have a fair few options on how the identifier links, footnotes and back-links look which can be found in the WordPress admin area under 'Settings -> Footnotes'.
    196 
    197 == Paginated Posts ==
    198 
    199 Some of you seem to like the paginating post, which is kind of problematic. By default, each page of your post will have its own set of footnotes at the bottom and the numbering will start again from 1 for each page.
    200 
    201 The only way to get around this is to know how many posts are on each page and tell Footnotes Made Easy what number you want the list to start at for each of the pages. So at some point on each page (that is, between each `<!--nextpage-->` tag) you need to add a tag to let the plugin know what number the footnotes on this page should start at. The tag should look like this `<!--startnum=5-->` where "5" is the number you want the footnotes for this page to start at.
    202 
    203 == Referencing ==
    204 
    205 Sometimes it's useful to be able to refer to a previous footnote a second (or third, or fourth...) time. To do this, you can either simply insert the exact same text as you did the first time and the identifier should simply reference the previous note. Alternatively, if you don't want to do all that typing again, you can construct a footnote like this: `((ref:1))` and the identifier will reference the footnote with the given number.
    206 
    207 Even though it's a little more typing, using the exact text method is much more robust. The number referencing will not work across multiple pages in a paged post (but will work within the page). Also, if you use the number referencing system you risk them identifying the incorrect footnote if you go back and insert a new footnote and forget to change the referenced number.
    208 
    209 == Available in 8 Languages ==
    210 
    211 Footnotes Made Easy is fully internationalized, and ready for translations.
    212 
    213 **Many thanks to the following translators for their contributions:**
    214 
    215 * [David Artiss](https://profiles.wordpress.org/dartiss/), English (UK)
    216 * [Mark Robson](https://profiles.wordpress.org/markscottrobson/), English (UK)
    217 * [Annabelle W](https://profiles.wordpress.org/yayannabelle/), English (UK)
    218 * [maboroshin](https://profiles.wordpress.org/maboroshin/), Japanese
    219 * [Laurent MILLET](https://profiles.wordpress.org/wplmillet/), French (France)
    220 * [B. Cansmile Cha](https://profiles.wordpress.org/cansmile/), Korean
    221 * [danbilabs](https://profiles.wordpress.org/danbilabs/), Korean
    222 * [denelan](https://profiles.wordpress.org/danbilabs/), Dutch
    223 * [Peter Smits](https://profiles.wordpress.org/psmits1567/), Dutch
    224 * [Pieterjan Deneys](https://profiles.wordpress.org/nekojonez/), Dutch (Belgium)
    225 * [Alex Grey](https://profiles.wordpress.org/alexvgrey/), Russian
    226 
    227 **If you would like to add a translation to this plugin then please head to our [Translating WordPress](https://translate.wordpress.org/projects/wp-plugins/footnotes-made-easy "Translating WordPress") page**
    228 
    229 == Installation ==
    230 
    231 Footnotes Made Easy can be found and installed via the Plugin menu within WordPress administration (Plugins -> Add New). Alternatively, it can be downloaded from WordPress.org and installed manually...
    232 
    233 1. Upload the entire `footnotes-made-easy` folder to your `wp-content/plugins/` directory.
    234 2. Activate the plugin through the 'Plugins' menu in WordPress administration.
    235 
    236 Voila! It's ready to go.
    237 
    238 == Frequently Asked Questions ==
    239 
    240 = How do I add a footnote to my post or page? =
    241 
    242 To add a footnote, surround the footnote text with the opening and closing footnote markers specified in the plugin settings. By default, these are `(( and ))`.
    243 
    244 = Other than the available options, can the footnotes output be styled? =
    245 
    246 Yes, it can. The easiest way is to use the CSS editor in your theme customizer. For example, 'ol.footnotes' refers to the footnotes list in general and 'ol.footnotes li' the individual footnotes.
    247 
    248 = Can I disable footnotes on specific parts of my website? =
    249 
    250 Yes, the plugin provides options to disable footnotes on the home page, archives, search results, feeds, and previews.
    251 
    252 == Screenshots ==
    253 
    254 1. The Settings screen with advanced settings shown
    255 2. Continuation of the settings screen with advanced settings shown
    256 3. The post editor page showing how to insert footnotes
    257 4. Live preview of a post page showing footnotes within the page
    258 5. Live preview of a post page showing the list of footnotes at the bottom of the post
    259 
    260 == Change Log ==
     109== Changelog ==
    261110
    262111I use semantic versioning, with the first release being 1.0.

  • footnotes-made-easy/trunk/readme.txt

    r3069812 r3069814  
    1071075. Live preview of a post page showing the list of footnotes at the bottom of the post
    108108
    109 == Change Log ==
    110 
    111 I use semantic versioning, with the first release being 1.0.
    112 
    113 = 3.0.3 =
    114 * Maintenance: Updated README to grammatically correct the content.
    115 * Maintenance: PHP 8.2 Compatibility test passed.
    116 * Maintenance: AD UI Box added to the plugin's settings/options page.
    117 
    118 = 3.0.2 =
    119 * Maintenance: Updated this README to include the new contributor, and more FAQs. Also updated the image assets (banner and icon)
    120 
    121 = 3.0.1 =
    122 * Maintenance: Removed all the adoption notices.
    123 
    124 = 3.0 =
    125 * Maintenance: Re-release of v1.0.4, to replace the updates added by another developer.
    126 
    127 = 1.0.4 =
    128 * Bug: Well, I messed that release up and left some test dates in place. Apologies. This fixes it all now.
    129 
    130 = 1.0.3 =
    131 * Maintenance: Added notices about the plugin closure
    132 
    133 = 1.0.2 =
    134 * Bug: Fixed some bugs around settings getting saved (thanks to [Rufus87](https://wordpress.org/support/users/rufus87/))
    135 * Enhancement: Improved code to better meet VIP coding standards (not 100% yet but looking better!)
    136 * Enhancement: Added Github links to plugin meta. Added other useful meta as well
    137 * Enhancement: Minor enhancements to the way that field headings are shown in the settings
    138 * Enhancement: Added a further check to the settings savings function, to ensure it's not called when it's not needed (thanks to [seuser](https://wordpress.org/support/users/seuser/))
    139 * Maintenance: Increased minimum PHP level 5.6 after reports of issues at 5.4. Upgrade people!
    140 * Maintenance: Removed some redundant code from where there used to be a button on the settings screen to reset all the options
    141 
    142 = 1.0.1 =
    143 * Maintenance: Updated this README to display better in the new plugin repository. Also updated the image assets (banner and icon)
    144 * Maintenance: Minimum WordPress requirement is now 4.6. This means various checks and bits of code could be removed, including the languages folder, as this is now handled natively.
    145 
    146 = 1.0 =
    147 * Initial release
    148 
    149 == Upgrade Notice ==
    150 
    151 = 3.0.3 =
    152 * Maintenance: Updated readme text, added AD UI Box. === Footnotes Made Easy ===
    153 Contributors: lumiblog, dartiss
    154 Tags: bibliography, footnotes, formatting, reference
    155 Donate link: https://wpcorner.co/donate
    156 Requires at least: 4.6
    157 Tested up to: 6.5
    158 Requires PHP: 7.4
    159 Stable tag: 3.0.3
    160 License: GPLv2 or later
    161 License URI: http://www.gnu.org/licenses/gpl-2.0.html
    162 
    163 Allows post authors to easily add and manage footnotes in posts.
    164 
    165 == Description ==
    166 
    167 Footnotes Made Easy is a simple, but powerful, method of adding footnotes to your posts and pages.
    168 
    169 **Key features include...**
    170 
    171 * Simple footnote insertion via double parentheses
    172 * Combine identical notes
    173 * Solution for paginated posts
    174 * Suppress Footnotes on specific page types
    175 * Option to display ‘pretty’ tooltips using jQuery
    176 * Lots of configuration options
    177 * And much, much more!
    178 
    179 **Footnotes Made Easy is a fork of [WP Footnotes](https://github.com/drzax/wp-footnotes "Github - wp-footnotes"), a plugin by Simon Elvery which was abandoned some years ago**.
    180 
    181 **Please visit the [Github page](https://github.com/wpcorner/footnotes-made-easy/ "Github") for the latest code development, planned enhancements and known issues**.
    182 
    183 == Getting Started ==
    184 
    185 Creating a footnote is incredibly simple - you just need to include your footnote in double parentheses, such as this...
    186 
    187 This is a sentence ((and this is your footnote)).
    188 
    189 The footnote will then appear at the bottom of your post/page.
    190 
    191 **Important note:** Make sure you include a space before your opening double parentheses or the footnote won't work!
    192 
    193 == Options ==
    194 
    195 You have a fair few options on how the identifier links, footnotes and back-links look which can be found in the WordPress admin area under 'Settings -> Footnotes'.
    196 
    197 == Paginated Posts ==
    198 
    199 Some of you seem to like the paginating post, which is kind of problematic. By default, each page of your post will have its own set of footnotes at the bottom and the numbering will start again from 1 for each page.
    200 
    201 The only way to get around this is to know how many posts are on each page and tell Footnotes Made Easy what number you want the list to start at for each of the pages. So at some point on each page (that is, between each `<!--nextpage-->` tag) you need to add a tag to let the plugin know what number the footnotes on this page should start at. The tag should look like this `<!--startnum=5-->` where "5" is the number you want the footnotes for this page to start at.
    202 
    203 == Referencing ==
    204 
    205 Sometimes it's useful to be able to refer to a previous footnote a second (or third, or fourth...) time. To do this, you can either simply insert the exact same text as you did the first time and the identifier should simply reference the previous note. Alternatively, if you don't want to do all that typing again, you can construct a footnote like this: `((ref:1))` and the identifier will reference the footnote with the given number.
    206 
    207 Even though it's a little more typing, using the exact text method is much more robust. The number referencing will not work across multiple pages in a paged post (but will work within the page). Also, if you use the number referencing system you risk them identifying the incorrect footnote if you go back and insert a new footnote and forget to change the referenced number.
    208 
    209 == Available in 8 Languages ==
    210 
    211 Footnotes Made Easy is fully internationalized, and ready for translations.
    212 
    213 **Many thanks to the following translators for their contributions:**
    214 
    215 * [David Artiss](https://profiles.wordpress.org/dartiss/), English (UK)
    216 * [Mark Robson](https://profiles.wordpress.org/markscottrobson/), English (UK)
    217 * [Annabelle W](https://profiles.wordpress.org/yayannabelle/), English (UK)
    218 * [maboroshin](https://profiles.wordpress.org/maboroshin/), Japanese
    219 * [Laurent MILLET](https://profiles.wordpress.org/wplmillet/), French (France)
    220 * [B. Cansmile Cha](https://profiles.wordpress.org/cansmile/), Korean
    221 * [danbilabs](https://profiles.wordpress.org/danbilabs/), Korean
    222 * [denelan](https://profiles.wordpress.org/danbilabs/), Dutch
    223 * [Peter Smits](https://profiles.wordpress.org/psmits1567/), Dutch
    224 * [Pieterjan Deneys](https://profiles.wordpress.org/nekojonez/), Dutch (Belgium)
    225 * [Alex Grey](https://profiles.wordpress.org/alexvgrey/), Russian
    226 
    227 **If you would like to add a translation to this plugin then please head to our [Translating WordPress](https://translate.wordpress.org/projects/wp-plugins/footnotes-made-easy "Translating WordPress") page**
    228 
    229 == Installation ==
    230 
    231 Footnotes Made Easy can be found and installed via the Plugin menu within WordPress administration (Plugins -> Add New). Alternatively, it can be downloaded from WordPress.org and installed manually...
    232 
    233 1. Upload the entire `footnotes-made-easy` folder to your `wp-content/plugins/` directory.
    234 2. Activate the plugin through the 'Plugins' menu in WordPress administration.
    235 
    236 Voila! It's ready to go.
    237 
    238 == Frequently Asked Questions ==
    239 
    240 = How do I add a footnote to my post or page? =
    241 
    242 To add a footnote, surround the footnote text with the opening and closing footnote markers specified in the plugin settings. By default, these are `(( and ))`.
    243 
    244 = Other than the available options, can the footnotes output be styled? =
    245 
    246 Yes, it can. The easiest way is to use the CSS editor in your theme customizer. For example, 'ol.footnotes' refers to the footnotes list in general and 'ol.footnotes li' the individual footnotes.
    247 
    248 = Can I disable footnotes on specific parts of my website? =
    249 
    250 Yes, the plugin provides options to disable footnotes on the home page, archives, search results, feeds, and previews.
    251 
    252 == Screenshots ==
    253 
    254 1. The Settings screen with advanced settings shown
    255 2. Continuation of the settings screen with advanced settings shown
    256 3. The post editor page showing how to insert footnotes
    257 4. Live preview of a post page showing footnotes within the page
    258 5. Live preview of a post page showing the list of footnotes at the bottom of the post
    259 
    260 == Change Log ==
     109== Changelog ==
    261110
    262111I use semantic versioning, with the first release being 1.0.
Note: See TracChangeset for help on using the changeset viewer.