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/
422a6d1fa2
Move date to @date tag below the @since tag. Delete @lastmodified tag as pointless, easily out of sync, and screwing things up when collaborating. Need to mention however that in many projects, the last modified datestamp is applied and maintained. That said, some published files on the web out there contain edits post-dating their datestamp. |
||
---|---|---|
.github/ISSUE_TEMPLATE | ||
_tools | ||
class | ||
contrib | ||
css | ||
development | ||
docs | ||
img | ||
js | ||
languages | ||
templates | ||
.gitignore | ||
composer.json | ||
composer.lock | ||
CONTRIBUTING.md | ||
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 development environment
- Install Composer, if you don't have it already
- Install dependencies (
composer install
) - Create a new branch from
main
(git checkout -b <your-descriptive-branch-name>
) - When you're finished, commit your changes to the remote version of your branch and submit a pull request.
Checking WP Coding Standard Compliance
- Run PHP_CodeSniffer on the file(s) you want to check (
./vendor/bin/phpcs --standard="WordPress" --colors --encoding=utf-8 -n -p <file(s)>
) - (If applicable) run the PHP Code Beautifier and Formatter to attempt to automatically fix any errors (
./vendor/bin/phpcbf --standard="WordPress" --encoding=utf-8 -p <file(s)>
)
- Add the
-n
flag to ignore warnings (i.e., show only errors) - Add the
-s
flag to show sniff codes (used for disabling errors in the code withphpcs disable:<sniff code>
— MAKE SURE THAT YOU HAVEphpcs enable
AT THE EARLIEST POINT POSSIBLE, and provide a justification for disabling the sniff code) - 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
)
- You may have to enable double-wildcards in your console first (
Updating Documentation
- Install phpDocumentor
- Run it (
phpDocumentor -d . -t 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-shortcode
with 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!