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.
414 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
Mark Cheret 1d365353e1
Merge pull request #66 from markcheret/dependabot 
Create dependabot.yml
2021-04-04 22:31:02 +02:00
.github Merge pull request #66 from markcheret/dependabot 2021-04-04 22:31:02 +02:00
_tools Add release helper script (#64) 2021-03-17 17:46:21 +00:00
class Add release helper script (#64) 2021-03-17 17:46:21 +00:00
contrib Update codebase to be WP Coding Standard-compliant. 2021-02-23 16:44:18 +00:00
css Add release helper script (#64) 2021-03-17 17:46:21 +00:00
docs Generate HTML documentation using phpDocumentor 2021-02-20 19:55:52 +00:00
img Add footnotes header image 2021-02-21 11:07:48 +00:00
js Add release helper script (#64) 2021-03-17 17:46:21 +00:00
languages urgent release 2.5.2 2021-01-19 23:45:34 +00:00
templates Convert script to snake_case 2021-02-24 23:14:56 +01:00
.distignore Automatically generate new releases (#59) 2021-03-12 17:53:49 +00:00
.gitignore Add release helper script (#64) 2021-03-17 17:46:21 +00:00
composer.json Add release helper script (#64) 2021-03-17 17:46:21 +00:00
composer.lock Add release helper script (#64) 2021-03-17 17:46:21 +00:00
CONTRIBUTING.md Fix indentation 2021-02-21 13:55:22 +00:00
customized-documentation-schema.txt Automatically generate new releases (#59) 2021-03-12 17:53:49 +00:00
customized-template-stack.txt Automatically generate new releases (#59) 2021-03-12 17:53:49 +00:00
features.txt Append line endings 2021-02-23 16:00:59 +00:00
footnotes.php Add release helper script (#64) 2021-03-17 17:46:21 +00:00
includes.php Sync filenames with SVN repo (#57) 2021-03-04 07:46:19 +00:00
LICENSE Create LICENSE 2021-02-21 07:52:09 +00:00
license.txt Append line endings 2021-02-23 16:00:59 +00:00
README.md Add release helper script (#64) 2021-03-17 17:46:21 +00:00
readme.txt Add release helper script (#64) 2021-03-17 17:46:21 +00:00
SECURITY.md Create SECURITY.md 2021-02-20 20:09:46 +00:00
wpml-config.xml - Add: WPML Config XML file for the string translation plugin 2014-09-03 15:49:40 +00:00

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

  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, if you don't have it already
  4. Install dependencies (composer install)
    • You will have to install php-mbstring manually if you do not already have it.

Code Formatting

  1. Run composer run lint-php to lint all PHP files
  2. Run composer run lint-php:fix to attempt to automatically fix errors and warnings

Releasing

  1. Run composer run release

Building

  1. Run _tools/build-stylesheets.sh -c to concatenate stylesheets
  2. Manually minify the output files in css/tmp/, saving them as .min.css files
  • The intention is to replace this with automated minification, meaning that all of these steps can be rolled into a single build command.
  1. Run _tools/build-stylesheets.sh -d to deploy the minified files to dist/
  • this will delete any existing dist/ folder
  1. Run composer run build to move over the remaining files to dist/
  • 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 .distignore file

Updating Documentation

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

  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!