diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md index f55c285..e24b6ac 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,18 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor - You can run either across the entire project by adding the argument `--ignore=*/vendor/*` and targetting the file `./**/*.php` - You may have to enable double-wildcards in your console first (`shopt -s globstar`) +## Building + +1. Run `_tools/build-stylesheets.sh -c` to concatenate stylesheets +1. Manually minify the output files in `css/tmp/`, saving them as `.min.css` files + - The intention is to replace this with automated minification, meaning that + all of these steps can be rolled into a single `build` command. +1. Run `_tools/build-stylesheets.sh -d` to deploy the minified files to `dist/` + - **this will delete any existing `dist/` folder** +1. Run `composer run build` to move over the remaining files to `dist/` + - Currently, the files to include in a distribution are hard-coded in `_tools/build.sh` + - The intention is to replace this with a proper parsing of the `.distignore` file + ## Updating Documentation 1. Install [phpDocumentor](https://phpdoc.org/) diff --git a/class/convert.php b/class/convert.php index 3adb313..c994d7a 100644 --- a/class/convert.php +++ b/class/convert.php @@ -1,4 +1,4 @@ -get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT ); if ( 'none' !== $l_str_page_layout_option ) { @@ -376,7 +376,7 @@ class MCI_Footnotes { MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-layout-' . $l_str_page_layout_option . '.css' ), array(), - C_STR_FOOTNOTES_VERSION, + C_STR_PACKAGE_VERSION, 'all' ); } diff --git a/composer.json b/composer.json deleted file mode 100644 index 85ecd48..0000000 --- a/composer.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "require-dev": { - "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1", - "wp-coding-standards/wpcs": "^2.3" - }, - "scripts": { - "post-install-cmd": [ - "bash _tools/setup.sh" - ] - } -} diff --git a/composer.lock b/composer.lock deleted file mode 100644 index 9e0ee7c..0000000 --- a/composer.lock +++ /dev/null @@ -1,196 +0,0 @@ -{ - "_readme": [ - "This file locks the dependencies of your project to a known state", - "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", - "This file is @generated automatically" - ], - "content-hash": "3a147d50695956de52f7cbf827b47830", - "packages": [], - "packages-dev": [ - { - "name": "dealerdirect/phpcodesniffer-composer-installer", - "version": "v0.7.1", - "source": { - "type": "git", - "url": "https://github.com/Dealerdirect/phpcodesniffer-composer-installer.git", - "reference": "fe390591e0241955f22eb9ba327d137e501c771c" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/Dealerdirect/phpcodesniffer-composer-installer/zipball/fe390591e0241955f22eb9ba327d137e501c771c", - "reference": "fe390591e0241955f22eb9ba327d137e501c771c", - "shasum": "" - }, - "require": { - "composer-plugin-api": "^1.0 || ^2.0", - "php": ">=5.3", - "squizlabs/php_codesniffer": "^2.0 || ^3.0 || ^4.0" - }, - "require-dev": { - "composer/composer": "*", - "phpcompatibility/php-compatibility": "^9.0", - "sensiolabs/security-checker": "^4.1.0" - }, - "type": "composer-plugin", - "extra": { - "class": "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin" - }, - "autoload": { - "psr-4": { - "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Franck Nijhof", - "email": "franck.nijhof@dealerdirect.com", - "homepage": "http://www.frenck.nl", - "role": "Developer / IT Manager" - } - ], - "description": "PHP_CodeSniffer Standards Composer Installer Plugin", - "homepage": "http://www.dealerdirect.com", - "keywords": [ - "PHPCodeSniffer", - "PHP_CodeSniffer", - "code quality", - "codesniffer", - "composer", - "installer", - "phpcs", - "plugin", - "qa", - "quality", - "standard", - "standards", - "style guide", - "stylecheck", - "tests" - ], - "support": { - "issues": "https://github.com/dealerdirect/phpcodesniffer-composer-installer/issues", - "source": "https://github.com/dealerdirect/phpcodesniffer-composer-installer" - }, - "time": "2020-12-07T18:04:37+00:00" - }, - { - "name": "squizlabs/php_codesniffer", - "version": "3.5.8", - "source": { - "type": "git", - "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", - "reference": "9d583721a7157ee997f235f327de038e7ea6dac4" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/9d583721a7157ee997f235f327de038e7ea6dac4", - "reference": "9d583721a7157ee997f235f327de038e7ea6dac4", - "shasum": "" - }, - "require": { - "ext-simplexml": "*", - "ext-tokenizer": "*", - "ext-xmlwriter": "*", - "php": ">=5.4.0" - }, - "require-dev": { - "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" - }, - "bin": [ - "bin/phpcs", - "bin/phpcbf" - ], - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "3.x-dev" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Greg Sherwood", - "role": "lead" - } - ], - "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", - "homepage": "https://github.com/squizlabs/PHP_CodeSniffer", - "keywords": [ - "phpcs", - "standards" - ], - "support": { - "issues": "https://github.com/squizlabs/PHP_CodeSniffer/issues", - "source": "https://github.com/squizlabs/PHP_CodeSniffer", - "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki" - }, - "time": "2020-10-23T02:01:07+00:00" - }, - { - "name": "wp-coding-standards/wpcs", - "version": "2.3.0", - "source": { - "type": "git", - "url": "https://github.com/WordPress/WordPress-Coding-Standards.git", - "reference": "7da1894633f168fe244afc6de00d141f27517b62" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/WordPress/WordPress-Coding-Standards/zipball/7da1894633f168fe244afc6de00d141f27517b62", - "reference": "7da1894633f168fe244afc6de00d141f27517b62", - "shasum": "" - }, - "require": { - "php": ">=5.4", - "squizlabs/php_codesniffer": "^3.3.1" - }, - "require-dev": { - "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || ^0.6", - "phpcompatibility/php-compatibility": "^9.0", - "phpcsstandards/phpcsdevtools": "^1.0", - "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" - }, - "suggest": { - "dealerdirect/phpcodesniffer-composer-installer": "^0.6 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically." - }, - "type": "phpcodesniffer-standard", - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Contributors", - "homepage": "https://github.com/WordPress/WordPress-Coding-Standards/graphs/contributors" - } - ], - "description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions", - "keywords": [ - "phpcs", - "standards", - "wordpress" - ], - "support": { - "issues": "https://github.com/WordPress/WordPress-Coding-Standards/issues", - "source": "https://github.com/WordPress/WordPress-Coding-Standards", - "wiki": "https://github.com/WordPress/WordPress-Coding-Standards/wiki" - }, - "time": "2020-05-13T23:57:56+00:00" - } - ], - "aliases": [], - "minimum-stability": "stable", - "stability-flags": [], - "prefer-stable": false, - "prefer-lowest": false, - "platform": [], - "platform-dev": [], - "plugin-api-version": "2.0.0" -} diff --git a/contrib/pre-commit b/contrib/pre-commit deleted file mode 100644 index 0dc792f..0000000 --- a/contrib/pre-commit +++ /dev/null @@ -1,61 +0,0 @@ -#!/bin/sh - -# Modified from: https://github.com/bjornjohansen/wp-pre-commit-hook -# Also: https://softdiscover.com/wordpress/perfect-setup-for-a-wordpress-project-development/ - -PROJECT=`php -r "echo dirname(dirname(dirname(realpath('$0'))));"` -STAGED_FILES_CMD=`git diff --cached --name-only --diff-filter=ACMR HEAD | grep \\\\.php` - -# Determine if a file list is passed -if [ "$#" -eq 1 ] -then - oIFS=$IFS - IFS=' - ' - SFILES="$1" - IFS=$oIFS -fi -SFILES=${SFILES:-$STAGED_FILES_CMD} - -echo "Checking PHP Lint..." -for FILE in $SFILES -do - php -l -d display_errors=0 $PROJECT/$FILE - if [ $? != 0 ] - then - echo "Fix the error before commit." - exit 1 - fi - FILES="$FILES $PROJECT/$FILE" -done - -if [ -f "$PROJECT/phpcs.ruleset.xml" ] -then - RULESET="$PROJECT/phpcs.ruleset.xml" -elif [ -f "$PROJECT/phpcs.xml.dist" ] -then - RULESET="$PROJECT/phpcs.xml.dist" -else - RULESET="WordPress" -fi - -if [ "$FILES" != "" ] -then - echo "Checking Code Standard Compliance, using $RULESET as ruleset standard..." - ./vendor/bin/phpcs --standard="$RULESET" --colors --encoding=utf-8 -n -p $FILES - if [ $? != 0 ] - then - echo "Coding standards errors have been detected. Running phpcbf..." - ./vendor/bin/phpcbf --standard="$RULESET" --encoding=utf-8 -n -p $FILES - git add $FILES - echo "Running Code Sniffer again..." - ./vendor/bin/phpcs --standard="$RULESET" --colors --encoding=utf-8 -n -p $FILES - if [ $? != 0 ] - then - echo "Errors found not fixable automatically. You need to manually fix them." - exit 1 - fi - fi -fi - -exit $? diff --git a/development/customized-documentation-schema.txt b/customized-documentation-schema.txt similarity index 97% rename from development/customized-documentation-schema.txt rename to customized-documentation-schema.txt index dbb72e9..7ce343a 100644 --- a/development/customized-documentation-schema.txt +++ b/customized-documentation-schema.txt @@ -1,5 +1,5 @@ customized-documentation-schema.txt -@lastmodified 2021-02-15T2022+0100 +@lastmodified 2021-03-05T0501+0100 Plugin Footnotes for WordPress, v2.5.4 and later @@ -255,10 +255,12 @@ MISSING TAGS: @modified @publisher @reporter +@revision +@timestamp @user -▲ Config (original, missing and added tags), example of VS Code +▲ Config (original, missing and added tags), example of VS Code. /usr/share/code/resources/app/extensions/php/syntaxes/php.tmLanguage.json original: @@ -274,4 +276,4 @@ PHPStan: |extends|implements|template custom: -|accountable|bib|biblio|callback|commit|committer|contributor|courtesy|date|datetime|lastmodified|modified|publisher|reporter|user +|accountable|bib|biblio|callback|commit|committer|contributor|courtesy|date|datetime|lastmodified|modified|publisher|reporter|revision|timestamp|user diff --git a/development/customized-template-stack.txt b/customized-template-stack.txt similarity index 100% rename from development/customized-template-stack.txt rename to customized-template-stack.txt diff --git a/development/csscat.sh b/development/csscat.sh deleted file mode 100755 index 1d5c453..0000000 --- a/development/csscat.sh +++ /dev/null @@ -1,68 +0,0 @@ -#!/bin/bash -# 2021-02-15T1839+0100 -# Last modified: 2021-02-16T0155+0100 -# csscat.sh -# Concatenates CSS files; deletes the concatenations after they’ve been minified. -# -# 12 unified style sheets are concatenated out of these files: -# dev-common.css -# dev-tooltips.css -# dev-tooltips-alternative.css -# dev-layout-reference-container.css -# dev-layout-entry-content.css -# dev-layout-main-content.css -# -echo "Running $(dirname "$0")/csscat.sh" -if [[ $1 == "c" ]]; then -echo "Concatenate in csscat/ for minification:" -cd ../css -mkdir csscat -cat dev-common.css > csscat/footnotes-nottbrpl0.css -cat dev-common.css dev-layout-reference-container.css > csscat/footnotes-nottbrpl1.css -cat dev-common.css dev-layout-entry-content.css > csscat/footnotes-nottbrpl2.css -cat dev-common.css dev-layout-main-content.css > csscat/footnotes-nottbrpl3.css -cat dev-common.css dev-tooltips.css > csscat/footnotes-jqttbrpl0.css -cat dev-common.css dev-tooltips.css dev-layout-reference-container.css > csscat/footnotes-jqttbrpl1.css -cat dev-common.css dev-tooltips.css dev-layout-entry-content.css > csscat/footnotes-jqttbrpl2.css -cat dev-common.css dev-tooltips.css dev-layout-main-content.css > csscat/footnotes-jqttbrpl3.css -cat dev-common.css dev-tooltips.css dev-tooltips-alternative.css > csscat/footnotes-alttbrpl0.css -cat dev-common.css dev-tooltips.css dev-tooltips-alternative.css dev-layout-reference-container.css > csscat/footnotes-alttbrpl1.css -cat dev-common.css dev-tooltips.css dev-tooltips-alternative.css dev-layout-entry-content.css > csscat/footnotes-alttbrpl2.css -cat dev-common.css dev-tooltips.css dev-tooltips-alternative.css dev-layout-main-content.css > csscat/footnotes-alttbrpl3.css -echo "Done." -elif [[ $1 == "d" ]]; then -echo "Move minified to css/ and delete concatenations and their temp dir:" -cd ../css/csscat -mv footnotes-nottbrpl0.min.css .. -mv footnotes-nottbrpl1.min.css .. -mv footnotes-nottbrpl2.min.css .. -mv footnotes-nottbrpl3.min.css .. -mv footnotes-jqttbrpl0.min.css .. -mv footnotes-jqttbrpl1.min.css .. -mv footnotes-jqttbrpl2.min.css .. -mv footnotes-jqttbrpl3.min.css .. -mv footnotes-alttbrpl0.min.css .. -mv footnotes-alttbrpl1.min.css .. -mv footnotes-alttbrpl2.min.css .. -mv footnotes-alttbrpl3.min.css .. -cd .. -rm -r csscat -echo "Done." -else -echo "Concatenates CSS files; deletes the concatenations after they’ve been minified." -echo "" -echo "12 unified style sheets are concatenated out of these files:" -echo "" -echo "dev-common.css" -echo "" -echo "dev-tooltips.css" -echo "dev-tooltips-alternative.css" -echo "" -echo "dev-layout-reference-container.css" -echo "dev-layout-entry-content.css" -echo "dev-layout-main-content.css" -echo "" -echo "Command: c: Concatenate temporary files waiting for minification." -echo "Command: d: Move the minified files to css/, delete the temporary." -echo "No command, \"--help\", or anything else: Output this help section." -fi diff --git a/footnotes.php b/footnotes.php index 0a62412..2e9634b 100755 --- a/footnotes.php +++ b/footnotes.php @@ -4,7 +4,9 @@ * Plugin URI: https://wordpress.org/plugins/footnotes/ * Description: time to bring footnotes to your website! footnotes are known from offline publishing and everybody takes them for granted when reading a magazine. * Author: Mark Cheret - * Version: 2.5.11d1 + * Package V.: 2.5.11d2 + * Version: 2.5.10 + * CAUTION: THIS V. FIELD IS PARSED FOR UPDATE CONFIGURATION. * Author URI: http://cheret.de/plugins/footnotes-2/ * Text Domain: footnotes * Domain Path: /languages @@ -14,31 +16,102 @@ */ /** - * Version number for stylesheet cache busting. + * Package Version number for stylesheet cache busting. + * + * Please keep this constant in sync with the Package Version in the header above + * and in the header of the readme, but not necessarily with the other Version. * * @since 2.1.4 * @since 2.5.3 (Hungarian) * @var str - * @lastmodified 2021-03-11T1534+0100 + * @lastmodified 2021-03-11T2202+0100 */ -define( 'C_STR_FOOTNOTES_VERSION', '2.5.11d1' ); +define( 'C_STR_PACKAGE_VERSION', '2.5.11d2' ); -/* - LICENSE NOTICE - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License, version 3, as - published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ +/** + * Version numbers in WordPress plugin readme.txt and main PHP headers. + * + * - Adding: Documentation: Readme.txt: informative 'Package Version' field in sync with the package version currently hidden in the main PHP script header. + * - Adding: Documentation: Readme.txt: informative 'Version' field pointing a tag folder in SVN for bugfix versions available ahead of the stable tag. + * - Adding: Documentation: Readme.txt: comment line below the 'Stable Tag' field to warn that this is (unexpectedly) parsed for release configuration. + * + * @since 2.5.11 + * @see readme.txt + * @link https://meta.trac.wordpress.org/ticket/5652 + * + * Package Version Actual version string, informative only. + * May identify a development version. + * A 'd' series is suffixed to incremented bugfix version. + * Used for style sheet cache busting. + * + * Version Parsed in the main PHP file header for update configuration. + * Refers to the latest tag. + * Typically the best available version. + * May not be released, due to release frequency concerns. + * + * Stable Tag Parsed in the readme.txt in trunk/ for release configuration. + * May be smaller than Version, avoiding too frequent releases. + * + * WordPress plugin readmes are usually lacking the version number of the package. + * In Footnotes, this has been included after the stable tag had been mistaken for + * the package version, given that state-of-the-art readmes have that information. + * + * - Bugfix: Codebase: revert to 2.5.8, thanks to @little-shiva @watershare @adjayabdg @staho @frav8 @voregnev @dsl225 @alexclassroom @a223123131 @codldmac bug reports. + * + * @version 2.5.10 (reversion to @version 2.5.8) + * @revision 2483464 + * @timestamp 2021-03-01 11:09:29 +0000 + * @link https://plugins.trac.wordpress.org/changeset/2483464/footnotes/trunk + * + * @reporter @little-shiva + * @link https://wordpress.org/support/topic/footnotes-broke-two-of-my-client-sites/ + * + * @reporter @watershare + * @link https://wordpress.org/support/topic/latest-update-broke-my-site-19/ + * + * @reporter @adjayabdg + * @link https://wordpress.org/support/topic/latest-update-broke-my-site-19/#post-14115531 + * + * @reporter @staho + * @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/ + * + * @reporter @frav8 + * @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115614 + * + * @reporter @voregnev + * @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115632 + * + * @reporter @dsl225 + * @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115820 + * + * @reporter @alexclassroom + * @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115860 + * + * @reporter @a223123131 + * @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115906 + * @link https://wordpress.org/support/topic/update-breaks-layout-3/ + * @link https://wordpress.org/support/topic/bugs-in-every-2nd-update/#post-14116804 + * + * @reporter @codldmac + * @link https://wordpress.org/support/topic/crashed-my-site-104/ + * + * The accidental release of 2.5.9d1 was due to 3 factors: + * + * 1. The codebase got overhauled for the sake of WordPress Coding Standards compliance, + * one requirement of which is that files be named after the name of the class in them; + * 2. The renamed folder was not added to Subversion version control due to an unexpected + * unfamiliarity with the system and its command line interface; + * 3. The Stable Tag field in the Readme header was used for the package version because + * the related field is lacking, and the use of file headers for release configuration + * is uncommon. + * + * @link https://wordpress.org/support/topic/2-5-10-reverts-2-5-9d1-and-apologies/ + * @link https://wordpress.org/support/topic/2-5-10-reverts-2-5-9d1-and-apologies/#post-14119440 + * @link https://github.com/markcheret/footnotes/issues/55 + * @link https://meta.trac.wordpress.org/ticket/5645 + * @link https://wordpress.org/plugins/readme.txt + * @link https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/ + */ /** * Plugin’s main PHP file. diff --git a/readme.txt b/readme.txt index 624aae6..9872614 100755 --- a/readme.txt +++ b/readme.txt @@ -1,632 +1,648 @@ -=== footnotes === -Contributors: mark.cheret, lolzim, rumperuu, aricura, misfist, ericakfranz, dartiss, docteurfitness, felipelavinz, martinneumannat, matkus2, meglio, spaceling, vonpiernik, pewgeuges -Tags: footnote, footnotes, bibliography, formatting, notes, Post, posts, reference, referencing -Requires at least: 3.9 -Tested up to: 5.7 -Requires PHP: 5.6 -Stable Tag: 2.5.10 -License: GPLv3 or later -License URI: http://www.gnu.org/licenses/gpl-3.0.html - -== Description == - -Featured on wpmudev: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/ -Cheers for the review, folks! - -https://www.youtube.com/watch?v=HzHaMAAJwbI - -**footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of defaults while also empowering you to control how your footnotes are being displayed. -**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts — those footnotes we know from offline publishing. - -= Main Features = -- Fully customizable **footnotes** start and end shortcodes; -- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text; -- Responsive *Reference Container* at the end or positioned by shortcode; -- Display the **footnotes** *Reference Container* inside a Widget; -- Wide choice of numbering styles; -- Freely configurable and optional backlink symbol; -- Configure the **footnotes’** appearance by dashboard settings and Custom CSS style rules; -- Button in both the Visual and the Text editor to add shortcodes around selection. - -= Example Usage = -These are a few examples of possible ways to delimit footnotes: - -1. Your awesome text((with an awesome footnote)) -2. Your awesome text[ref]with an awesome footnote[/ref] -3. Your awesome text``with an awesome footnote`` -4. Your awesome text`custom-shortcode`with an awesome footnote`custom-shortcode` - -= Where to get footnotes? = -The current version is available on the [WordPress.org plugins platform, Footnotes](https://wordpress.org/plugins/footnotes/). - -= Support = -Please report feature requests, bugs and other support related questions in the [Footnotes section of WordPress Support Forum](https://wordpress.org/support/plugin/footnotes). - -Speak your mind, unload your burden, bring it up, and feel free to [post your rating and review!](https://wordpress.org/support/plugin/footnotes/reviews/). - -= Development = -Development of the plugin is an open process. Latest code is available in the [plugin part of WordPress SVN repository, footnotes/](https://plugins.svn.wordpress.org/footnotes/). - -== Frequently Asked Questions == - -= Is your Plugin a copy of footnotes x? = - -No, this Plugin has been written from scratch. Of course some inspirations on how to do or how to not do things were taken from other plugins. - -= Your Plugin is awesome! How do I convert my footnotes if I used one of the other footnotes plugins out there? = - -1. For anyone interested in converting from the FD Footnotes plugin: -Visit this swift write-up from a **footnotes** user by the name of **Southwest**: http://wordpress.org/support/topic/how-to-make-this-footnote-style?replies=6#post-5946306 -2. From what we've researched, all other footnotes Plugins use open and close shortcodes, which can be left as is. In the **footnotes** settings menu, you can setup **footnotes** to use the existing (=previously used) shortcodes. Too easy? Yippy Ki-Yey! - -== Installation == -- Visit your WordPress Admin area -- Navigate to `Plugins\Add` -- Search for **footnotes** and find this Plugin among others -- Install the latest version of the **footnotes** Plugin from WordPress.org -- Activate the Plugin - -== Screenshots == -1. Find the footnotes plugin settings in the newly added "ManFisher" Menu -2. Settings for the *References Container* -3. Settings for **footnotes** styling -4. Settings for **footnotes** love -5. Other Settings -6. The HowTo section in the **footnotes** settings -7. Here you can see the **footnotes** Plugin at work. Isn't that plain beautiful? - -== Changelog == - -= 2.5.10 = -- Bugfix: Revert to 2.5.8. OUR APOLOGIES, PLEASE, FOR THE 2.5.9d1 PLUGIN 'Stable Tag' MISHAP. - -= 2.5.8 = -- Bugfix: Layout: support right-to-left writing direction by replacing remaining CSS values 'left' with 'start', thanks to @arahmanshaalan bug report. -- Bugfix: Layout: support right-to-left writing direction by enabling mirrored paddings on HTML dir="rtl" pages, thanks to @arahmanshaalan bug report. - -= 2.5.7 = -- Bugfix: Process: fix footnote duplication by emptying the footnotes list every time the search algorithm is run on the content, thanks to @inoruhana bug report. - -= 2.5.6 = -- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports. -- Bugfix: Alternative tooltips: shrink width to short content. -- Update: Documentation: slightly revise or update the plugin’s welcome page on WordPress.org. - -= 2.5.5 = -- Update: Stylesheets: increase speed and energy efficiency by tailoring stylesheets to the needs of the instance, thanks to @docteurfitness design contribution. -- Bugfix: Stylesheets: minify to shrink the carbon footprint, increase speed and implement best practice, thanks to @docteurfitness issue report. -- Bugfix: Libraries: optimize processes by loading external and internal scripts only if needed, thanks to @docteurfitness issue report. -- Bugfix: Process: fix numbering bug impacting footnote #2 with footnote #1 close to start, thanks to @rumperuu bug report, thanks to @lolzim code contribution. -- Update: Dashboard: add or edit descriptions to the tooltips and tooltip text delimiter settings and the backlink symbol configuration setting. -- Update: Dashboard: decrease font size and padding of the descriptions. - -= 2.5.4 = -- Bugfix: Referrers: optional fixes to vertical alignment, font size and position (static) for in-theme consistency and cross-theme stability, thanks to @tomturowski bug report. -- Bugfix: Tooltips: fix jQuery positioning bug moving tooltips out of view and affecting (TablePress tables in) some themes, thanks to @wisenilesh bug report. -- Bugfix: Reference container, tooltips: URL wrap: enable the 'word-wrap: anywhere' rule, thanks to @rebelc0de bug report. -- Bugfix: Reference container, tooltips: URL wrap: account for leading space in value, thanks to @karolszakiel example provision. -- Bugfix: Dashboard: Tooltip dimensions: move from 'Tooltip position' to a dedicated metabox, thanks to @codldmac issue report. -- Update: Libraries: jQuery Tools: replace deprecated function jQuery.isFunction(), thanks to @a223123131 bug report. -- Bugfix: Editor button: Classic Editor text mode: try to fix uncaught reference error of “QTags is not defined”, thanks to @dpartridge bug report. -- Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report. -- Update: Tooltips: Excerpt delimiter: add configuration settings in the dashboard. -- Bugfix: Tooltips: fix display in Popup Maker popups by correcting a coding error. -- Bugfix: Editor button: Classic Editor text mode: correct label to singular. -- Bugfix: Libraries: jQuery Tools: replace double equals sign discouraged in JavaScript with recommended triple equals sign. - -= 2.5.3 = -- Bugfix: Reference container, tooltips: URL wrap: exclude URL pattern as folder name in Wayback Machine URL, thanks to @rumperuu bug report. - -= 2.5.2 = -- Update: Tooltips: Excerpt delimiter: ability to display dedicated content before `[[/tooltip]]`, thanks to @jbj2199 issue report. -- Bugfix: Localization: plugin language file name changes effective in version control system. - -= 2.5.1 = -- Bugfix: Hooks: support footnotes in Popup Maker popups, thanks to @squatcher bug report. -- Bugfix: Reference container: click on label expands but also collapses, thanks to @ahmadword bug report. -- Bugfix: Reference container: Label: cursor takes pointer shape, thanks to @ahmadword bug report. -- Bugfix: Dashboard: Custom CSS: mention validity of legacy while visible, thanks to @rkupadhya bug report. -- Bugfix: Dashboard: Custom CSS: make class list column formatting effective again. -- Update: Readme/documentation: add new contributors in the file header’s Contributors field. -- Update: Readme/documentation: update or fix URLs in Download, Support and Development sections. - -= 2.5.0 = -- Adding: Templates: Enable template location stack, thanks to @misfist code contribution. -- Bugfix: Hooks: support footnotes on category pages, thanks to @vitaefit bug report, thanks to @misfist code contribution. -- Bugfix: Footnote delimiters: Syntax validation: exclude certain cases involving scripts, thanks to @andreasra bug report. -- Bugfix: Footnote delimiters: Syntax validation: complete message with hint about setting, thanks to @andreasra bug report. -- Bugfix: Footnote delimiters: Syntax validation: limit length of quoted string to 300 characters, thanks to @andreasra bug report. -- Update: Dashboard: Footnote delimiters: Syntax validation: add more information around the setting. -- Bugfix: Dashboard: Footnote delimiters: warning about '>' escapement disruption in WordPress Block Editor. - -= 2.4.0 = -- Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes. -- Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution. -- Bugfix: Process: initialize hard link address variables to empty string to fix 'undefined variable' bug, thanks to @a223123131 bug report. -- Bugfix: Reference container: Label: set empty label to U+202F NNBSP for more robustness, thanks to @lukashuggenberg feedback. -- Bugfix: Scroll offset: initialize to safer one third window height for more robustness, thanks to @lukashuggenberg bug report. -- Bugfix: Footnote delimiters: Dashboard: remove new option involving HTML comment tags only usable in source mode. -- Bugfix: Reference container: Row borders: adapt left padding to the presence of an optional left border. -- Bugfix: Reference container: add class 'footnote_plugin_symbol' to disambiguate repurposed class 'footnote_plugin_link'. - -= 2.3.0 = -- Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution. -- Bugfix: Reference container: convert top padding to margin and make it a setting, thanks to @hamshe bug report. -- Bugfix: Referrers and backlinks: more effectively remove unwanted underline by disabling box shadow used instead of bottom border, thanks to @klusik feedback. -- Bugfix: Dashboard: Custom CSS: swap migration Boolean, meaning 'show legacy' instead of 'migration complete', due to storage data structure constraints. -- Update: Dashboard: Priority level: rename tab as 'Scope and priority', to account for the new alternative depending on widget_text hook activation. -- Bugfix: Referrers and tooltips: correct scope of the line height fix to only affect the referrers, not the tooltip content. -- Bugfix: Referrers: extend clickable area to the full line height in sync with current pointer shape. -- Bugfix: Referrers: extend scope of the underline inhibition to be more comprehensive and consistent. -- Bugfix: Reference container: Basic responsive page layout: edits to one of the optional stylesheets. - -= 2.2.10 = -- Bugfix: Reference container: add option for table borders to restore pre-2.0.0 design, thanks to @noobishh issue report. -- Bugfix: Reference container: add missing container ID in function name in default table row template for uncombined footnotes. -- Bugfix: Reference container, tooltips: URL wrap: support also file transfer protocol URLs. - -= 2.2.9 = -- Bugfix: Reference container, widget_text hook: support for multiple containers in a page, thanks to @justbecuz bug report. -- Update: Priority levels: set widget_text default to 98 and update its description in the dashboard Priority level tab. -- Bugfix: Reference container, tooltips: URL wrap: account for RFC 2396 allowed characters in parameter names. -- Bugfix: Reference container, tooltips: URL wrap: exclude URLs also where the equals sign is preceded by an entity or character reference. - -= 2.2.8 = -- Bugfix: Reference container, tooltips: URL wrap: correctly make the quotation mark optional wrt query parameters, thanks to @spiralofhope2 bug report. - -= 2.2.7 = -- Bugfix: Reference container, tooltips: URL wrap: remove a bug introduced in the regex, thanks to @rjl20 @spaceling @lukashuggenberg @klusik @friedrichnorth @bernardzit bug reports. - -= 2.2.6 = -- Bugfix: Reference container, tooltips: URL wrap: make the quotation mark optional wrt query parameters, thanks to @spiralofhope2 bug report. -- Adding: Templates: support for custom templates in sibling folder, thanks to @misfist issue report. - -= 2.2.5 = -- Bugfix: Dashboard: Footnotes numbering: add missing support for Ibid. notation to suggestions, thanks to @meglio design contribution. -- Bugfix: Reference container: Label: make bottom border an option, thanks to @markhillyer issue report. -- Bugfix: Reference container: Label: option to select paragraph or heading element, thanks to @markhillyer issue report. -- Bugfix: Reference container: delete position shortcode if unused because position may be widget or footer, thanks to @hamshe bug report. -- Update: Tooltips: Alternative tooltips: connect to position/timing settings (for themes not supporting jQuery tooltips). -- Update: Dashboard: Tooltip position/timing settings: include alternative tooltips (for themes not supporting jQuery tooltips). -- Bugfix: Dashboard: Tooltip position/timing settings: raise above tooltip truncation settings for better consistency. - -= 2.2.4 = -- Bugfix: Reference container: Backlink symbol selection: move back to previous tab “Referrers and tooltips”. -- Bugfix: Custom CSS: make inserting existing in header depend on migration complete checkbox status. - -= 2.2.3 = -- Bugfix: Custom CSS: insert new CSS in the public page header element after existing CSS. - -= 2.2.2 = -- Bugfix: Dashboard: Link element setting only under General settings > Reference container. -- Bugfix: Dashboard: Custom CSS: unearth text area and migrate to dedicated tab as designed. -- Bugfix: Reference container: edits to optional basic responsive page layout stylesheets. - -= 2.2.1 = -- Bugfix: Dashboard: duplicate moved settings under their legacy tab to account for data structure. - -= 2.2.0 = -- Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report. -- Adding: Start/end short codes: more predefined options. -- Adding: Numbering styles: lowercase Roman numerals support. -- Update: Priority levels: update the notice in the dashboard Priority tab. -- Update: Dashboard: Tooltip settings: group into 3 thematic containers. -- Update: Dashboard: Main settings: group into 3 specific containers. -- Update: Dashboard: move link element option to the Referrers options. -- Update: Dashboard: move URL wrap option to the Reference container options. -- Update: Dashboard: group both Custom CSS and priority level settings under the same tab. -- Update: Dashboard: rename tab labels 'Referrers and tooltips', 'Priority and CSS'. -- Bugfix: Tooltips: add 'important' property to z-index to fix display overlay issue. -- Bugfix: Localization: correct arguments for plugin textdomain load function. -- Bugfix: Reference container, tooltips: URL wrap: specifically catch the quotation mark. -- Adding: Footnotes mention in the footer: more options. - -= 2.1.6 = -- Bugfix: Priority levels: set the_content priority level to 98 to prevent plugin conflict, thanks to @marthalindeman bug report. -- Bugfix: Tooltips: set z-index to maximum 2147483647 to address display issues with overlay content, thanks to @russianicons bug report. -- Bugfix: Reference container, tooltips: URL wrap: fix regex, thanks to @a223123131 bug report. -- Bugfix: Dashboard: URL wrap: add option to properly enable/disable URL wrap. -- Update: Dashboard: reorder tabs and update tab labels. -- Bugfix: Dashboard: remove Expert mode enable setting since permanently enabled as 'Priority'. -- Bugfix: Dashboard: fix punctuation-related localization issue by including colon in labels. -- Bugfix: Localization: conform to WordPress plugin language file name scheme, thanks to @nikelaos bug report. - -= 2.1.5 = -- Bugfix: Reference container, tooltips: URL wrap: exclude image source too, thanks to @bjrnet21 bug report. - -= 2.1.4 = -- Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers. -- Bugfix: Scroll duration: make configurable to conform to website content and style requirements. -- Bugfix: Tooltips: make display delays and fade durations configurable to conform to website style. -- Bugfix: Tooltips: Styling: fix font size issue by adding font size to settings with legacy as default. -- Bugfix: Reference container: fix layout by optionally enqueuing additional stylesheet (depends on theme). -- Bugfix: Reference container: fix layout issues by moving backlink column width to settings. -- Bugfix: Reference container: make separating and terminating punctuation optional and configurable, thanks to @docteurfitness issue report and code contribution. -- Bugfix: Reference container: Backlinks: fix stacked enumerations by adding optional line breaks. -- Bugfix: Tooltips: Read-on button: Label: prevent line breaks. -- Bugfix: Referrers and backlinks: Styling: make link elements optional to fix issues, thanks to @docteurfitness issue report and code contribution. -- Bugfix: Referrers: Styling: disable hover underline. -- Bugfix: Reference container, tooltips: fix line wrapping of URLs (hyperlinked or not) based on pattern, not link element. -- Bugfix: Reference container: Backlink symbol: support for appending when combining identicals is on. -- Bugfix: Reference container: Backlinks: deprioritize hover underline to ease customization. -- Bugfix: Reference container: Backlinks: fix line breaking with respect to separators and terminators. -- Bugfix: Reference container: Label: delete overflow hidden rule. -- Bugfix: Reference container: Expand/collapse button: same padding to the right for right-to-left. -- Bugfix: Reference container: Styles: re-add the class dedicated to combined footnotes indices. -- Bugfix: Dashboard: move arrow settings from Customize to Settings > Reference container to reunite and fix issue with new heading wording. -- Bugfix: Dashboard: Main settings: fix layout, raise shortcodes to top. -- Bugfix: Dashboard: Tooltip settings: Truncation length: change input box type from text to numeric. -- Update: Dashboard: Notices: use explicit italic style. -- Bugfix: Dashboard: Other settings: Excerpt: display guidance next to select box, thanks to @nikelaos bug report. -- Bugfix: WordPress hooks: the_content: set priority to 1000 as a safeguard. -- Update: Dashboard: Expert mode: streamline and update description for hooks and priority levels. - -= 2.1.3 = -- Bugfix: Hooks: disable widget_text hook by default to fix accordions declaring headings as widgets. -- Bugfix: Hooks: disable the_excerpt hook by default to fix issues, thanks to @nikelaos bug report. -- Bugfix: Reference container: fix column width when combining turned on by reverting new CSS class to legacy. -- Bugfix: Reference container: fix width in mobile view by URL wrapping for Unicode-non-conformant browsers, thanks to @karolszakiel bug report. -- Bugfix: Reference container: table cell backlinking if index is single and combining identicals turned on. -- Bugfix: Styling: raise Custom CSS priority to override settings. -- Bugfix: Styling: Tooltips: raise settings priority to override theme stylesheets. - -= 2.1.2 = -- Bugfix: Reference container: Backlinks: no underline on hover cell when combining identicals is on. -- Bugfix: Dashboard: priority level settings for all other hooks, thanks to @nikelaos bug report. -- Update: Dashboard: WordPress documentation URLs of the hooks. -- Update: Dashboard: feature description for the hooks priority level settings, thanks to @nikelaos bug report. - -= 2.1.1 = -- Bugfix: Referrers, reference container: Combining identical footnotes: fix dead links and ensure referrer-backlink bijectivity, thanks to @happyches bug report. -- Bugfix: Dashboard: priority level setting for the_content hook, thanks to @imeson bug report. -- Update: Libraries: jQuery Tools: redact (comment out) all 6 instances of deprecated function jQuery.browser(), thanks to @bjrnet21 @cconser @vyassuresh @spaceling @widecast @olivlyon @maxident bug reports. -- Bugfix: Libraries: jQuery Tools: complete minification. -- Bugfix: Libraries: make script loads depend on tooltip implementation option. -- Bugfix: Libraries: jQuery UI: properly pick the libraries registered by WordPress needed for tooltips. -- Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report. -- Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback. -- Bugfix: Reference container: Footnote number links: disable bottom border for theme compatibility. -- Bugfix: Reference container: option to restore pre-2.0.0 layout with the backlink symbol in an extra column. -- Bugfix: Reference container: option to append symbol (prepended by default), thanks to @spaceling code contribution. -- Bugfix: Reference container: Table rows: fix top and bottom padding. -- Bugfix: Referrers: new setting for vertical align: superscript (default) or baseline (optional), thanks to @cwbayer bug report. -- Bugfix: Referrers: line height 0 to fix superscript, thanks to @cwbayer bug report. -- Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback. -- Bugfix: Tooltips: add delay (400ms) before fade-out to fix UX wrt links and Read-on button. -- Bugfix: Tooltips: fix line breaking for hyperlinked URLs in Unicode-non-compliant user agents, thanks to @andreasra bug report. -- Bugfix: Formatting: disable overline showing in some themes on hovered backlinks. - -= 2.1.0 = -- Adding: Tooltips: Read-on button: Label: configurable instead of localizable, thanks to @rovanov example provision. -- Bugfix: Referrers: disable bottom border for theme compatibility. -- Update: Accessibility: add 'speaker-mute' class to reference container. -- Bugfix: Dashboard: Layout: add named selectors to limit applicability of styles. -- UPDATE: Hooks: remove 'the_post', the plugin stops supporting this hook. - -= 2.0.8 = -- BUGFIX: Priority level back to PHP_INT_MAX (need to get in touch with other plugins). - -= 2.0.7 = -- BUGFIX: Hooks: Default-disable 'the_post', thanks to @spaceling @markcheret @nyamachi @whichgodsaves @spiralofhope2 @mmallett @andreasra @widecast @ymorin007 @tashi1es bug reports. -- Update: Set priority level back to 10 assuming it is unproblematic. -- Update: Added backwards compatible support for legacy arrow and index placeholders in template. -- Update: Settings defaults adjusted for better and more up-to-date tooltip layout. - -= 2.0.6 = -- Bugfix: Infinite scroll: debug autoload by adding post ID, thanks to @docteurfitness code contribution. -- Bugfix: Referrers: delete vertical align tweaks, for cross-theme and user agent compatibility. -- Bugfix: Reference container: fix line breaking behavior in footnote number clusters. -- Bugfix: Reference container: auto-extending column to fit widest, to fix display with short note texts. -- Bugfix: Reference container: IDs: slightly increased left padding. -- Bugfix: Translations: fix spelling error and erroneously changed word in en_GB and en_US. -- Bugfix: Typesetting: discard the dot after footnote numbers as not localizable (should be optional). -- Bugfix: Reference container: Collapse button fully clickable, not sign only. -- Bugfix: Reference container: Collapse button 'collapse' with minus sign not hyphen-minus. -- Update: Tooltips: set display predelay to 0 for responsiveness (was 800 since 2.0.0, 400 before). -- Update: Tooltips: set fade duration to 200ms both ways (was 200 in and 2000 out since 2.0.0, 0 in and 100 out before). -- BUGFIX: Priority level back to PHP_INT_MAX (ref container positioning not this plugin’s responsibility). -- Update: Scroll offset: raise percentage from 12% to a safer 20% inner window height, by lack of configurability. - -= 2.0.5 = -- Bugfix: Reference container: fix relative position through priority level, thanks to @june01 @imeson @spaceling bug reports, thanks to @spaceling code contribution. -- Bugfix: Reference container: unset width of text column to fix site issues. -- Update: Hooks: Default-enable all hooks to prevent footnotes from seeming broken in some parts. -- Bugfix: Tooltips: Restore cursor shape 'pointer' over Read-on button after hard link removal. -- Bugfix: Settings stylesheet: unenqueue to fix input boxes on public pages (enqueued for 2.0.4). - -= 2.0.4 = -- Update: Restore arrow settings to customize or disable the now prepended arrow symbol. -- Update: Libraries: Load jQuery UI from WordPress, thanks to @check2020de issue report. -- Bugfix: Referrers and backlinks: remove hard links to streamline browsing history, thanks to @theroninjedi47 bug report. -- Bugfix: Reference container: remove inconvenient left/right cellpadding. -- Bugfix: Tooltips: improve layout with inherited font size by lower line height. -- Bugfix: Tooltips: 'Continue reading' button: disable default underline. -- Bugfix: Translations: review all locales (en, de, es, fr), synced ref line # with edited code. -- Bugfix: Dashboard: fix display of two headings containing the logo. - -= 2.0.3 = -- Bugfix: Reference container: Self-adjusting width of ID column but hidden overflow. -- Update: Reference container: clarify backlink semantics by prepended transitional up arrow, thanks to bug report. -- Bugfix: Fragment IDs: Prepended post ID to footnote number. -- Bugfix: External stylesheets cache busting: add plugin version number argument in enqueuing function call. -- Bugfix: Print style: prevent a page break just after the reference container label. -- Bugfix: Print style: Hide reference collapse button. -- Update: Reference container: Headline: remove padding before reference container label. -- Update: Scroll offset: raise percentage from 5% to a safer 12% inner window height, by lack of setting. - -= 2.0.2 = -- Bugfix: Reference container: restore expand/collapse button in the template, thanks to @ragonesi bug report. -- Bugfix: Dashboard: Custom CSS: Available selectors: fix display of the last item. -- Bugfix: Referrers and backlinks: restore default link color on screen, set color to inherit in print. -- Bugfix: Referrers: disable text decoration underline by default, enable underline on hover. - -= 2.0.1 = -- Bugfix: Reference container: enforce borderless table cells, thanks to @ragonesi bug report. -- Update: Translations: revised fr_FR. - -= 2.0.0 = -- Major contributions taken from WordPress user pewgeuges, all details here https://github.com/media-competence-institute/footnotes/blob/master/README.md: -- Update: **symbol for backlinks** removed -- Update: hyperlink moved to the reference number -- Update: Tooltips: fix disabling bug by loading jQuery UI library, thanks to @rajinderverma @ericcorbett2 @honlapdavid @mmallett @twellve_million bug reports, thanks to @vonpiernik code contribution. -- Update: Libraries: jQuery Tools: add condition whether deprecated function jQuery.browser() exists, thanks to @vonpiernik code contribution. -- Bugfix: Localization: correct function call apply_filters() with all required arguments after PHP 7.1 promoted warning to error, thanks to @matkus2 bug report and code contribution. -- Bugfix: footnote links script independent -- Bugfix: Get the “Continue reading” link to work in the mouse-over box -- Bugfix: Debug printed posts and pages -- Bugfix: Display of combined identical notes -- Update: Adjusted scrolling time and offset -- Bugfix: Reference container: no borders around footnotes, thanks to @ragonesi bug report. -- Bugfix: Mouse-over box display timing -- Update: Translations: revised de_AT, de_DE, en_GB, en_US, es_ES - -= 1.6.6 = -- Beginning of translation to French - -= 1.6.5 = -- Bugfix: Improve widgets registration, thanks to @felipelavinz code contribution. -- Update: Fix for deprecated PHP function create_function(), thanks to @psykonevro @daliasued bug reports, thanks to @felipelavinz code contribution. -- Update: The CSS has been modified in order to show the tooltip numbers a little less higher than text -- Bugfix: Dashboard: fix error on demo under the Preview tab. - -= 1.6.4 = -- Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution. -- Bugfix: Fixed occasional bug where footnote ordering could be out of sequence - -= 1.6.3 = -- Bugfix: We were provided a fix by a user named toma. footnotes now works in sub-folder installations of WordPress - -= 1.6.2 = -- Update: Changed the Preview tab -- Bugfix: Html tags has been removed in the Reference container when the excerpt mode is enabled - -= 1.6.1 = -- Update: Translations -- Bugfix: Move to anchor - -= 1.6.0 = -- **IMPORTANT**: Improved performance. You need to Activate the Plugin again. (Settings won't change!) -- Adding: Setting to customize the mouse-over box shadow -- Adding: Translation: United States -- Adding: Translation: Austria -- Adding: Translation: Spanish (many thanks to Pablo L.) -- Update: Translations (de_DE and en_GB) -- Update: Changed Plugins init file name to improve performance (Re-activation of the Plugin is required) -- Update: ManFisher note styling -- Update: Tested with latest nightly build of WordPress 4.1 -- Bugfix: Avoid multiple IDs for footnotes when multiple reference containers are displayed - -= 1.5.7 = -- Adding: Setting to define the positioning of the mouse-over box -- Adding: Setting to define an offset for the mouse-over box (precise positioning) -- Bugfix: Target element to move down to the reference container is the footnote index instead of the arrow (possibility to hide the arrow) -- Bugfix: Rating calculation for the 'other plugins' list - -= 1.5.6 = -- **IMPORTANT**: We have changed the html tag for the superscript. Please check and update your custom CSS. -- Adding: .pot file to enable Translations for everybody -- Adding: Settings to customize the mouse-over box (color, background color, border, max. width) -- Update: Translation file names -- Update: Translation EN and DE -- Update: Styling of the superscript (need to check custom CSS code for the superscript) -- Update: Description of CSS classes for the 'customize CSS' text area -- Bugfix: Removed 'a' tag around the superscript for Footnotes inside the content to avoid page reloads (empty href attribute) -- Bugfix: Avoid Settings fallback to its default value after submit an empty value for a setting -- Bugfix: Enable multiple WP_Post objects for the_post hook - -= 1.5.5 = -- Adding: Expert mode setting -- Adding: Activation and Deactivation of WordPress hooks to look for Footnotes (expert mode) -- Adding: WordPress hooks: 'the_title' and 'widget_title' (default: disabled) to search for Footnote short codes -- Bugfix: Default value for the WordPress hook the_post to be disabled (adds Footnotes twice to the Reference container) -- Bugfix: Activation, Deactivation and Uninstall hook class name -- Bugfix: Add submenu pages only once for each ManFisher WordPress Plugin -- Bugfix: Display the Reference container in the Footer correctly - -= 1.5.4 = -- Adding: Setting to enable an excerpt of the Footnotes mouse-over box text (default: disabled) -- Adding: Setting to define the maximum length of the excerpt displayed in the mouse-over box (default: 150 characters) -- Update: Detail information about other Plugins from ManFisher (rating, downloads, last updated, Author name/url) -- Update: Receiving list of other Plugins from the Developer Team from an external server -- Update: Translations (EN and DE) -- Bugfix: Removed hard coded position of the 'ManFisher' main menu page (avoid errors with other Plugins) -- Bugfix: Changed function name (includes.php) to be unique (avoid errors with other Plugins) -- Bugfix: Try to replace each appearance of Footnotes in the current Post object loaded from the WordPress database - -= 1.5.3 = -- Adding: Developer's homepage to the 'other Plugins' list -- Update: Smoothy scroll to an anchor using Javascript -- Bugfix: Set the vertical align for each cell in the Reference container to TOP - -= 1.5.2 = -- Adding: Setting to enable/disable the mouse-over box -- Adding: Current WordPress Theme to the Diagnostics sub page -- Adding: ManFisher note in the "other Plugins" sub page -- Update: Removed unnecessary hidden inputs from the Settings page -- Update: Merged public CSS files to reduce the output and improve the performance -- Update: Translations (EN and DE) -- Bugfix: Removed the 'trim' function to allow whitespaces at the beginning and end of each setting -- Bugfix: Convert the footnotes short code to HTML special chars when adding them into the page/post editor (visual and text) -- Bugfix: Detailed error messages if other Plugins can't be loaded. Also added empty strings as default values to avoid 'undefined' - -= 1.5.1 = -- Bugfix: Broken Settings link in the Plugin listing -- Bugfix: Translation overhaul for German - -= 1.5.0 = -- Adding: Grouped the Plugin Settings into a new Menu Page called "ManFisher Plugins" -- Adding: Sub Page to list all other Plugins of the Contributors -- Adding: Hyperlink to manfisher.eu in the "other plugins" page -- Update: Refactored the whole source code -- Update: Moved the Diagnostics Sections to into a new Sub Page called "Diagnostics" -- Bugfix: Line up Footnotes with multiple lines in the Reference container -- Bugfix: Load text domain -- Bugfix: Display the Footnotes button in the plain text editor of posts/pages - -= 1.4.0 = -- Feature: WPML Config XML file for easy multi language string translation (WPML String Translation Support File) -- Update: Changed e-Mail support address to the WordPress support forum -- Update: Language EN and DE -- Adding: Tab for Plugin Diagnostics -- Adding: Donate link to the installed Plugin overview page -- Adding: Donate button to the "HowTo" tab - -= 1.3.4 = -- Bugfix: Settings access permission vor sub-sites -- Bugfix: Setting 'combine identical footnotes' working as it should - -= 1.3.3 = -- Update: Changed the Author name from a fictitious entity towards a real registered company -- Update: Changed the Author URI - -= 1.3.2 = -- Bugfix: More security recognizing Footnotes on public pages (e.g. ignoring empty Footnote short codes) -- Bugfix: Clear old Footnotes before lookup new public page (only if no reference container displayed before) -- Update: language EN and DE -- Adding: Setting to customize the hyperlink symbol in der reference container for each footnote reference -- Adding: Setting to enter a user defined hyperlink symbol -- - -= 1.3.1 = -- Bugfix: Allow settings to be empty -- Bugfix: Removed space between the hyperlink and superscript in the footnotes index -- Adding: Setting to customize the text before and after the footnotes index in superscript - -= 1.3.0 = -- Bugfix: Changed tooltip class to be unique -- Bugfix: Changed superscript styling to not manipulate the line height -- Bugfix: Changed styling of the footnotes text in the reference container to avoid line breaks -- Update: Reformatted code -- Adding: new settings tab for custom CSS settings - -= 1.2.5 = -- Bugfix: New styling of the mouse-over box to stay in screen (thanks to Jori, France and Manuel345, undisclosed location) - -= 1.2.4 = -- Bugfix: CSS stylesheets will only be added in FootNotes settings page, nowhere else (thanks to Piet Bos, China) -- Bugfix: Styling of the reference container when the footnote text was too long (thanks to Willem Braak, undisclosed location) -- Bugfix: Added a Link to the footnote text in the reference container back to the footnote index in the page content (thanks to Willem Braak, undisclosed location) - -= 1.2.3 = -- Bugfix: Removed 'Warning output' of Plugins activation and deactivation function (thanks to Piet Bos, China) -- Bugfix: Added missing meta boxes parameter on Settings page (thanks to Piet Bos, China) -- Bugfix: Removed Widget text formatting -- Bugfix: Load default settings value of setting doesn't exist yet (first usage) -- Bugfix: Replacement of footnotes tag on public pages with html special characters in the content -- Feature: Footnotes tag color is set to the default link color depending on the current Theme (thanks to Daniel Formo, Norway) - -= 1.2.2 = -- Bugfix: WYSIWYG editor and plain text editor buttons insert footnote short code correctly (also if defined like html tag) -- Update: The admin can decide which "I love footnotes" text (or not text) will be displayed in the footer -- Adding: Buttons next to the reference label to expand/collapse the reference container if set to "collapse by default" -- Bugfix: Replace footnote short code -- Update: Combined buttons for the "collapse/expand" reference container - -= 1.2.1 = -- Bugfix: HowTo example will be displayed correctly if a user defined short code is set - -= 1.2.0 = -- Feature: New button in the WYSIWYG editor and in the plain text editor to easily implement the footnotes tag -- Feature: Icon for the WYSIWYG-editor button -- Feature: Pre defined footnote short codes -- Experimental: User defined short code for defining footnotes -- Experimental: Plugin Widget to define where the reference container should appear when set to "widget area" -- Update: Moved footnotes 'love' settings to a separate container -- Update: Translation for new settings and for the Widget description -- Bugfix: Setting for the position of the "reference container" works for the options "footer", "end of post" and "widget area" - -= 1.1.1 = -- Feature: Short code to not display the 'love me' slug on specific pages ( short code = [[no footnotes: love]] ) -- Update: Setting where the reference container appears on public pages can also be set to the widget area -- Adding: Link to the wordpress.org support page in the plugin main page -- Update: Changed plugin URL from GitHub to WordPress -- Bugfix: Uninstall function to really remove all settings done in the settings page -- Bugfix: Load default settings after plugin is installed -- Update: Translation for support link and new setting option -- Adding: Label to display the user the short code to not display the 'love me' slug - -= 1.1.0 = -- Update: Global styling for the public plugin name -- Update: Easier usage of the public plugin name in translations -- Update: New Layout for the settings page to group similar settings to get a better overview -- Update: Display settings submit button only if there is at least 1 editable setting in the current tab -- Adding: Setting where the reference container appears on public pages (needs some corrections!) -- Bugfix: Displays only one reference container in front of the footer on category pages - -= 1.0.6 = -- Bugfix: Uninstall function to delete all plugin settings -- Bugfix: Counter style internal name in the reference container to correctly link to the right footnote on the page above -- Bugfix: Footnote hover box styling to not wrap the footnote text on mouse over -- Update: 'footnotes love' text in the page footer if the admin accepts it and set its default value to 'no' - -= 1.0.5 = -- The Plugin has been submitted to wordpress.org for review and (hopefully) publication. -- Update: Plugin description for public directories (WordPress.org and GitHub) -- Feature: the footnotes WordPress Plugin now has its very own CI - - Update: Styling - - Update: Settings to support the styling -- Adding: Inspirational Screenshots for further development -- Adding: Settings screenshot -- Update: i18n fine-tuning - -= 1.0.4 = -- Update: replacing function when footnote is a link (bugfix) -- Footnote hover box remains until cursor leaves footnote or hover box -- Links in the footnote hover box are click able -- Adding: setting to allow footnotes on Summarized Posts -- Adding: setting to tell the world you're using footnotes plugin -- Adding: setting for the counter style of the footnote index - - Arabic Numbers (1, 2, 3, 4, 5, ...) - - Arabic Numbers leading 0 (01, 02, 03, 04, 05, ...) - - Latin Characters lower-case (a, b, c, d, e, ...) - - Latin Characters upper-case (A, B, C, D, E, ...) - - Roman Numerals (I, II, III, IV, V, ...) -- Adding: a link to the WordPress plugin in the footer if the WP-admin accepts it -- Update: translations for the new settings -- Switch back the version numbering scheme to have 3 digits - -= 1.0.3 = -- Adding: setting to use personal starting and ending tag for the footnotes -- Update: translations for the new setting -- Update: reading settings and fallback to default values (bugfix) - -= 1.0.2 = -- Adding: setting to collapse the reference container by default -- Adding: link behind the footnotes to automatically jump to the reference container -- Adding: function to easy output input fields for the settings page -- Update: translation for the new setting - -= 1.0.1 = -- Separated functions in different files for a better overview -- Adding: a version control to each file / class / function / variable -- Adding: layout for the settings menu, settings split in tabs and not a list-view -- Update: Replacing footnotes in widget texts will show the reference container at the end of the page (bugfix) -- Update: translations for EN and DE -- Changed version number from 3 digits to 2 digits - -= 1.0.0 = -- First development Version of the Plugin - -== Upgrade Notice == -to upgrade our plugin is simple. Just update the plugin within your WordPress installation. -To cross-upgrade from other footnotes plugins, there will be a migration assistant in the future +=== footnotes === +Contributors: mark.cheret, lolzim, rumperuu, aricura, misfist, ericakfranz, dartiss, docteurfitness, felipelavinz, martinneumannat, matkus2, meglio, spaceling, vonpiernik, pewgeuges +Tags: footnote, footnotes, bibliography, formatting, notes, Post, posts, reference, referencing +Requires at least: 3.9 +Tested up to: 5.7 +Requires PHP: 5.6 +Package Version: 2.5.11d2 +Version: 2.5.10 +Stable Tag: 2.5.10 +CAUTION: THE S. T. FIELD IS PARSED FOR RELEASE CONFIGURATION. +License: GPLv3 or later +License URI: https://www.gnu.org/licenses/gpl-3.0.html + +== Description == + +Featured on wpmudev: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/ +Cheers for the review, folks! + +https://www.youtube.com/watch?v=HzHaMAAJwbI + +**footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of defaults while also empowering you to control how your footnotes are being displayed. +**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts — those footnotes we know from offline publishing. + += Main Features = +- Fully customizable **footnote** start and end shortcodes; +- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text; +- Responsive *Reference Container* at the end or positioned by shortcode; +- Display the **footnotes** *Reference Container* inside a Widget; +- Wide choice of numbering styles; +- Freely configurable and optional backlink symbol; +- Configure the **footnotes’** appearance by dashboard settings and Custom CSS style rules; +- Button in both the Visual and the Text editor to add shortcodes around selection. + += Example Usage = +These are a few examples of possible ways to delimit footnotes: + +1. Your awesome text((with an awesome footnote)) +2. Your awesome text[ref]with an awesome footnote[/ref] +3. Your awesome text``with an awesome footnote`` +4. Your awesome text`custom-shortcode`with an awesome footnote`custom-shortcode` + += Where to get footnotes? = +The current version is available on the [WordPress.org plugins platform, Footnotes](https://wordpress.org/plugins/footnotes/). + += Support = +Please report feature requests, bugs and other support related questions in the [Footnotes section of WordPress Support Forum](https://wordpress.org/support/plugin/footnotes). + +Speak your mind, unload your burden, bring it up, and feel free to [post your rating and review!](https://wordpress.org/support/plugin/footnotes/reviews/). + += Development = +Development of the plugin is an open process. Latest code is available in the [plugin part of WordPress SVN repository, footnotes/](https://plugins.svn.wordpress.org/footnotes/). + +== Frequently Asked Questions == + += Is your Plugin a copy of footnotes x? = + +No, this Plugin has been written from scratch. Of course some inspirations on how to do or how to not do things were taken from other plugins. + += Your Plugin is awesome! How do I convert my footnotes if I used one of the other footnotes plugins out there? = + +1. For anyone interested in converting from the FD Footnotes plugin: +Visit this swift write-up from a **footnotes** user by the name of **Southwest**: http://wordpress.org/support/topic/how-to-make-this-footnote-style?replies=6#post-5946306 +2. From what we've researched, all other footnotes Plugins use open and close shortcodes, which can be left as is. In the **footnotes** settings menu, you can setup **footnotes** to use the existing (=previously used) shortcodes. Too easy? Yippy Ki-Yey! + +== Installation == +- Visit your WordPress Admin area +- Navigate to `Plugins\Add` +- Search for **footnotes** and find this Plugin among others +- Install the latest version of the **footnotes** Plugin from WordPress.org +- Activate the Plugin + +== Screenshots == +1. Find the footnotes plugin settings in the newly added "ManFisher" Menu +2. Settings for the *References Container* +3. Settings for **footnotes** styling +4. Settings for **footnotes** love +5. Other Settings +6. The HowTo section in the **footnotes** settings +7. Here you can see the **footnotes** Plugin at work. Isn't that plain beautiful? + +== Changelog == + += 2.5.11 = +- Adding: Documentation: Readme.txt: comment line below the 'Stable Tag' field to warn that this is (unexpectedly) parsed for release configuration. +- Adding: Documentation: Readme.txt: informative 'Version' field pointing a tag folder in SVN for bugfix versions available ahead of the stable tag. +- Adding: Documentation: Readme.txt: informative 'Package Version' field in sync with the package version currently hidden in the main PHP script header. +- Bugfix: Dashboard: debug text input fields by disabling quotation mark escapement, thanks to @rumperuu code contribution during the codebase conformance overhaul. +- Update: Codebase: make all PHP code comply to WordPress Coding Standards requirements, thanks to @rumperuu code contribution and refactoring. +- Adding: Documentation: additional readme in markdown format 'README.md' for use with GitHub, thanks to @rumperuu code contribution. +- Adding: Documentation: help and support for contributors by the means of Contributing Guidelines 'CONTRIBUTING.md', thanks to @rumperuu code contribution. +- Adding: Development: pre-commit hook for WordPress projects, modified from @bjornjohansen, thanks to @rumperuu code contribution. + += 2.5.10 = +- Bugfix: Codebase: revert to 2.5.8 with apologies (below), thanks to @little-shiva @watershare @adjayabdg @staho @frav8 @voregnev @dsl225 @alexclassroom @a223123131 @codldmac bug reports. + += 2.5.9d1 = +- Update: Codebase: accidental release of trunk/, tagged when 2.5.10 was released 3½ h later. OUR APOLOGIES, PLEASE, FOR THE 2.5.9d1 PLUGIN 'Stable Tag' MISHAP. + += 2.5.8 = +- Bugfix: Layout: support right-to-left writing direction by replacing remaining CSS values 'left' with 'start', thanks to @arahmanshaalan bug report. +- Bugfix: Layout: support right-to-left writing direction by enabling mirrored paddings on HTML dir="rtl" pages, thanks to @arahmanshaalan bug report. + += 2.5.7 = +- Bugfix: Process: fix footnote duplication by emptying the footnotes list every time the search algorithm is run on the content, thanks to @inoruhana bug report. + += 2.5.6 = +- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports. +- Bugfix: Alternative tooltips: shrink width to short content. +- Update: Documentation: slightly revise or update the plugin’s welcome page on WordPress.org. + += 2.5.5 = +- Update: Stylesheets: increase speed and energy efficiency by tailoring stylesheets to the needs of the instance, thanks to @docteurfitness design contribution. +- Bugfix: Stylesheets: minify to shrink the carbon footprint, increase speed and implement best practice, thanks to @docteurfitness issue report. +- Bugfix: Libraries: optimize processes by loading external and internal scripts only if needed, thanks to @docteurfitness issue report. +- Bugfix: Process: fix numbering bug impacting footnote #2 with footnote #1 close to start, thanks to @rumperuu bug report, thanks to @lolzim code contribution. +- Update: Dashboard: add or edit descriptions to the tooltips and tooltip text delimiter settings and the backlink symbol configuration setting. +- Update: Dashboard: decrease font size and padding of the descriptions. + += 2.5.4 = +- Bugfix: Referrers: optional fixes to vertical alignment, font size and position (static) for in-theme consistency and cross-theme stability, thanks to @tomturowski bug report. +- Bugfix: Tooltips: fix jQuery positioning bug moving tooltips out of view and affecting (TablePress tables in) some themes, thanks to @wisenilesh bug report. +- Bugfix: Reference container, tooltips: URL wrap: enable the 'word-wrap: anywhere' rule, thanks to @rebelc0de bug report. +- Bugfix: Reference container, tooltips: URL wrap: account for leading space in value, thanks to @karolszakiel example provision. +- Bugfix: Dashboard: Tooltip dimensions: move from 'Tooltip position' to a dedicated metabox, thanks to @codldmac issue report. +- Update: Libraries: jQuery Tools: replace deprecated function jQuery.isFunction(), thanks to @a223123131 bug report. +- Bugfix: Editor button: Classic Editor text mode: try to fix uncaught reference error of “QTags is not defined”, thanks to @dpartridge bug report. +- Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report. +- Update: Tooltips: Excerpt delimiter: add configuration settings in the dashboard. +- Bugfix: Tooltips: fix display in Popup Maker popups by correcting a coding error. +- Bugfix: Editor button: Classic Editor text mode: correct label to singular. +- Bugfix: Libraries: jQuery Tools: replace double equals sign discouraged in JavaScript with recommended triple equals sign. + += 2.5.3 = +- Bugfix: Reference container, tooltips: URL wrap: exclude URL pattern as folder name in Wayback Machine URL, thanks to @rumperuu bug report. + += 2.5.2 = +- Update: Tooltips: Excerpt delimiter: ability to display dedicated content before `[[/tooltip]]`, thanks to @jbj2199 issue report. +- Bugfix: Localization: plugin language file name changes effective in version control system. + += 2.5.1 = +- Bugfix: Hooks: support footnotes in Popup Maker popups, thanks to @squatcher bug report. +- Bugfix: Reference container: click on label expands but also collapses, thanks to @ahmadword bug report. +- Bugfix: Reference container: Label: cursor takes pointer shape, thanks to @ahmadword bug report. +- Bugfix: Dashboard: Custom CSS: mention validity of legacy while visible, thanks to @rkupadhya bug report. +- Bugfix: Dashboard: Custom CSS: make class list column formatting effective again. +- Update: Readme/documentation: add new contributors in the file header’s Contributors field. +- Update: Readme/documentation: update or fix URLs in Download, Support and Development sections. + += 2.5.0 = +- Adding: Templates: Enable template location stack, thanks to @misfist code contribution. +- Bugfix: Hooks: support footnotes on category pages, thanks to @vitaefit bug report, thanks to @misfist code contribution. +- Bugfix: Footnote delimiters: Syntax validation: exclude certain cases involving scripts, thanks to @andreasra bug report. +- Bugfix: Footnote delimiters: Syntax validation: complete message with hint about setting, thanks to @andreasra bug report. +- Bugfix: Footnote delimiters: Syntax validation: limit length of quoted string to 300 characters, thanks to @andreasra bug report. +- Update: Dashboard: Footnote delimiters: Syntax validation: add more information around the setting. +- Bugfix: Dashboard: Footnote delimiters: warning about '>' escapement disruption in WordPress Block Editor. + += 2.4.0 = +- Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes. +- Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution. +- Bugfix: Process: initialize hard link address variables to empty string to fix 'undefined variable' bug, thanks to @a223123131 bug report. +- Bugfix: Reference container: Label: set empty label to U+202F NNBSP for more robustness, thanks to @lukashuggenberg feedback. +- Bugfix: Scroll offset: initialize to safer one third window height for more robustness, thanks to @lukashuggenberg bug report. +- Bugfix: Footnote delimiters: Dashboard: remove new option involving HTML comment tags only usable in source mode. +- Bugfix: Reference container: Row borders: adapt left padding to the presence of an optional left border. +- Bugfix: Reference container: add class 'footnote_plugin_symbol' to disambiguate repurposed class 'footnote_plugin_link'. + += 2.3.0 = +- Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution. +- Bugfix: Reference container: convert top padding to margin and make it a setting, thanks to @hamshe bug report. +- Bugfix: Referrers and backlinks: more effectively remove unwanted underline by disabling box shadow used instead of bottom border, thanks to @klusik feedback. +- Bugfix: Dashboard: Custom CSS: swap migration Boolean, meaning 'show legacy' instead of 'migration complete', due to storage data structure constraints. +- Update: Dashboard: Priority level: rename tab as 'Scope and priority', to account for the new alternative depending on widget_text hook activation. +- Bugfix: Referrers and tooltips: correct scope of the line height fix to only affect the referrers, not the tooltip content. +- Bugfix: Referrers: extend clickable area to the full line height in sync with current pointer shape. +- Bugfix: Referrers: extend scope of the underline inhibition to be more comprehensive and consistent. +- Bugfix: Reference container: Basic responsive page layout: edits to one of the optional stylesheets. + += 2.2.10 = +- Bugfix: Reference container: add option for table borders to restore pre-2.0.0 design, thanks to @noobishh issue report. +- Bugfix: Reference container: add missing container ID in function name in default table row template for uncombined footnotes. +- Bugfix: Reference container, tooltips: URL wrap: support also file transfer protocol URLs. + += 2.2.9 = +- Bugfix: Reference container, widget_text hook: support for multiple containers in a page, thanks to @justbecuz bug report. +- Update: Priority levels: set widget_text default to 98 and update its description in the dashboard Priority level tab. +- Bugfix: Reference container, tooltips: URL wrap: account for RFC 2396 allowed characters in parameter names. +- Bugfix: Reference container, tooltips: URL wrap: exclude URLs also where the equals sign is preceded by an entity or character reference. + += 2.2.8 = +- Bugfix: Reference container, tooltips: URL wrap: correctly make the quotation mark optional wrt query parameters, thanks to @spiralofhope2 bug report. + += 2.2.7 = +- Bugfix: Reference container, tooltips: URL wrap: remove a bug introduced in the regex, thanks to @rjl20 @spaceling @lukashuggenberg @klusik @friedrichnorth @bernardzit bug reports. + += 2.2.6 = +- Bugfix: Reference container, tooltips: URL wrap: make the quotation mark optional wrt query parameters, thanks to @spiralofhope2 bug report. +- Adding: Templates: support for custom templates in sibling folder, thanks to @misfist issue report. + += 2.2.5 = +- Bugfix: Dashboard: Footnotes numbering: add missing support for Ibid. notation to suggestions, thanks to @meglio design contribution. +- Bugfix: Reference container: Label: make bottom border an option, thanks to @markhillyer issue report. +- Bugfix: Reference container: Label: option to select paragraph or heading element, thanks to @markhillyer issue report. +- Bugfix: Reference container: delete position shortcode if unused because position may be widget or footer, thanks to @hamshe bug report. +- Update: Tooltips: Alternative tooltips: connect to position/timing settings (for themes not supporting jQuery tooltips). +- Update: Dashboard: Tooltip position/timing settings: include alternative tooltips (for themes not supporting jQuery tooltips). +- Bugfix: Dashboard: Tooltip position/timing settings: raise above tooltip truncation settings for better consistency. + += 2.2.4 = +- Bugfix: Reference container: Backlink symbol selection: move back to previous tab “Referrers and tooltips”. +- Bugfix: Custom CSS: make inserting existing in header depend on migration complete checkbox status. + += 2.2.3 = +- Bugfix: Custom CSS: insert new CSS in the public page header element after existing CSS. + += 2.2.2 = +- Bugfix: Dashboard: Link element setting only under General settings > Reference container. +- Bugfix: Dashboard: Custom CSS: unearth text area and migrate to dedicated tab as designed. +- Bugfix: Reference container: edits to optional basic responsive page layout stylesheets. + += 2.2.1 = +- Bugfix: Dashboard: duplicate moved settings under their legacy tab to account for data structure. + += 2.2.0 = +- Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report. +- Adding: Dashboard: Footnote delimiters: more predefined options. +- Adding: Numbering styles: lowercase Roman numerals support. +- Update: Priority levels: update the notice in the dashboard Priority tab. +- Update: Dashboard: Tooltip settings: group into 3 thematic containers. +- Update: Dashboard: Main settings: group into 3 specific containers. +- Update: Dashboard: move link element option to the Referrers options. +- Update: Dashboard: move URL wrap option to the Reference container options. +- Update: Dashboard: group both Custom CSS and priority level settings under the same tab. +- Update: Dashboard: rename tab labels 'Referrers and tooltips', 'Priority and CSS'. +- Bugfix: Tooltips: add 'important' property to z-index to fix display overlay issue. +- Bugfix: Localization: correct arguments for plugin textdomain load function. +- Bugfix: Reference container, tooltips: URL wrap: specifically catch the quotation mark. +- Adding: Footnotes mention in the footer: more options. + += 2.1.6 = +- Bugfix: Priority levels: set the_content priority level to 98 to prevent plugin conflict, thanks to @marthalindeman bug report. +- Bugfix: Tooltips: set z-index to maximum 2147483647 to address display issues with overlay content, thanks to @russianicons bug report. +- Bugfix: Reference container, tooltips: URL wrap: fix regex, thanks to @a223123131 bug report. +- Bugfix: Dashboard: URL wrap: add option to properly enable/disable URL wrap. +- Update: Dashboard: reorder tabs and update tab labels. +- Bugfix: Dashboard: remove Expert mode enable setting since permanently enabled as 'Priority'. +- Bugfix: Dashboard: fix punctuation-related localization issue by including colon in labels. +- Bugfix: Localization: conform to WordPress plugin language file name scheme, thanks to @nikelaos bug report. + += 2.1.5 = +- Bugfix: Reference container, tooltips: URL wrap: exclude image source too, thanks to @bjrnet21 bug report. + += 2.1.4 = +- Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers. +- Bugfix: Scroll duration: make configurable to conform to website content and style requirements. +- Bugfix: Tooltips: make display delays and fade durations configurable to conform to website style. +- Bugfix: Tooltips: Styling: fix font size issue by adding font size to settings with legacy as default. +- Bugfix: Reference container: fix layout by optionally enqueuing additional stylesheet (depends on theme). +- Bugfix: Reference container: fix layout issues by moving backlink column width to settings. +- Bugfix: Reference container: make separating and terminating punctuation optional and configurable, thanks to @docteurfitness issue report and code contribution. +- Bugfix: Reference container: Backlinks: fix stacked enumerations by adding optional line breaks. +- Bugfix: Tooltips: Read-on button: Label: prevent line breaks. +- Bugfix: Referrers and backlinks: Styling: make link elements optional to fix issues, thanks to @docteurfitness issue report and code contribution. +- Bugfix: Referrers: Styling: disable hover underline. +- Bugfix: Reference container, tooltips: fix line wrapping of URLs (hyperlinked or not) based on pattern, not link element. +- Bugfix: Reference container: Backlink symbol: support for appending when combining identicals is on. +- Bugfix: Reference container: Backlinks: deprioritize hover underline to ease customization. +- Bugfix: Reference container: Backlinks: fix line breaking with respect to separators and terminators. +- Bugfix: Reference container: Label: delete overflow hidden rule. +- Bugfix: Reference container: Expand/collapse button: same padding to the right for right-to-left. +- Bugfix: Reference container: Styles: re-add the class dedicated to combined footnotes indices. +- Bugfix: Dashboard: move arrow settings from Customize to Settings > Reference container to reunite and fix issue with new heading wording. +- Bugfix: Dashboard: Main settings: fix layout, raise shortcodes to top. +- Bugfix: Dashboard: Tooltip settings: Truncation length: change input box type from text to numeric. +- Update: Dashboard: Notices: use explicit italic style. +- Bugfix: Dashboard: Other settings: Excerpt: display guidance next to select box, thanks to @nikelaos bug report. +- Bugfix: WordPress hooks: the_content: set priority to 1000 as a safeguard. +- Update: Dashboard: Expert mode: streamline and update description for hooks and priority levels. + += 2.1.3 = +- Bugfix: Hooks: disable widget_text hook by default to fix accordions declaring headings as widgets. +- Bugfix: Hooks: disable the_excerpt hook by default to fix issues, thanks to @nikelaos bug report. +- Bugfix: Reference container: fix column width when combining turned on by reverting new CSS class to legacy. +- Bugfix: Reference container: fix width in mobile view by URL wrapping for Unicode-non-conformant browsers, thanks to @karolszakiel bug report. +- Bugfix: Reference container: table cell backlinking if index is single and combining identicals turned on. +- Bugfix: Styling: raise Custom CSS priority to override settings. +- Bugfix: Styling: Tooltips: raise settings priority to override theme stylesheets. + += 2.1.2 = +- Bugfix: Reference container: Backlinks: no underline on hover cell when combining identicals is on. +- Bugfix: Dashboard: priority level settings for all other hooks, thanks to @nikelaos bug report. +- Update: Dashboard: WordPress documentation URLs of the hooks. +- Update: Dashboard: feature description for the hooks priority level settings, thanks to @nikelaos bug report. + += 2.1.1 = +- Bugfix: Referrers, reference container: Combining identical footnotes: fix dead links and ensure referrer-backlink bijectivity, thanks to @happyches bug report. +- Bugfix: Dashboard: priority level setting for the_content hook, thanks to @imeson bug report. +- Update: Libraries: jQuery Tools: redact (comment out) all 6 instances of deprecated function jQuery.browser(), thanks to @bjrnet21 @cconser @vyassuresh @spaceling @widecast @olivlyon @maxident bug reports. +- Bugfix: Libraries: jQuery Tools: complete minification. +- Bugfix: Libraries: make script loads depend on tooltip implementation option. +- Bugfix: Libraries: jQuery UI: properly pick the libraries registered by WordPress needed for tooltips. +- Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report. +- Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback. +- Bugfix: Reference container: Footnote number links: disable bottom border for theme compatibility. +- Bugfix: Reference container: option to restore pre-2.0.0 layout with the backlink symbol in an extra column. +- Bugfix: Reference container: option to append symbol (prepended by default), thanks to @spaceling code contribution. +- Bugfix: Reference container: Table rows: fix top and bottom padding. +- Bugfix: Referrers: new setting for vertical align: superscript (default) or baseline (optional), thanks to @cwbayer bug report. +- Bugfix: Referrers: line height 0 to fix superscript, thanks to @cwbayer bug report. +- Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback. +- Bugfix: Tooltips: add delay (400ms) before fade-out to fix UX wrt links and Read-on button. +- Bugfix: Tooltips: fix line breaking for hyperlinked URLs in Unicode-non-compliant user agents, thanks to @andreasra bug report. +- Bugfix: Formatting: disable overline showing in some themes on hovered backlinks. + += 2.1.0 = +- Adding: Tooltips: Read-on button: Label: configurable instead of localizable, thanks to @rovanov example provision. +- Bugfix: Referrers: disable bottom border for theme compatibility. +- Update: Accessibility: add 'speaker-mute' class to reference container. +- Bugfix: Dashboard: Layout: add named selectors to limit applicability of styles. +- UPDATE: Hooks: remove 'the_post', the plugin stops supporting this hook. + += 2.0.8 = +- BUGFIX: Priority level back to PHP_INT_MAX (need to get in touch with other plugins). + += 2.0.7 = +- BUGFIX: Hooks: Default-disable 'the_post', thanks to @spaceling @markcheret @nyamachi @whichgodsaves @spiralofhope2 @mmallett @andreasra @widecast @ymorin007 @tashi1es bug reports. +- Update: Set priority level back to 10 assuming it is unproblematic. +- Update: Added backwards compatible support for legacy arrow and index placeholders in template. +- Update: Settings defaults adjusted for better and more up-to-date tooltip layout. + += 2.0.6 = +- Bugfix: Infinite scroll: debug autoload by adding post ID, thanks to @docteurfitness code contribution. +- Bugfix: Referrers: delete vertical align tweaks, for cross-theme and user agent compatibility. +- Bugfix: Reference container: fix line breaking behavior in footnote number clusters. +- Bugfix: Reference container: auto-extending column to fit widest, to fix display with short note texts. +- Bugfix: Reference container: IDs: slightly increased left padding. +- Bugfix: Translations: fix spelling error and erroneously changed word in en_GB and en_US. +- Bugfix: Typesetting: discard the dot after footnote numbers as not localizable (should be optional). +- Bugfix: Reference container: Collapse button fully clickable, not sign only. +- Bugfix: Reference container: Collapse button 'collapse' with minus sign not hyphen-minus. +- Update: Tooltips: set display predelay to 0 for responsiveness (was 800 since 2.0.0, 400 before). +- Update: Tooltips: set fade duration to 200ms both ways (was 200 in and 2000 out since 2.0.0, 0 in and 100 out before). +- BUGFIX: Priority level back to PHP_INT_MAX (ref container positioning not this plugin’s responsibility). +- Update: Scroll offset: raise percentage from 12% to a safer 20% inner window height, by lack of configurability. + += 2.0.5 = +- Bugfix: Reference container: fix relative position through priority level, thanks to @june01 @imeson @spaceling bug reports, thanks to @spaceling code contribution. +- Bugfix: Reference container: unset width of text column to fix site issues. +- Update: Hooks: Default-enable all hooks to prevent footnotes from seeming broken in some parts. +- Bugfix: Tooltips: Restore cursor shape 'pointer' over Read-on button after hard link removal. +- Bugfix: Settings stylesheet: unenqueue to fix input boxes on public pages (enqueued for 2.0.4). + += 2.0.4 = +- Update: Restore arrow settings to customize or disable the now prepended arrow symbol. +- Update: Libraries: Load jQuery UI from WordPress, thanks to @check2020de issue report. +- Bugfix: Referrers and backlinks: remove hard links to streamline browsing history, thanks to @theroninjedi47 bug report. +- Bugfix: Reference container: remove inconvenient left/right cellpadding. +- Bugfix: Tooltips: improve layout with inherited font size by lower line height. +- Bugfix: Tooltips: 'Continue reading' button: disable default underline. +- Bugfix: Translations: review all locales (en, de, es, fr), synced ref line # with edited code. +- Bugfix: Dashboard: fix display of two headings containing the logo. + += 2.0.3 = +- Bugfix: Reference container: Self-adjusting width of ID column but hidden overflow. +- Update: Reference container: clarify backlink semantics by prepended transitional up arrow, thanks to bug report. +- Bugfix: Fragment IDs: Prepended post ID to footnote number. +- Bugfix: External stylesheets cache busting: add plugin version number argument in enqueuing function call. +- Bugfix: Print style: prevent a page break just after the reference container label. +- Bugfix: Print style: Hide reference collapse button. +- Update: Reference container: Headline: remove padding before reference container label. +- Update: Scroll offset: raise percentage from 5% to a safer 12% inner window height, by lack of setting. + += 2.0.2 = +- Bugfix: Reference container: restore expand/collapse button in the template, thanks to @ragonesi bug report. +- Bugfix: Dashboard: Custom CSS: Available selectors: fix display of the last item. +- Bugfix: Referrers and backlinks: restore default link color on screen, set color to inherit in print. +- Bugfix: Referrers: disable text decoration underline by default, enable underline on hover. + += 2.0.1 = +- Bugfix: Reference container: enforce borderless table cells, thanks to @ragonesi bug report. +- Update: Translations: revised fr_FR. + += 2.0.0 = +- Major contributions taken from WordPress user pewgeuges, all details here https://github.com/media-competence-institute/footnotes/blob/master/README.md: +- Update: **symbol for backlinks** removed +- Update: hyperlink moved to the reference number +- Update: Tooltips: fix disabling bug by loading jQuery UI library, thanks to @rajinderverma @ericcorbett2 @honlapdavid @mmallett @twellve_million bug reports, thanks to @vonpiernik code contribution. +- Update: Libraries: jQuery Tools: add condition whether deprecated function jQuery.browser() exists, thanks to @vonpiernik code contribution. +- Bugfix: Localization: correct function call apply_filters() with all required arguments after PHP 7.1 promoted warning to error, thanks to @matkus2 bug report and code contribution. +- Bugfix: footnote links script independent +- Bugfix: Get the “Continue reading” link to work in the mouse-over box +- Bugfix: Debug printed posts and pages +- Bugfix: Display of combined identical notes +- Update: Adjusted scrolling time and offset +- Bugfix: Reference container: no borders around footnotes, thanks to @ragonesi bug report. +- Bugfix: Mouse-over box display timing +- Update: Translations: revised de_AT, de_DE, en_GB, en_US, es_ES + += 1.6.6 = +- Beginning of translation to French + += 1.6.5 = +- Bugfix: Improve widgets registration, thanks to @felipelavinz code contribution. +- Update: Fix for deprecated PHP function create_function(), thanks to @psykonevro @daliasued bug reports, thanks to @felipelavinz code contribution. +- Update: The CSS has been modified in order to show the tooltip numbers a little less higher than text +- Bugfix: Dashboard: fix error on demo under the Preview tab. + += 1.6.4 = +- Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution. +- Bugfix: Fixed occasional bug where footnote ordering could be out of sequence + += 1.6.3 = +- Bugfix: We were provided a fix by a user named toma. footnotes now works in sub-folder installations of WordPress + += 1.6.2 = +- Update: Changed the Preview tab +- Bugfix: Html tags has been removed in the Reference container when the excerpt mode is enabled + += 1.6.1 = +- Update: Translations +- Bugfix: Move to anchor + += 1.6.0 = +- **IMPORTANT**: Improved performance. You need to Activate the Plugin again. (Settings won't change!) +- Adding: Setting to customize the mouse-over box shadow +- Adding: Translation: United States +- Adding: Translation: Austria +- Adding: Translation: Spanish (many thanks to Pablo L.) +- Update: Translations (de_DE and en_GB) +- Update: Changed Plugins init file name to improve performance (Re-activation of the Plugin is required) +- Update: ManFisher note styling +- Update: Tested with latest nightly build of WordPress 4.1 +- Bugfix: Avoid multiple IDs for footnotes when multiple reference containers are displayed + += 1.5.7 = +- Adding: Setting to define the positioning of the mouse-over box +- Adding: Setting to define an offset for the mouse-over box (precise positioning) +- Bugfix: Target element to move down to the reference container is the footnote index instead of the arrow (possibility to hide the arrow) +- Bugfix: Rating calculation for the 'other plugins' list + += 1.5.6 = +- **IMPORTANT**: We have changed the html tag for the superscript. Please check and update your custom CSS. +- Adding: .pot file to enable Translations for everybody +- Adding: Settings to customize the mouse-over box (color, background color, border, max. width) +- Update: Translation file names +- Update: Translation EN and DE +- Update: Styling of the superscript (need to check custom CSS code for the superscript) +- Update: Description of CSS classes for the 'customize CSS' text area +- Bugfix: Removed 'a' tag around the superscript for Footnotes inside the content to avoid page reloads (empty href attribute) +- Bugfix: Avoid Settings fallback to its default value after submit an empty value for a setting +- Bugfix: Enable multiple WP_Post objects for the_post hook + += 1.5.5 = +- Adding: Expert mode setting +- Adding: Activation and Deactivation of WordPress hooks to look for Footnotes (expert mode) +- Adding: WordPress hooks: 'the_title' and 'widget_title' (default: disabled) to search for Footnote short codes +- Bugfix: Default value for the WordPress hook the_post to be disabled (adds Footnotes twice to the Reference container) +- Bugfix: Activation, Deactivation and Uninstall hook class name +- Bugfix: Add submenu pages only once for each ManFisher WordPress Plugin +- Bugfix: Display the Reference container in the Footer correctly + += 1.5.4 = +- Adding: Setting to enable an excerpt of the Footnotes mouse-over box text (default: disabled) +- Adding: Setting to define the maximum length of the excerpt displayed in the mouse-over box (default: 150 characters) +- Update: Detail information about other Plugins from ManFisher (rating, downloads, last updated, Author name/url) +- Update: Receiving list of other Plugins from the Developer Team from an external server +- Update: Translations (EN and DE) +- Bugfix: Removed hard coded position of the 'ManFisher' main menu page (avoid errors with other Plugins) +- Bugfix: Changed function name (includes.php) to be unique (avoid errors with other Plugins) +- Bugfix: Try to replace each appearance of Footnotes in the current Post object loaded from the WordPress database + += 1.5.3 = +- Adding: Developer's homepage to the 'other Plugins' list +- Update: Smoothy scroll to an anchor using Javascript +- Bugfix: Set the vertical align for each cell in the Reference container to TOP + += 1.5.2 = +- Adding: Setting to enable/disable the mouse-over box +- Adding: Current WordPress Theme to the Diagnostics sub page +- Adding: ManFisher note in the "other Plugins" sub page +- Update: Removed unnecessary hidden inputs from the Settings page +- Update: Merged public CSS files to reduce the output and improve the performance +- Update: Translations (EN and DE) +- Bugfix: Removed the 'trim' function to allow whitespaces at the beginning and end of each setting +- Bugfix: Convert the footnotes short code to HTML special chars when adding them into the page/post editor (visual and text) +- Bugfix: Detailed error messages if other Plugins can't be loaded. Also added empty strings as default values to avoid 'undefined' + += 1.5.1 = +- Bugfix: Broken Settings link in the Plugin listing +- Bugfix: Translation overhaul for German + += 1.5.0 = +- Adding: Grouped the Plugin Settings into a new Menu Page called "ManFisher Plugins" +- Adding: Sub Page to list all other Plugins of the Contributors +- Adding: Hyperlink to manfisher.eu in the "other plugins" page +- Update: Refactored the whole source code +- Update: Moved the Diagnostics Sections to into a new Sub Page called "Diagnostics" +- Bugfix: Line up Footnotes with multiple lines in the Reference container +- Bugfix: Load text domain +- Bugfix: Display the Footnotes button in the plain text editor of posts/pages + += 1.4.0 = +- Feature: WPML Config XML file for easy multi language string translation (WPML String Translation Support File) +- Update: Changed e-Mail support address to the WordPress support forum +- Update: Language EN and DE +- Adding: Tab for Plugin Diagnostics +- Adding: Donate link to the installed Plugin overview page +- Adding: Donate button to the "HowTo" tab + += 1.3.4 = +- Bugfix: Settings access permission vor sub-sites +- Bugfix: Setting 'combine identical footnotes' working as it should + += 1.3.3 = +- Update: Changed the Author name from a fictitious entity towards a real registered company +- Update: Changed the Author URI + += 1.3.2 = +- Bugfix: More security recognizing Footnotes on public pages (e.g. ignoring empty Footnote short codes) +- Bugfix: Clear old Footnotes before lookup new public page (only if no reference container displayed before) +- Update: language EN and DE +- Adding: Setting to customize the hyperlink symbol in der reference container for each footnote reference +- Adding: Setting to enter a user defined hyperlink symbol +- + += 1.3.1 = +- Bugfix: Allow settings to be empty +- Bugfix: Removed space between the hyperlink and superscript in the footnotes index +- Adding: Setting to customize the text before and after the footnotes index in superscript + += 1.3.0 = +- Bugfix: Changed tooltip class to be unique +- Bugfix: Changed superscript styling to not manipulate the line height +- Bugfix: Changed styling of the footnotes text in the reference container to avoid line breaks +- Update: Reformatted code +- Adding: new settings tab for custom CSS settings + += 1.2.5 = +- Bugfix: New styling of the mouse-over box to stay in screen (thanks to Jori, France and Manuel345, undisclosed location) + += 1.2.4 = +- Bugfix: CSS stylesheets will only be added in FootNotes settings page, nowhere else (thanks to Piet Bos, China) +- Bugfix: Styling of the reference container when the footnote text was too long (thanks to Willem Braak, undisclosed location) +- Bugfix: Added a Link to the footnote text in the reference container back to the footnote index in the page content (thanks to Willem Braak, undisclosed location) + += 1.2.3 = +- Bugfix: Removed 'Warning output' of Plugins activation and deactivation function (thanks to Piet Bos, China) +- Bugfix: Added missing meta boxes parameter on Settings page (thanks to Piet Bos, China) +- Bugfix: Removed Widget text formatting +- Bugfix: Load default settings value of setting doesn't exist yet (first usage) +- Bugfix: Replacement of footnotes tag on public pages with html special characters in the content +- Feature: Footnotes tag color is set to the default link color depending on the current Theme (thanks to Daniel Formo, Norway) + += 1.2.2 = +- Bugfix: WYSIWYG editor and plain text editor buttons insert footnote short code correctly (also if defined like html tag) +- Update: The admin can decide which "I love footnotes" text (or not text) will be displayed in the footer +- Adding: Buttons next to the reference label to expand/collapse the reference container if set to "collapse by default" +- Bugfix: Replace footnote short code +- Update: Combined buttons for the "collapse/expand" reference container + += 1.2.1 = +- Bugfix: HowTo example will be displayed correctly if a user defined short code is set + += 1.2.0 = +- Feature: New button in the WYSIWYG editor and in the plain text editor to easily implement the footnotes tag +- Feature: Icon for the WYSIWYG-editor button +- Feature: Pre defined footnote short codes +- Experimental: User defined short code for defining footnotes +- Experimental: Plugin Widget to define where the reference container should appear when set to "widget area" +- Update: Moved footnotes 'love' settings to a separate container +- Update: Translation for new settings and for the Widget description +- Bugfix: Setting for the position of the "reference container" works for the options "footer", "end of post" and "widget area" + += 1.1.1 = +- Feature: Short code to not display the 'love me' slug on specific pages ( short code = [[no footnotes: love]] ) +- Update: Setting where the reference container appears on public pages can also be set to the widget area +- Adding: Link to the wordpress.org support page in the plugin main page +- Update: Changed plugin URL from GitHub to WordPress +- Bugfix: Uninstall function to really remove all settings done in the settings page +- Bugfix: Load default settings after plugin is installed +- Update: Translation for support link and new setting option +- Adding: Label to display the user the short code to not display the 'love me' slug + += 1.1.0 = +- Update: Global styling for the public plugin name +- Update: Easier usage of the public plugin name in translations +- Update: New Layout for the settings page to group similar settings to get a better overview +- Update: Display settings submit button only if there is at least 1 editable setting in the current tab +- Adding: Setting where the reference container appears on public pages (needs some corrections!) +- Bugfix: Displays only one reference container in front of the footer on category pages + += 1.0.6 = +- Bugfix: Uninstall function to delete all plugin settings +- Bugfix: Counter style internal name in the reference container to correctly link to the right footnote on the page above +- Bugfix: Footnote hover box styling to not wrap the footnote text on mouse over +- Update: 'footnotes love' text in the page footer if the admin accepts it and set its default value to 'no' + += 1.0.5 = +- The Plugin has been submitted to wordpress.org for review and (hopefully) publication. +- Update: Plugin description for public directories (WordPress.org and GitHub) +- Feature: the footnotes WordPress Plugin now has its very own CI + - Update: Styling + - Update: Settings to support the styling +- Adding: Inspirational Screenshots for further development +- Adding: Settings screenshot +- Update: i18n fine-tuning + += 1.0.4 = +- Update: replacing function when footnote is a link (bugfix) +- Footnote hover box remains until cursor leaves footnote or hover box +- Links in the footnote hover box are click able +- Adding: setting to allow footnotes on Summarized Posts +- Adding: setting to tell the world you're using footnotes plugin +- Adding: setting for the counter style of the footnote index + - Arabic Numbers (1, 2, 3, 4, 5, ...) + - Arabic Numbers leading 0 (01, 02, 03, 04, 05, ...) + - Latin Characters lower-case (a, b, c, d, e, ...) + - Latin Characters upper-case (A, B, C, D, E, ...) + - Roman Numerals (I, II, III, IV, V, ...) +- Adding: a link to the WordPress plugin in the footer if the WP-admin accepts it +- Update: translations for the new settings +- Switch back the version numbering scheme to have 3 digits + += 1.0.3 = +- Adding: setting to use personal starting and ending tag for the footnotes +- Update: translations for the new setting +- Update: reading settings and fallback to default values (bugfix) + += 1.0.2 = +- Adding: setting to collapse the reference container by default +- Adding: link behind the footnotes to automatically jump to the reference container +- Adding: function to easy output input fields for the settings page +- Update: translation for the new setting + += 1.0.1 = +- Separated functions in different files for a better overview +- Adding: a version control to each file / class / function / variable +- Adding: layout for the settings menu, settings split in tabs and not a list-view +- Update: Replacing footnotes in widget texts will show the reference container at the end of the page (bugfix) +- Update: translations for EN and DE +- Changed version number from 3 digits to 2 digits + += 1.0.0 = +- First development Version of the Plugin + +== Upgrade Notice == +to upgrade our plugin is simple. Just update the plugin within your WordPress installation. +To cross-upgrade from other footnotes plugins, there will be a migration assistant in the future