2021-04-20 02:21:37 +00:00
|
|
|
# footnotes
|
|
|
|
|
|
2021-04-25 08:28:02 +00:00
|
|
|
<!-- markdownlint-disable MD013 -->
|
2021-04-18 20:29:58 +00:00
|
|
|
    
|
|
|
|
|
|
2021-04-28 03:33:35 +00:00
|
|
|
    
|
2021-04-18 20:29:58 +00:00
|
|
|
|
2021-04-30 12:37:50 +00:00
|
|
|
[](https://www.gnu.org/licenses/gpl-3.0)  [](https://github.com/markcheret/footnotes/actions/workflows/ossar-analysis.yml) [](https://github.com/markcheret/footnotes/actions/workflows/lint-code.yml)
|
2021-04-18 19:58:11 +00:00
|
|
|
|
2021-04-28 03:33:35 +00:00
|
|
|
[](http://commitizen.github.io/cz-cli/) [](https://coveralls.io/github/markcheret/footnotes?branch=main)
|
2021-04-25 08:28:02 +00:00
|
|
|
<!-- markdownlint-enable MD013 -->
|
|
|
|
|
|
2021-04-25 20:26:41 +00:00
|
|
|
|
2021-02-21 11:08:04 +00:00
|
|
|
|
2021-04-25 08:28:02 +00:00
|
|
|
**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
|
2021-04-14 22:21:01 +00:00
|
|
|
footnotes will be displayed.
|
2021-02-20 19:18:41 +00:00
|
|
|
|
2021-04-25 08:28:02 +00:00
|
|
|
**footnotes** gives you the ability to display well-formatted footnotes on your
|
2021-04-14 22:21:01 +00:00
|
|
|
WordPress Pages and Posts — those footnotes we know from offline publishing.
|
2021-02-20 19:18:41 +00:00
|
|
|
|
2021-04-18 19:58:11 +00:00
|
|
|
Featured on [wpmudev][wpmudev] — cheers for the review, folks!
|
|
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
## Table of Contents
|
2021-02-20 19:18:41 +00:00
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
* [Features](#features)
|
|
|
|
|
* [Getting Started](#getting-started)
|
|
|
|
|
* [Documentation](#documentation)
|
2021-08-10 18:31:28 +00:00
|
|
|
* [Testing](#testing)
|
2021-04-14 22:21:01 +00:00
|
|
|
* [Acknowledgments](#acknowledgements)
|
|
|
|
|
* [License](#license)
|
|
|
|
|
* [Contact Information](#contact-information)
|
2021-02-20 20:55:46 +00:00
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
## Features
|
2021-02-20 20:55:46 +00:00
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
This Plugin provides:
|
2021-02-21 11:08:04 +00:00
|
|
|
|
2021-04-26 07:31:34 +00:00
|
|
|
* fully-customizable footnote start and end shortcodes;
|
2021-04-25 08:28:02 +00:00
|
|
|
* stylable tooltips supporting hyperlinks and dedicated text;
|
2021-04-26 07:31:34 +00:00
|
|
|
* a responsive reference container, with customisable positioning;
|
2021-04-25 08:28:02 +00:00
|
|
|
* a wide choice of different numbering styles;
|
|
|
|
|
* a freely-configurable and optional backlink symbol;
|
|
|
|
|
* footnote appearance customisation via dashboard settings and custom CSS style
|
2021-04-14 22:21:01 +00:00
|
|
|
rules; and
|
2021-04-25 08:28:02 +00:00
|
|
|
* editor buttons for easily adding shortcode tags.
|
2021-04-14 22:21:01 +00:00
|
|
|
|
|
|
|
|
## Getting Started
|
2021-03-17 17:46:21 +00:00
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
1. Read the [contributing guidelines][contributing];
|
|
|
|
|
1. clone this repository (`git clone git@github.com:markcheret/footnotes.git`):
|
2021-04-25 08:28:02 +00:00
|
|
|
* we recommend that you use [VVV][vvv] for your local testing environment.
|
2021-04-15 14:03:09 +00:00
|
|
|
1. install [Composer][composer] and [NPM][npm]; and
|
2021-04-14 22:21:01 +00:00
|
|
|
1. install all dependencies (`composer install`):
|
2021-04-25 08:28:02 +00:00
|
|
|
* you will have to install `php-mbstring` manually if you do not already
|
2021-04-14 22:21:01 +00:00
|
|
|
have it.
|
2021-08-10 18:31:28 +00:00
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
## Documentation
|
2021-04-25 08:28:02 +00:00
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
View the current docs [here][footnotes-docs].
|
2021-04-25 08:28:02 +00:00
|
|
|
|
2021-04-14 22:21:01 +00:00
|
|
|
## Testing
|
|
|
|
|
|
2021-08-10 18:31:28 +00:00
|
|
|
This repo. uses [PHPUnit](phpunit) to run automated tests. To run the full test
|
|
|
|
|
suite, use `composer run test`.
|
2021-08-10 18:21:17 +00:00
|
|
|
|
|
|
|
|
Test cases are found in the `tests/` directory.
|
|
|
|
|
|
|
|
|
|
PHPUnit settings are available in the file `phpunit.xml`.
|
Automatically generate new releases (#59)
* Adapt after the 2.5.9d1 accident.
* Corrections to changelog.
* Also added @revision and @timestamp PHPDOC tags
@revision and @timestamp used for SVN refs.
Full enumeration of added custom PHPDOC tags:
@accountable, @bib, @biblio, @callback, @commit, @committer, @contributor, @courtesy, @date, @datetime, @lastmodified, @modified, @publisher, @reporter, @revision, @timestamp, @user.Some tags like @reporter and @contributor are more used than others.
* Readme header upgrade.
* Create deploy-to-wordpress.org.yml
* Add distignore
* Comment out `build` command, replace npm with composer
* Remove placeholder comments
* Add build commands
* Fix typo
* Fix version number bug
* Make zip without top-level directory
* Append tag name to plugin zip
* Clean up a bit
* Rename workflow config
* Fix upload paths
* Append tag name to artifact
* Fix paths
* Revert path fix
* Try again
* Add wplm-config.xml to buildfiles
* Fix indentation
* Rename development/csscat.sh to css/csscat.sh
* Rename development/customized-documentation-schema.txt to customized-documentation-schema.txt
* Rename development/customized-template-stack.txt to customized-template-stack.txt
* Version number related fixes before pull request.
* Move csscat script to tools dir
* Rename csscat
* Refactor script
* Update customized-documentation-schema.txt
* Replace empty lines in help output
* Escape empty lines.
* Delete 3 items from `.distignore`
As mentioned, CONTRIBUTING.md and README.md should be included in distributions.
- As an invitation to the Community.
- As a tangible proof of goodwill after the 2.5.9d1 accident.
Also SECURITY.md so Footnotes users see that we’re concerned, and
can reach out without transiting via GitHub.
* Include CONTRIBUTING.md README.md SECURITY.md
* Update sync w/ 5.7 tested.
* Update
* Update composerfiles
Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
2021-03-12 17:53:49 +00:00
|
|
|
|
2021-02-20 19:18:41 +00:00
|
|
|
## Acknowledgements
|
|
|
|
|
|
2021-04-26 07:31:34 +00:00
|
|
|
Huge thanks to every **footnotes** user, contributor, bug reporter, feature
|
2021-04-14 22:21:01 +00:00
|
|
|
requester and fan!
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
This project is licensed under the [GNU GPL v3][gpl-v3].
|
|
|
|
|
|
2021-04-25 08:28:02 +00:00
|
|
|
## Contact Information
|
2021-04-14 22:21:01 +00:00
|
|
|
|
|
|
|
|
| Name | Link(s) |
|
|
|
|
|
|---------------|-----------------------|
|
2021-04-25 08:28:02 +00:00
|
|
|
|Mark Cheret | [Email][mcheret] |
|
2021-04-14 22:21:01 +00:00
|
|
|
|
|
|
|
|
[wpmudev]: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/
|
|
|
|
|
[php]: https://www.php.net/
|
|
|
|
|
[contributing]: https://github.com/markcheret/footnotes/blob/main/CONTRIBUTING.md
|
|
|
|
|
[vvv]: https://varyingvagrantvagrants.org/
|
|
|
|
|
[composer]: https://getcomposer.org/download/
|
2021-04-15 14:03:09 +00:00
|
|
|
[npm]: https://www.npmjs.com/
|
2021-04-14 22:21:01 +00:00
|
|
|
[wpcs-php]: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/
|
|
|
|
|
[phpcs]: https://github.com/squizlabs/PHP_CodeSniffer
|
|
|
|
|
[wpcs-js]: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/
|
|
|
|
|
[wpcs-css]: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/css/
|
2021-04-15 02:20:38 +00:00
|
|
|
[prettier]: https://prettier.io/
|
|
|
|
|
[eslint]: https://eslint.org/
|
|
|
|
|
[stylelint]: https://stylelint.io/
|
2021-08-10 18:21:17 +00:00
|
|
|
[phpunit]: https://phpunit.de/
|
2021-04-14 22:21:01 +00:00
|
|
|
[phpdocumentor]: https://phpdoc.org/
|
|
|
|
|
[footnotes-docs]: https://markcheret.github.io/footnotes/
|
|
|
|
|
[gpl-v3]: https://www.gnu.org/licenses/gpl-3.0.en.html
|
|
|
|
|
[mcheret]: mailto:mark@cheret.de
|
