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.
353 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
pewgeuges 422a6d1fa2 File level headings in class/layout/. 
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.
2021-02-25 14:22:07 +01:00
.github/ISSUE_TEMPLATE Update issue templates 2021-02-20 18:47:11 +00:00
_tools Update codebase to be WP Coding Standard-compliant. 2021-02-23 16:44:18 +00:00
class File level headings in class/layout/. 2021-02-25 14:22:07 +01:00
contrib Update codebase to be WP Coding Standard-compliant. 2021-02-23 16:44:18 +00:00
css Append line endings 2021-02-23 16:00:59 +00:00
development
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 Append line endings 2021-02-23 16:00:59 +00:00
languages
templates Convert script to snake_case 2021-02-24 23:14:56 +01:00
.gitignore Update codebase to be WP Coding Standard-compliant. 2021-02-23 16:44:18 +00:00
composer.json Update codebase to be WP Coding Standard-compliant. 2021-02-23 16:44:18 +00:00
composer.lock Commit composer lockfile 2021-02-23 17:16:15 +00:00
CONTRIBUTING.md Fix indentation 2021-02-21 13:55:22 +00:00
features.txt Append line endings 2021-02-23 16:00:59 +00:00
footnotes.php Add @package tag to header 2021-02-24 08:51:24 +00:00
includes.php Update codebase to be WP Coding Standard-compliant. 2021-02-23 16:44:18 +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 Clarify double-wildcard instructions 2021-02-23 17:58:26 +00:00
readme.txt Update readme.txt item reflected in class.init.php 2021-02-23 20:33:14 +01:00
SECURITY.md Create SECURITY.md 2021-02-20 20:09:46 +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 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 development environment
  1. Install Composer, if you don't have it already
  2. Install dependencies (composer install)
  3. Create a new branch from main (git checkout -b <your-descriptive-branch-name>)
  4. 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 -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 with phpcs disable:<sniff code> — MAKE SURE THAT YOU HAVE phpcs 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)

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!