footnotes/README.md

footnotes

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 will be displayed.

footnotes gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts — those footnotes we know from offline publishing.

Featured on wpmudev — cheers for the review, folks!

Table of Contents

• Features
• Getting Started
• Documentation
• Testing
• Acknowledgments
• License
• Contact Information

Features

This Plugin provides:

• fully-customizable footnote start and end shortcodes;
• stylable tooltips supporting hyperlinks and dedicated text;
• a responsive reference container, with customisable positioning;
• a wide choice of different numbering styles;
• a freely-configurable and optional backlink symbol;
• footnote appearance customisation via dashboard settings and custom CSS style rules; and
• editor buttons for easily adding shortcode tags.

Getting Started

1. Read the contributing guidelines;
2. clone this repository (git clone git@github.com:markcheret/footnotes.git):
   • we recommend that you use VVV for your local testing environment.
3. install Composer and NPM; and
4. install all dependencies (composer install):
   • you will have to install php-mbstring manually if you do not already have it.

Documentation

View the current docs here.

Testing

This repo. uses PHPUnit to run automated tests. To run the full test suite, use composer run test.

Test cases are found in the tests/ directory.

PHPUnit settings are available in the file phpunit.xml.

Acknowledgements

Huge thanks to every footnotes user, contributor, bug reporter, feature requester and fan!

License

This project is licensed under the GNU GPL v3.

Contact Information

Name	Link(s)
Mark Cheret	Email