2021-02-20 19:18:41 +00:00
# footnotes
## Description
Featured on [wpmudev ](http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/ ) --- cheers for the review, folks!
**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 current defaults but also empowers 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.
2021-02-20 20:55:46 +00:00
## Getting Started
1. Read the contributing guidelines
1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`)
1. Install [Composer ](https://getcomposer.org/download/ ), if you don't have it already
1. Install dependencies (`composer install`)
1. Create a new branch from `main` (`git checkout -b < your-descriptive-branch-name > `)
1. When you're finished, commit your changes to the remote version of your branch
and submit a [pull request ](https://github.com/Rumperuu/footnotes/pulls ).
## Updating Documentation
1. Install [phpDocumentor ](https://phpdoc.org/ )
1. Run it (`phpDocumentor -d . -t docs`)
2021-02-20 19:18:41 +00:00
## 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`< fn > `with an awesome footnote`</ fn > `
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 Plugin Directory ](https://wordpress.org/plugins/footnotes/ ).
## Acknowledgements
Huge thanks to every footnotes user, contributor, bug reporter, feature requester and fan!
