footnotes aims to be the all-in-one solution for displaying an automatically-generated list of references on your WordPress Page or Post. [NB - clone of https://github.com/markcheret/footnotes, no longer mirroring]
https://bengoldsworthy.net/portfolio/programs/footnotes/
Rumperuu
b824a44541
Renames the current production flag variable to be shorter, non-Hungarian (presaging changes to come in #35) and not specifically CSS_-related. See #80 |
||
|---|---|---|
| .github | ||
| _tools | ||
| class | ||
| contrib | ||
| css | ||
| docs | ||
| img | ||
| js | ||
| languages | ||
| templates | ||
| .distignore | ||
| .gitignore | ||
| .php-commitizen.php | ||
| composer.json | ||
| composer.lock | ||
| CONTRIBUTING.md | ||
| customized-documentation-schema.txt | ||
| customized-template-stack.txt | ||
| features.txt | ||
| footnotes.php | ||
| includes.php | ||
| LICENSE | ||
| license.txt | ||
| README.md | ||
| readme.txt | ||
| SECURITY.md | ||
| wpml-config.xml | ||
footnotes
Description
Featured on wpmudev — 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 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.
Getting Started
- Read the contributing guidelines
- Clone this repository (
git clone git@github.com:markcheret/footnotes.git)- We recommend that you use VVV for your local testing environment
- Install Composer, if you don't have it already
- Install dependencies (
composer install)- You will have to install
php-mbstringmanually if you do not already have it.
- You will have to install
Code Formatting
- Run
composer run lint-phpto lint all PHP files - Run
composer run lint-php:fixto attempt to automatically fix errors and warnings
Releasing
- Run
composer run release
Building
- Run
_tools/build-stylesheets.sh -cto concatenate stylesheets - Manually minify the output files in
css/tmp/, saving them as.min.cssfiles
- The intention is to replace this with automated minification, meaning that
all of these steps can be rolled into a single
buildcommand.
- Run
_tools/build-stylesheets.sh -dto deploy the minified files todist/
- this will delete any existing
dist/folder
- Run
composer run buildto move over the remaining files todist/
- 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
.distignorefile
Updating Documentation
- Run
composer run docs
Testing
Unit tests are TODO.
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:
- Your awesome text
((with an awesome footnote)) - Your awesome text
[ref]with an awesome footnote[/ref] - Your awesome text
<fn>with an awesome footnote</fn> - Your awesome text
custom-shortcodewith an awesome footnotecustom-shortcode
Where to get footnotes?
The current version is available on the WordPress.org Plugin Directory.
Acknowledgements
Huge thanks to every footnotes user, contributor, bug reporter, feature requester and fan!