forked from JeroenSormani/footnotes-made-easy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathreadme.txt
More file actions
executable file
·102 lines (63 loc) · 5.51 KB
/
readme.txt
File metadata and controls
executable file
·102 lines (63 loc) · 5.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
=== Footnotes Made Easy ===
Contributors: dartiss
Tags: bibliography, footnotes, formatting, notes, reference, referencing
Requires at least: 4.6
Tested up to: 4.9
Requires PHP: 5.3
Stable tag: 1.0.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Allows post authors to easily add and manage footnotes in posts.
== Description ==
Footnotes Made Easy is a simple, but powerful, method of adding footnotes into your posts and pages.
Key features include...
* Simple footnote insertion via double parentheses
* Combine identical notes
* Solution for paginated posts
* Suppress Footnotes on specific page types
* Option to display ‘pretty’ tooltips using jQuery
* Lots of configuration options
* And much, much more!
Technical specification...
* Licensed under [GPLv2 (or later)](http://wordpress.org/about/gpl/ "GNU General Public License")
* Designed for both single and multi-site installations
* PHP7 compatible
* Fully internationalized, ready for translations. **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**
**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.**
Please visit the [Github page](https://github.com/dartiss/footnotes-made-easy "Github") for the latest code development, planned enhancements and known issues.
== Getting Started ==
Creating a footnote is incredibly simple - you just need to include your footnote in double parentheses, such as this...
This is a sentence ((and this is your footnote)).
The footnote will then appear at the bottom of your post/page.
**Important note:** Make sure you include a space before your opening double parentheses or the footnote won't work!
== Options ==
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.
== Paginated Posts ==
Some of you seem to like paginating post, which is kind of problematic. By default each page of your post will have it's own set of footnotes at the bottom and the numbering will start again from 1 for each page.
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.
== Referencing ==
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.
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.
== Installation ==
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...
1. Upload the entire `footnotes-made-easy` folder to your `wp-content/plugins/` directory.
2. Activate the plugin through the 'Plugins' menu in WordPress administration.
Voila! It's ready to go.
== Frequently Asked Questions ==
= What are the plans for this plugin? =
Release 1.0 is literally the last version of the plugin code from 4 years ago with new branding added to it and removal of some code that I knew didn't work. The next release will see the code tidied up and some initial minor extras added. At this stage I will be looking to add more major features but nothing too much - I wish to keep the plugin as easy-to-use as possible with simplified features.
= Other than the available options, can the footnotes output be styled? =
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.
== Screenshots ==
1. An example showing the footnotes in use
2. The settings screen with advanced settings shown
== Change Log ==
[Learn more about my version numbering methodology](https://artiss.blog/2016/09/wordpress-plugin-versioning/ "WordPress Plugin Versioning")
= 1.1 =
* Maintenance: Updated this README to display better in the new plugin repository. Also updated the image assets (banner and icon)
* 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.
= 1.0 =
* Initial release
== Upgrade Notice ==
= 1.1 =
* A load of maintenance changes. They’re not sexy but they’re necessary.