Commit graph

240 commits

Author SHA1 Message Date
1284544556 refactor: remove Hungarian notation and MCI prefixes
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
2021-04-16 23:55:05 +01:00
3af81c01b9 refactor: rename Hooks, update docblocks 2021-04-16 23:17:07 +01:00
571b6bf74f fix: correct plugin settings link 2021-04-16 21:50:24 +01:00
b18e331684 refactor: rename colourpicker eclass 2021-04-16 21:50:02 +01:00
f010c175ed refactor: move Plugin settings under general settings menu 2021-04-16 03:11:24 +01:00
6b42f12716 refactor: delete now-unused files 2021-04-16 03:11:24 +01:00
fd89026326 refactor: remove /class/layout dir (for now)
This dir has been kicking around for a while as a holdover
from the big codebase standardisation. There's no point
keeping the dupe files for now, but I'll come back to this
again later.
2021-04-16 03:11:24 +01:00
9926a42e8c style: lint code 2021-04-16 01:23:33 +01:00
a5356d8052 fix: other assorted fixes 2021-04-15 17:17:27 +01:00
b565a56a05 fix: replace apostrophes 1/2 2021-04-15 17:11:37 +01:00
11c2af6f9c fix: correct constant name 2021-04-15 17:07:55 +01:00
d201d7e705 docs: remove timestamps 2021-04-15 17:07:04 +01:00
e867ea69d1 re-add /dashboard dir 2021-04-15 17:03:46 +01:00
5b07c17356 Merge branch 'main' into svn-sync 2021-04-15 16:52:59 +01:00
ebb76dd1de Add temp file 2021-04-15 16:30:35 +01:00
3a547af222 Rename dashboard/ to layout/. 2021-04-15 15:30:21 +00:00
98d1255f57 Add temp file 2021-04-15 15:30:21 +00:00
63a388ba29 Rename dashboard files 2021-04-15 15:30:21 +00:00
27d3e6269e
chore: remove date info (#94)
* chore: remove @lastmodified tags

* chore: remove @date tags

* chore: remove timestamps

* chore: remove timestamps

* chore: minor formatting fixes
2021-04-15 05:09:23 +01:00
pewgeuges
a02cdacb7f Release urgent feature 2.7.0 in response to request from user @grflukas.
https://wordpress.org/support/topic/multiple-reference-containers-in-single-post/
Bundled with two bugfixes.
https://github.com/markcheret/footnotes/issues/65
https://github.com/markcheret/footnotes/issues/71
Last release directly to SVN.
= 2.7.0 =
- Adding: Reference container: optionally per section by shortcode, thanks to @grflukas issue report.
- Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report.
- Bugfix: Dashboard: debug the 'Quick start guide' tab, thanks to @rumperuu bug report.

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2515217 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-04-14 23:10:29 +00:00
eb34f30880 fix: correct relative filepaths 2021-04-14 22:52:56 +01:00
b824a44541 style: rename production flag variable
Renames the current production flag variable to be shorter,
non-Hungarian (presaging changes to come in #35) and not specifically
CSS_-related.

See #80
2021-04-14 22:47:44 +01:00
e76a4e0bb1 fix: add separate prod/dev cache-busters 2021-04-14 22:39:16 +01:00
35d8b82008
chore: fix character misencodings (#78)
Various characters had been replaced by â€s.

Fix #77
2021-04-14 17:27:15 +01:00
pewgeuges
dc225809ba - Release urgent bugfix v2.6.6
- 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
2021-04-13 08:18:07 +00:00
50115fb6c9
fix: fix bug that caused footnotes to not be processed (#75) 2021-04-12 21:10:23 +01:00
0c75e12a99 fix: fix call to renamed function 2021-04-10 20:35:36 +01:00
5d89b371dc fix: fix errors introduced in merge 2021-04-10 20:26:30 +01:00
7ddac313bd Merge branch 'main' into svn-update 2021-04-10 20:02:10 +01:00
2dc096f1f6 Rename dashboard/ to layout/. 2021-04-10 19:27:53 +01:00
3d8719f653 Add temp file 2021-04-10 19:27:53 +01:00
00556c1c84 Rename dashboard files 2021-04-10 19:27:53 +01:00
pewgeuges
e49bb9e257 Release urgent bugfix v2.6.5 (Stable Tag 2.6.5).
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
2021-04-01 06:48:43 +00:00
pewgeuges
3aa88229e0 Bugfix 2.6.4 stable Tag 2.6.4.
= 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
2021-03-31 13:29:10 +00:00
pewgeuges
ca3335e63c Release bugfix v2.6.3 Stable Tag 2.6.3.
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
2021-03-31 00:49:17 +00:00
pewgeuges
91fc02de88 2.6.3d0 with Stable Tag 2.6.0.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2505727 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-03-30 07:50:44 +00:00
pewgeuges
a6a1a67b00 Unreleased urgent bugfix v2.6.2 with Stable Tag 2.6.0.
Needed for https://wordpress.org/support/topic/problem-with-footnotes-in-excerpts-of-the-blog-page/
= 2.6.2 =
- Bugfix: Excerpts: debug the 'No' option by generating excerpts from scratch without footnotes, thanks to @nikelaos @markcheret @martinneumannat bug reports.
- Bugfix: Tooltips: Continue reading: debug link for AMP compatibility mode.

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2504730 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-03-28 12:41:33 +00:00
pewgeuges
258e3c6070 Unreleased bugfix v2.6.1 with Stable Tag 2.6.0.
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
2021-03-27 06:10:08 +00:00
pewgeuges
380a309ad3 Release 2.6.0, new Stable Tag 2.6.0 as using unreleased though tagged versions may not meet an organization’s security requirements.
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
2021-03-25 15:02:17 +00:00
pewgeuges
5281825e51 Debug shortcode setting v2.5.15 unreleased with Stable Tag 2.5.10.
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
2021-03-25 10:47:35 +00:00
pewgeuges
35b2611500 Update unreleased bugfix v2.5.14 with Stable Tag 2.5.10.
Urgent response to https://wordpress.org/support/topic/footnotes-content-number-not-sequential/
Correct class/dashboard/subpage-main.php
Correct templates/dashboard/settings-start-end.html
= 2.5.14 =
- Bugfix: Footnote delimiter short codes: fix numbering bug by cross-editor HTML escapement schema harmonization, thanks to @patrick_here @alifarahani8000 @gova bug reports.
- Update: Dashboard: General settings: Footnote start and end short codes: delete comment on pointy brackets.

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2502990 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-03-25 03:22:15 +00:00
pewgeuges
123db83af4 Unreleased bugfix v2.5.14 with Stable Tag 2.5.10.
Urgent response to https://wordpress.org/support/topic/footnotes-content-number-not-sequential/
= 2.5.14 =
- Bugfix: Footnote delimiter short codes: fix numbering bug by cross-editor HTML escapement schema harmonization, thanks to @patrick_here @alifarahani8000 @gova bug reports.
- Update: Dashboard: General settings: Footnote start and end short codes: delete comment on pointy brackets.

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2502988 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-03-25 03:07:17 +00:00
pewgeuges
0dc4c08dd8 Unreleased bugfix v2.5.13 with Stable Tag 2.5.10.
= 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
2021-03-24 21:19:07 +00:00
pewgeuges
9e8e28412e Urgent unreleased bugfix version 2.5.12 with Stable Tag 2.5.10.
= 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
2021-03-23 04:02:07 +00:00
pewgeuges
ce42420149 Stable Tag remains 2.5.10 as this urgent bugfix v2.5.11 is tagged while 2.6.0 isn’t ready yet.
= 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
2021-03-21 19:19:04 +00:00
pewgeuges
c93e6ff28d 2.5.11d7 with the new settings.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2500244 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-03-20 20:48:54 +00:00
pewgeuges
7aa9d8803f Urgent bugfix development 2.5.11d5 with ST 2.5.10.
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
2021-03-19 23:58:23 +00:00
pewgeuges
41676ea716 2.5.6d7 added 4 missing templates for AMP compat.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2498893 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-03-18 18:00:42 +00:00
pewgeuges
ccb73fd421 Accessibility added, v2.6.0d6 (S.T. 2.5.10).
= 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
2021-03-18 10:53:57 +00:00
0a34e96450
Add release helper script (#64)
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>
2021-03-17 17:46:21 +00:00