Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #61 from markcheret/fixcomments

Browse source 
Version number related fixes for now.
This commit is contained in:
Ben Goldsworthy 2021-03-11 09:18:14 +00:00 committed by GitHub
commit ebdb68969b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 119 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
class/dashboard/layout.php
View file

@ -213,11 +213,11 @@ abstract class MCI_Footnotes_Layout_Engine {
*/ */
if ( C_BOOL_CSS_PRODUCTION_MODE === true ) { if ( C_BOOL_CSS_PRODUCTION_MODE === true ) {
wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.min.css' ), array(), C_STR_FOOTNOTES_VERSION ); wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.min.css' ), array(), C_STR_PACKAGE_VERSION );
} else { } else {
wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.css' ), array(), C_STR_FOOTNOTES_VERSION ); wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.css' ), array(), C_STR_PACKAGE_VERSION );
} }

12
class/init.php
View file

@ -306,7 +306,7 @@ class MCI_Footnotes {
* Plugin version number is needed for busting browser caches after each plugin update. * Plugin version number is needed for busting browser caches after each plugin update.
* @since 2.1.4 automate passing version number for cache busting. * @since 2.1.4 automate passing version number for cache busting.
* @date 2020-11-30T0646+0100 * @date 2020-11-30T0646+0100
* The constant C_STR_FOOTNOTES_VERSION is defined at start of footnotes.php. * The constant C_STR_PACKAGE_VERSION is defined at start of footnotes.php.
* *
* The media scope argument 'all' is the default. * The media scope argument 'all' is the default.
* No need to use '-css' in the handle, as this is appended automatically. * No need to use '-css' in the handle, as this is appended automatically.
@ -350,7 +350,7 @@ class MCI_Footnotes {
MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/footnotes-' . $l_str_tooltip_mode_short . 'ttbrpl' . $l_str_layout_mode . '.min.css' MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/footnotes-' . $l_str_tooltip_mode_short . 'ttbrpl' . $l_str_layout_mode . '.min.css'
), ),
array(), array(),
C_STR_FOOTNOTES_VERSION, C_STR_PACKAGE_VERSION,
'all' 'all'
); );
@ -364,9 +364,9 @@ class MCI_Footnotes {
* *
* This optional layout fix is useful by lack of layout support. * This optional layout fix is useful by lack of layout support.
*/ */
wp_enqueue_style( 'mci-footnotes-common', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-common.css' ), array(), C_STR_FOOTNOTES_VERSION ); wp_enqueue_style( 'mci-footnotes-common', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-common.css' ), array(), C_STR_PACKAGE_VERSION );
wp_enqueue_style( 'mci-footnotes-tooltips', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips.css' ), array(), C_STR_FOOTNOTES_VERSION ); wp_enqueue_style( 'mci-footnotes-tooltips', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips.css' ), array(), C_STR_PACKAGE_VERSION );
wp_enqueue_style( 'mci-footnotes-alternative', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips-alternative.css' ), array(), C_STR_FOOTNOTES_VERSION ); wp_enqueue_style( 'mci-footnotes-alternative', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips-alternative.css' ), array(), C_STR_PACKAGE_VERSION );
$l_str_page_layout_option = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT ); $l_str_page_layout_option = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT );
if ( 'none' !== $l_str_page_layout_option ) { if ( 'none' !== $l_str_page_layout_option ) {
@ -376,7 +376,7 @@ class MCI_Footnotes {
MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-layout-' . $l_str_page_layout_option . '.css' MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-layout-' . $l_str_page_layout_option . '.css'
), ),
array(), array(),
C_STR_FOOTNOTES_VERSION, C_STR_PACKAGE_VERSION,
'all' 'all'
); );
} }

8
development/customized-documentation-schema.txt
View file

@ -1,5 +1,5 @@
customized-documentation-schema.txt customized-documentation-schema.txt
@lastmodified 2021-02-15T2022+0100 @lastmodified 2021-03-05T0501+0100
Plugin Footnotes for WordPress, v2.5.4 and later Plugin Footnotes for WordPress, v2.5.4 and later
@ -255,10 +255,12 @@ MISSING TAGS:
@modified @modified
@publisher @publisher
@reporter @reporter
@revision
@timestamp
@user @user
▲ Config (original, missing and added tags), example of VS Code ▲ Config (original, missing and added tags), example of VS Code.
/usr/share/code/resources/app/extensions/php/syntaxes/php.tmLanguage.json /usr/share/code/resources/app/extensions/php/syntaxes/php.tmLanguage.json
original: original:
@ -274,4 +276,4 @@ PHPStan:
|extends|implements|template |extends|implements|template
custom: custom:
|accountable|bib|biblio|callback|commit|committer|contributor|courtesy|date|datetime|lastmodified|modified|publisher|reporter|user |accountable|bib|biblio|callback|commit|committer|contributor|courtesy|date|datetime|lastmodified|modified|publisher|reporter|revision|timestamp|user

108
footnotes.php
View file

@ -14,31 +14,101 @@
*/ */
/** /**
* Version number for stylesheet cache busting. * Package Version number for stylesheet cache busting.
*
* Please keep this constant in sync with the Version in the header above,
* and also in sync with the Package Version in the header of the readme.
* DO NOT SYNC THE STABLE TAG VALUE WITH THE PACKAGE VERSION VALUE.
* *
* @since 2.1.4 * @since 2.1.4
* @since 2.5.3 (Hungarian) * @since 2.5.3 (Hungarian)
* @var str * @var str
* @lastmodified 2021-03-04T0526+0100 * @lastmodified 2021-03-11T0623+0100
*/ */
define( 'C_STR_FOOTNOTES_VERSION', '2.5.11d1' ); define( 'C_STR_PACKAGE_VERSION', '2.5.11d1' );
/* /**
LICENSE NOTICE * Version numbers in a WordPress plugin readme.txt header.
*
This program is free software; you can redistribute it and/or modify * - Adding: Documentation: Readme.txt: informative 'Package Version' field in sync with the package version currently hidden in the main PHP script header.
it under the terms of the GNU General Public License, version 3, as * - Adding: Documentation: Readme.txt: informative 'Tagged Version' field pointing a tag folder in SVN for bugfix versions available ahead of the stable tag.
published by the Free Software Foundation. * - Adding: Documentation: Readme.txt: comment line below the 'Stable Tag' field to warn that this is (unexpectedly) parsed for release configuration.
*
This program is distributed in the hope that it will be useful, * @since 2.5.11
but WITHOUT ANY WARRANTY; without even the implied warranty of * @see readme.txt
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * @link https://meta.trac.wordpress.org/ticket/5652
GNU General Public License for more details. *
* Package Version Actual version string.
You should have received a copy of the GNU General Public License * May identify a development version.
along with this program; if not, write to the Free Software * A 'd' series is suffixed to incremented bugfix version.
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
*/ * Tagged Version Refers to the latest tag.
* Typically the best available version.
* May not be released, due to release frequency concerns.
*
* Stable Tag Parsed in trunk/ for release configuration.
* Must not be greater than the Version in MAIN.php header.
*
* WordPress plugin readmes are usually lacking the version number of the package.
* In Footnotes, this has been included after the stable tag had been mistaken for
* the package version, given that state-of-the-art readmes have that information.
*
* - Bugfix: Codebase: revert to 2.5.8, thanks to @little-shiva @watershare @adjayabdg @staho @frav8 @voregnev @dsl225 @alexclassroom @a223123131 @codldmac bug reports.
*
* @version 2.5.10 (reversion to @version 2.5.8)
* @revision 2483464
* @timestamp 2021-03-01 11:09:29 +0000
* @link https://plugins.trac.wordpress.org/changeset/2483464/footnotes/trunk
*
* @reporter @little-shiva
* @link https://wordpress.org/support/topic/footnotes-broke-two-of-my-client-sites/
*
* @reporter @watershare
* @link https://wordpress.org/support/topic/latest-update-broke-my-site-19/
*
* @reporter @adjayabdg
* @link https://wordpress.org/support/topic/latest-update-broke-my-site-19/#post-14115531
*
* @reporter @staho
* @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/
*
* @reporter @frav8
* @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115614
*
* @reporter @voregnev
* @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115632
*
* @reporter @dsl225
* @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115820
*
* @reporter @alexclassroom
* @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115860
*
* @reporter @a223123131
* @link https://wordpress.org/support/topic/version-2-5-9d1-breaks-wp-down/#post-14115906
* @link https://wordpress.org/support/topic/update-breaks-layout-3/
* @link https://wordpress.org/support/topic/bugs-in-every-2nd-update/#post-14116804
*
* @reporter @codldmac
* @link https://wordpress.org/support/topic/crashed-my-site-104/
*
* The accidental release of 2.5.9d1 was due to 3 factors:
*
* 1. The codebase got overhauled for the sake of WordPress Coding Standards compliance,
* one requirement of which is that files be named after the name of the class in them;
* 2. The renamed folder was not added to Subversion version control due to an unexpected
* unfamiliarity with the system and its command line interface;
* 3. The Stable Tag field in the Readme header was used for the package version because
* the related field is lacking, and the use of file headers for release configuration
* is uncommon.
*
* @link https://wordpress.org/support/topic/2-5-10-reverts-2-5-9d1-and-apologies/
* @link https://wordpress.org/support/topic/2-5-10-reverts-2-5-9d1-and-apologies/#post-14119440
* @link https://github.com/markcheret/footnotes/issues/55
* @link https://meta.trac.wordpress.org/ticket/5645
* @link https://wordpress.org/plugins/readme.txt
* @link https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/
*/
/** /**
* Plugin’s main PHP file. * Plugin’s main PHP file.

25
readme.txt
View file

@ -4,9 +4,12 @@ Tags: footnote, footnotes, bibliography, formatting, notes, Post, posts, referen
Requires at least: 3.9 Requires at least: 3.9
Tested up to: 5.6.1 Tested up to: 5.6.1
Requires PHP: 5.6 Requires PHP: 5.6
Package Version: 2.5.11d1
Tagged Version: 2.5.10
Stable Tag: 2.5.10 Stable Tag: 2.5.10
CAUTION: THE S. T. FIELD IS PARSED FOR RELEASE CONFIGURATION.
License: GPLv3 or later License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html License URI: https://www.gnu.org/licenses/gpl-3.0.html
== Description == == Description ==
@ -19,7 +22,7 @@ https://www.youtube.com/watch?v=HzHaMAAJwbI
**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts — those footnotes we know from offline publishing. **footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts — those footnotes we know from offline publishing.
= Main Features = = Main Features =
- Fully customizable **footnotes** start and end shortcodes; - Fully customizable **footnote** start and end shortcodes;
- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text; - Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text;
- Responsive *Reference Container* at the end or positioned by shortcode; - Responsive *Reference Container* at the end or positioned by shortcode;
- Display the **footnotes** *Reference Container* inside a Widget; - Display the **footnotes** *Reference Container* inside a Widget;
@ -78,14 +81,20 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest**
== Changelog == == Changelog ==
= 2.5.11 = = 2.5.11 =
- Bugfix: Dashboard: unescape quotation marks in Custom CSS text area and input boxes, thanks to @rumperuu code contribution. - Adding: Documentation: Readme.txt: comment line below the 'Stable Tag' field to warn that this is (unexpectedly) parsed for release configuration.
- Update: Codebase: compliance to WordPress Coding Standards, thanks to @rumperuu code contribution. - Adding: Documentation: Readme.txt: informative 'Tagged Version' field pointing a tag folder in SVN for bugfix versions available ahead of the stable tag.
- Adding: Documentation: additional readme in markdown format for use with GitHub, thanks to @rumperuu code contribution. - Adding: Documentation: Readme.txt: informative 'Package Version' field in sync with the package version currently hidden in the main PHP script header.
- Adding: Documentation: help and support for individual contributors through Contributing Guidelines, thanks to @rumperuu code contribution. - Bugfix: Dashboard: debug text input fields by disabling quotation mark escapement, thanks to @rumperuu code contribution during the codebase conformance overhaul.
- Update: Codebase: make all PHP code comply to WordPress Coding Standards requirements, thanks to @rumperuu code contribution and refactoring.
- Adding: Documentation: additional readme in markdown format 'README.md' for use with GitHub, thanks to @rumperuu code contribution.
- Adding: Documentation: help and support for contributors by the means of Contributing Guidelines 'CONTRIBUTING.md', thanks to @rumperuu code contribution.
- Adding: Development: pre-commit hook for WordPress projects, modified from @bjornjohansen, thanks to @rumperuu code contribution. - Adding: Development: pre-commit hook for WordPress projects, modified from @bjornjohansen, thanks to @rumperuu code contribution.
= 2.5.10 = = 2.5.10 =
- Bugfix: Revert to 2.5.8. OUR APOLOGIES, PLEASE, FOR THE 2.5.9d1 PLUGIN 'Stable Tag' MISHAP. - Bugfix: Codebase: revert to 2.5.8 with apologies (below), thanks to @little-shiva @watershare @adjayabdg @staho @frav8 @voregnev @dsl225 @alexclassroom @a223123131 @codldmac bug reports.
= 2.5.9d1 =
- Update: Codebase: accidental release of trunk/, tagged when 2.5.10 was released 3½ h later. OUR APOLOGIES, PLEASE, FOR THE 2.5.9d1 PLUGIN 'Stable Tag' MISHAP.
= 2.5.8 = = 2.5.8 =
- Bugfix: Layout: support right-to-left writing direction by replacing remaining CSS values 'left' with 'start', thanks to @arahmanshaalan bug report. - Bugfix: Layout: support right-to-left writing direction by replacing remaining CSS values 'left' with 'start', thanks to @arahmanshaalan bug report.
@ -214,7 +223,7 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest**
= 2.2.0 = = 2.2.0 =
- Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report. - Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report.
- Adding: Start/end short codes: more predefined options. - Adding: Dashboard: Footnote delimiters: more predefined options.
- Adding: Numbering styles: lowercase Roman numerals support. - Adding: Numbering styles: lowercase Roman numerals support.
- Update: Priority levels: update the notice in the dashboard Priority tab. - Update: Priority levels: update the notice in the dashboard Priority tab.
- Update: Dashboard: Tooltip settings: group into 3 thematic containers. - Update: Dashboard: Tooltip settings: group into 3 thematic containers.