Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
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/
This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
293 commits 28 branches 78 tags 9 MiB
PHP 63.8%
Modelica 11.2%
HTML 10.7%
CSS 6.9%
JavaScript 4.9%
Other 2.5%
Find a file
Rumperuu 9c9c9721f7 Add linting instructions and header image
2021-02-21 11:08:04 +00:00
.github/ISSUE_TEMPLATE Update issue templates 2021-02-20 18:47:11 +00:00
class update 2.5.6d4 in case it is tested in the related forum topic.\nFull changelog:\n= 2.5.6 =\n- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.\n- Bugfix: Alternative tooltips: shrink width to short content.\n- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org. 2021-02-20 03:50:52 +00:00
css development update 2.5.6d2 to prepare the newly promised bugfix release adding a reference container template not using jQuery, plain JS instead.\nThe following is the changelog as drafted for this release: \n= 2.5.6 =\n- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it issue report.\n- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org. 2021-02-19 19:42:45 +00:00
development development update 2.5.5d0 to be shared on the forum 2021-02-16 02:23:40 +00:00
img Add footnotes header image 2021-02-21 11:07:48 +00:00
js traceability update 2.5.6d1 revert space indent to tab. 2021-02-18 19:56:44 +00:00
languages urgent release 2.5.2 2021-01-19 23:45:34 +00:00
templates update 2.5.6d4 in case it is tested in the related forum topic.\nFull changelog:\n= 2.5.6 =\n- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.\n- Bugfix: Alternative tooltips: shrink width to short content.\n- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org. 2021-02-20 03:50:52 +00:00
features.txt restore file 2020-06-20 22:08:58 +00:00
footnotes.php update 2.5.6d4 in case it is tested in the related forum topic.\nFull changelog:\n= 2.5.6 =\n- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.\n- Bugfix: Alternative tooltips: shrink width to short content.\n- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org. 2021-02-20 03:50:52 +00:00
includes.php
license.txt
README.md Add linting instructions and header image 2021-02-21 11:08:04 +00:00
readme.txt update 2.5.6d4 in case it is tested in the related forum topic.\nFull changelog:\n= 2.5.6 =\n- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.\n- Bugfix: Alternative tooltips: shrink width to short content.\n- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org. 2021-02-20 03:50:52 +00:00
wpml-config.xml

README.md

footnotes

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 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.

Getting Started

  1. Read the contributing guidelines
  2. Clone this repository (git clone git@github.com:Rumperuu/footnotes.git)
  3. Install Composer, if you don't have it already
  4. Install dependencies (composer install)
  5. Create a new branch from main (git checkout -b <your-descriptive-branch-name>)
  6. When you're finished, commit your changes to the remote version of your branch and submit a pull request.

Checking WP Coding Standard Compliance

  1. Run PHP_CodeSniffer on the file(s) you want to check (./vendor/bin/phpcs --standard="WordPress" --colors --encoding=utf-8 -n -p <file(s)>)
  2. (If applicable) run the PHP Code Beautifier and Formatter to attempt to automatically fix any errors (./vendor/bin/phpcbf --standard="WordPress" --encoding=utf-8 -n -p <file(s)>)
  • You can run either across the entire project by adding the argument --ignore=*/vendor/* and targetting the file */**/*.php

Updating Documentation

  1. Install phpDocumentor
  2. 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:

  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 textcustom-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!