* docs: split changelog into separate file
See #137
* docs: add information to Plugin header
Fix#138
* docs: update WP readme
* docs: remove FAQs
* docs: remove installation instructions
These were causing the FAQ section to render incorrectly
when viewed in the [preview validator][validator].
Also, the [WP Plugin Handbook][wp-handbook] says that:
> If your plugin has no custom install settings, it's
> okay to omit this section.
[validator]: https://wpreadme.com/
[wp-handbook]: https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#installation
* docs: update links, versions, add extra changelog items
* docs: lower version to stable ver
I had to use some RegEx-fu for this. Specifically:
```bash
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/\(p\|l\|a\)_\(str\|bool\|int\|obj\|flo\|arr\)_//g' {} \;
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/MCI_Footnotes/Footnotes/g' {} \;
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/C_\(INT\|STR\|FLO\)_//g' {} \;
```
This should have covered all the bases.
In my testing I encountered one error caused by these changes.
In the `add_select_box` function in `/class/dashboard/layout.php`,
there was a function parameter called `$p_arr_options` and a variable
called `$l_str_options`. Removing the Hungarian notation caused an
error as these two variables were both now called `$options`.
This has been fixed, and I like to think that that will have been
the only naming conflict, but I think it is more likely that there
maybe others. Further testing is required before I am happy calling
this release-ready.
Close#34, progress #36
Renames the current production flag variable to be shorter,
non-Hungarian (presaging changes to come in #35) and not specifically
CSS_-related.
See #80
- Delete temporary tag 2.5.13.1
= 2.6.6 =
- Bugfix: Process: fix issue that caused some footnotes to not be processed, thanks to @docteurfitness @rkupadhya @offpeakdesign bug reports.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2513893 b8457f37-d9ea-0310-8a92-e5e31aec5664
Also add a temporary tag for another bugfix.
= 2.6.5 =
- Bugfix: Editor buttons: debug button by reverting name change in PHP file while JS file and HTML template remained unsynced, thanks to @gova bug report.
- Bugfix: Hooks: default-disable the_excerpt hook with respect to theme-specific excerpt handling, thanks to @mmallett bug reports.
= 2.5.13.1 =
- Bugfix: Backlinks: remove the 'event.stopPropagation()' call in scroll-down function.
Note: This bug is fixed in mainstream and is here only available temporarily while one known installation keeps using v2.5.13.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2507205 b8457f37-d9ea-0310-8a92-e5e31aec5664
= 2.6.4 =
- Bugfix: Process: remove trailing comma after last argument in multiline function calls for PHP < 7.3, thanks to @scroom bug report.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2506751 b8457f37-d9ea-0310-8a92-e5e31aec5664
Overdue bugfix, cannot be delayed.
Also the project has to demonstrate it’s still ready to **release** bugfixes.
Per SemVer the minor version number cannot be incremented for the below.
= 2.6.3 =
- Bugfix: Reference container: debug footnotes number text color in the table header cells required for accessibility, thanks to @spaceling bug report.
- Bugfix: Excerpts: debug the 'Yes' option by generating excerpts with footnotes on the basis of the posts, thanks to @nikelaos @martinneumannat bug reports.
- Bugfix: Reference container: debug span elements in backlinks by removing 'event.stopPropagation()' from jQuery scroll down function, thanks to @lolzim bug report.
- Update: Excerpts: set the default value of the debugged 'Footnotes in excerpts' setting to Yes.
- Update: Excerpts: enable the hook 'the_excerpt' by default to make the debugged 'Footnotes in excerpts' setting effective.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2506333 b8457f37-d9ea-0310-8a92-e5e31aec5664
Needed to share in a Forum topic where the problem came up incidentally.
Must also be shared in the Forum topic of the related bug report.
This also contains an escapement reversal (without known incidence on the plugin’s behavior).
= 2.6.1 =
- Bugfix: Tooltips: Styling: Font color: set to black for maximum contrast with respect to white default background, thanks to 4msc bug report.
- Bugfix: Tooltips: Styling: Background color: set default value back to white because empty doesn’t work out as expected.
= Branches =
Delete the staging branch.
Rationale:
- It is outdated an cannot be used for staging any more.
- It had been made improperly on its own instead of copying from trunk/.
- It is undue for the following reasons:
- Staging release processes here is too dangerous.
- Staging release processes here is too little effective.
Staging must not take place in this repository but in another SVN instance.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2504324 b8457f37-d9ea-0310-8a92-e5e31aec5664
On the basis of 2.5.15.
= 2.6.0 =
- Adding: Reference container: get expanding and collapsing to work also in AMP compatibility mode, thanks to @westonruter code contribution.
- Adding: Tooltips: make display work purely by style rules for AMP compatibility, thanks to @milindmore22 code contribution.
- Bugfix: Tooltips: AMP tooltips: enable accessibility by keyboard navigation, thanks to @westonruter code contribution.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2503360 b8457f37-d9ea-0310-8a92-e5e31aec5664
Needs to be shared on the Forum as a follow-up ASAP in several threads.
This is another bug introduced while linting the codebase after 2.5.10.
= 2.5.15 =
- Bugfix: Dashboard: General settings: Footnote start and end short codes: debug select box for shortcodes with pointy brackets.
- Update: Dashboard: General settings: Footnote start and end short codes: add information about pointy brackets.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2503174 b8457f37-d9ea-0310-8a92-e5e31aec5664
= 2.5.13 =
- Bugfix: Dashboard: Backlink symbol: debug select box by reverting identity check to equality check, thanks to @lolzim bug report.
- Bugfix: Footnote delimiter short codes: debug closing pointy brackets in the Block Editor by accounting for unbalanced HTML escapement.
- Update: Dashboard: General settings: Footnote start and end short codes: update information about short codes using pointy brackets.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2502882 b8457f37-d9ea-0310-8a92-e5e31aec5664
= 2.5.12 =
- Update: Scrolling: CSS-based smooth scroll behavior (optional), thanks to @paulgpetty and @bogosavljev issue reports.
- Bugfix: Backlinks: reflect scroll functions down/up differentiation across the template set, thanks to @bogosavljev bug report.
- Bugfix: Referrers: Hard links: enforce scroll offset with '!important' property for surroundings specifying otherwise, thanks to @bogosavljev bug report.
- Bugfix: Forms: prevent inadvertently toggling input elements with footnotes in their label, by optionally moving footnotes after the end of the label.
- Bugfix: Forms: prevent inadvertently toggling input elements with footnotes in their label, by optionally disconnecting those labels.
- Bugfix: Scroll offset: correct syntax error in the main style sheet.
- Bugfix: Reference container: correct new syntax errors in the 8 reference container row templates.
- Bugfix: Reference container: correct a new typo in the JavaScript reference container template.
- Update: Dashboard: General settings: split a dedicated 'URL fragment ID configuration' metabox off the 'Scrolling behavior' metabox.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2501451 b8457f37-d9ea-0310-8a92-e5e31aec5664
= 2.5.11 =
- Bugfix: Forms: remove footnotes from input field values, thanks to @bogosavljev bug report.
- Bugfix: Reference container: apply web semantics to improve readability for assistive technologies, thanks to @derivationfr issue report and code contribution.
- Bugfix: Tooltips: Styling: Background color: empty default value to adopt theme background, thanks to 4msc bug report.
- Bugfix: Dashboard: debug text input fields by disabling quotation mark escapement, thanks to @rumperuu code contribution in the standards compliance overhaul.
- Update: Documentation: Readme.txt: comment line below the 'Stable Tag' field to warn that this field is (unintuitively) parsed for release configuration.
- Update: Documentation: Readme.txt: informative 'Version' field in sync with 'Version' in 'footnotes.php' for bugfix versions available ahead of the Stable Tag.
- Update: Documentation: Readme.txt: informative 'Package Version' field in sync with the 'Package V.' field added in the 'footnotes.php' file header.
- Update: Codebase: make PHP code comply to WordPress PHP Coding Standards requirements, thanks to @rumperuu code contribution and refactoring.
- Bugfix: Forms: mitigate the adverse effect of clicking footnote referrers in labels of input elements by an optional, configurable scroll down delay.
- Bugfix: Scroll durations: mitigate the downside of delayed scrolling down by optionally enabling asymmetric scroll durations (e.g. fast down, slower up).
- Update: Scroll delays: add a setting to configure also a scroll up delay for completeness.
- Bugfix: Tooltips: Styling: protect padding against removal in surroundings with explicit zero padding.
- Bugfix: Tooltips: Display: CSS transitions: fix syntax error.
- Update: Documentation: help and support for contributors by the means of Contributing Guidelines in 'CONTRIBUTING.md', thanks to @rumperuu code contribution.
- Update: Documentation: additional readme in markdown format 'README.md' for use with the code repository on GitHub, thanks to @rumperuu code contribution.
- Update: Documentation: move 'customized-template-stack.txt' and 'customized-documentation-schema.txt' from the 'development/' folder to root.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2500516 b8457f37-d9ea-0310-8a92-e5e31aec5664
On top of 2.6.0d7.
Debugs Footnotes for all input field values with footnotes coming in from field label.
Preparing unreleased tagged v2.5.11 in response to Forum support request.
Accessibility fixes and AMP compat enhancements not fully debugged yet, draft only.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2499807 b8457f37-d9ea-0310-8a92-e5e31aec5664
= Reference container semantics for assistive technology =
- Table header elements with row scope in the first column.
- Table caption invisible to sighted users but required for screen readers.
= Referrer accessibility =
- jQuery referrers are accessible but don’t show the tooltips on focus.
- AMP compatible tooltips show up on focus on navigatable referrers.
- Alternative tooltips now accessible on focus on now navigatable referrers.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2498648 b8457f37-d9ea-0310-8a92-e5e31aec5664
This commit adds a release helper script, amongst other workflow improvements.
See `README.md` for instructions, and `_tools/release.sh` for the script itself.
This script:
1. sanity-checks the various version tags;
2. triggers a Plugin build;
3. flags the new version as pre-release;
4. tags the version in Git;
5. creates a local working copy of the SVN repo;
6. copies the new release to the local `trunk/` (whilst keeping the ‘Stable Tag’ field in `readme.txt` pointing to the previous stable version);
7. copies the commit message from the changelog in `readme.txt`; and
8. (if a flag is set) commits the changes to the remote `trunk/`.
Pushing out a new release must still be done manually, once `trunk/` is tested and working. To do so, check out a local copy of `trunk/` and:
1. update the ‘Stable Tag’ field in `trunk/readme.txt` to the new version;
2. update the ‘Version’ field in the comment header of `trunk/footnotes.php` to the new version;
3. remove the ‘p’ from the end of the ‘version’ tag in the `getInfo()` function at the bottom of `js/wsiwyg-editor.js`;
4. copy a new tag for the release from `trunk/` (`svn cp trunk tags/<version number>`); and
5. commit your changes (`svn ci -m "Release version <version number>"`).
The WP Plugin Directory will automatically parse the ‘Stable Tag’ field in `trunk/readme.txt`, and inform users that a new version is available.
At various stages user input is required to validate information. This is not ready for automation with GitHub Actions, but is a useful step on the way — see [this piece](https://blog.danslimmon.com/2019/07/15/do-nothing-scripting-the-key-to-gradual-automation/) for more info.
Unless a `-c` flag is passed (e.g., by running `composer run release:commit`) no changes will take place on the remote SVN repo. If you want to test this out on a branch other than `main`, uncomment lines 31 & 52 of the script.
Version checking enforces the versioning rules stated [here](https://github.com/markcheret/footnotes/wiki/Versioning).
**NB: I have not tested the `-c` mode yet, as I wanted people will more familiarity with the SVN to have a look at it before I risked making any changes and blowing everything up.**
Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
Tooltip fade-in/fade-out now works in AMP and everything is functional,
except scroll animation because animated scrolling in AMP has only 3 positions.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2498089 b8457f37-d9ea-0310-8a92-e5e31aec5664
Bugs are now fixed except fade-in/fade-out.
Hopefully we’ll meet the looming deadline.
Thanks for testing and I’ll be reaching out to AMP-WP, in issue #48 to begin with.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2497475 b8457f37-d9ea-0310-8a92-e5e31aec5664
Hopefully we’ll meet the looming deadline.
Thanks for testing and I’ll be reaching out to AMP-WP, in issue #48 to begin with.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2497474 b8457f37-d9ea-0310-8a92-e5e31aec5664
Stable Tag is 2.5.10. v2.6.0d0 does already exist on SVN (2456650 2021-01-14).
Tooltip timing settings are not yet usable in AMP mode.
Tooltip transitions don’t work now, only delays, need to debug.
It’s late and we have a deadline, so this is committed as a preview.
Thanks for looking into it.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2497297 b8457f37-d9ea-0310-8a92-e5e31aec5664
Delta version 2.5.11d4; Stable Tag: 2.5.10.
No changes but sorting by version number.
This makes sure that other changes coming after will be traceable in SVN.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2496283 b8457f37-d9ea-0310-8a92-e5e31aec5664
Delta version 2.5.11d3.
Before sorting constants in settings.php by version number (@since tag).
The next commit is dedicated to moving constants and their docblocks in settings.php.
This replaces most of the list items in the file level docblock.
Moving blocks of code breaks traceability of changes, so it’s usually avoided.
WordPress plugins are supposed to maintain traceability in the SVN repo, which implies keeping changesets meaningful.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2496275 b8457f37-d9ea-0310-8a92-e5e31aec5664
* Update author URIs from `cheret.de` to `cheret.org`.
* Update missed version number in `wysiwyg.js` from 2.1.6 to 2.5.10.
Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
branches/staging/ is most up-to-date: 2.5.11d2.
Per WordPress guideline, “trunk/ should contain the latest version of your code, even if that version is a beta.”
See https://developer.wordpress.org/plugins/wordpress-org/how-to-use-subversion/#use-the-trunk-folder-for-code
= Moved files =
Two documentation files are moved from development/ to the root folder:
- customized-template-stack.txt
- customized-documentation-schema.txt
= Deleted files and folders =
Part of the tooling and the duplicate license were mistakenly included and are now removed from distribution:
- development/csscat.sh
- contrib/pre-commit
- composer.json
- composer.lock
- LICENSE
The comments shall be updated accordingly.
development/csscat.sh is now _tools/build-stylesheets.sh, available in Footnotes’ GitHub repo.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2495062 b8457f37-d9ea-0310-8a92-e5e31aec5664
* Update supported WP version to 5.7
* Update package version
* Add Package Version in MAIN.php
* Change version number labels.
* Obfuscate 'Version' string in label.
The way these headers are parsed, best is to make sure that
the string 'Version' doesn’t occur in another field label.
Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
@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.
