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

Stable release v2.0.8 with both critical changes reverted

Browse source 
git-svn-id: https://plugins.svn.wordpress.org/footnotes/tags/2.0.8@2413937 b8457f37-d9ea-0310-8a92-e5e31aec5664
This commit is contained in:
pewgeuges 2020-11-06 14:20:33 +00:00
parent 362d9e60c6
commit 8eb55683d0
12 changed files with 164 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

12
class/init.php
View file

@ -12,7 +12,7 @@
* Edited for v2.0.3: Added style sheet versioning 2020-10-29T1413+0100
* Edited for v2.0.4: Added jQuery UI from WordPress 2020-11-01T1902+0100
*
* Last modified: 2020-11-05T0638+0100
* Last modified: 2020-11-06T1511+0100
*/
@ -125,7 +125,13 @@ class MCI_Footnotes {
// Add jQuery tools:
wp_enqueue_script('mci-footnotes-js-jquery-tools', plugins_url('../js/jquery.tools.min.js', __FILE__));
// IMPORTANT: up-to-date plugin version number for cache busting.
wp_enqueue_style('mci-footnotes-css-public', plugins_url('../css/public.css', __FILE__), '', '2.0.5rc1');
// IMPORTANT: up-to-date plugin version number for cache busting:
wp_enqueue_style(
'mci-footnotes-css-public',
plugins_url('../css/public.css', __FILE__),
'',
'2.0.8'
);
}
}

62
class/settings.php
View file

@ -6,13 +6,15 @@
* @author Stefan Herndler
* @since 1.5.0 14.09.14 10:43
*
* Edited for v2.0.4 2020-11-02T2115+0100
* Edited for:
* v2.0.4 2020-11-02T2115+0100
* v2.0.7 2020-11-06T1342+0100
*/
/**
* The class loads all Settings from each WordPress Settings container.
* It a Setting is not defined yet the default value will be used.
* It a Setting is not defined yet, the default value will be used.
* Each Setting will be validated and sanitized when loaded from the container.
*
* @author Stefan Herndler
@ -165,7 +167,7 @@ class MCI_Footnotes_Settings {
const C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled";
/**
* Settings Container Key for the mouse-over box to define the max. length of the enabled expert.
* Settings Container Key for the mouse-over box to define the max. length of the enabled excerpt.
*
* @author Stefan Herndler
* @since 1.5.4
@ -388,34 +390,64 @@ class MCI_Footnotes_Settings {
self::C_BOOL_FOOTNOTES_EXPERT_MODE => 'no'
),
"footnotes_storage_custom" => array(
self::C_STR_FOOTNOTES_STYLING_BEFORE => '',
self::C_STR_FOOTNOTES_STYLING_AFTER => ')',
// The default footnote referrer surroundings should be square brackets:
// * as in English typesetting;
// * for better UX thanks to a more button-like appearance;
// * for stylistic consistency with the expand-collapse button
self::C_STR_FOOTNOTES_STYLING_BEFORE => '[',
self::C_STR_FOOTNOTES_STYLING_AFTER => ']',
self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED => 'yes',
self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED => 'no',
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH => 150,
self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION => 'top right',
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X => 10,
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y => 10,
// The mouse over content truncation should be enabled by default
// to raise awareness of the functionality and to prevent the screen
// from being filled at mouse-over, and to allow the Continue reading:
self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED => 'yes',
// The truncation length is raised from 150 to 200 chars:
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH => 200,
// The default position should not be lateral because of the risk
// the box gets squeezed between note anchor at line end and window edge,
// and top because reading at the bottom of the window is more likely:
self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION => 'top center',
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X => 0,
// The vertical offset must be negative for the box not to cover
// the current line of text (web coordinates origin is top left):
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y => -7,
self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR => '',
self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND => '#fff7a7',
// The mouse over box shouldn’t feature a colored background
// by default, due to diverging user preferences. White is neutral:
self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND => '#ffffff',
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH => 1,
self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR => '#cccc99',
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS => 3,
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH => 0,
// The mouse over box corners mustn’t be rounded as that is outdated:
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS => 0,
// The width should be limited to start with, for the box to have shape:
self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH => 450,
self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR => '#666666',
self::C_STR_HYPERLINK_ARROW => '↑',
self::C_STR_HYPERLINK_ARROW_USER_DEFINED => '',
self::C_STR_CUSTOM_CSS => ''
),
// These should all be enabled by default.
// These should all be enabled by default to prevent users from
// thinking at first that the feature is broken in post titles.
// See <https://wordpress.org/support/topic/more-feature-ideas/>
// In titles, footnotes are functionally pointless in WordPress.
"footnotes_storage_expert" => array(
self::C_BOOL_EXPERT_LOOKUP_THE_TITLE => 'yes',
self::C_BOOL_EXPERT_LOOKUP_THE_CONTENT => 'yes',
self::C_BOOL_EXPERT_LOOKUP_THE_EXCERPT => 'yes',
self::C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE => 'yes',
self::C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT => 'yes',
self::C_BOOL_EXPERT_LOOKUP_THE_POST => 'yes'
self::C_BOOL_EXPERT_LOOKUP_THE_POST => ''//NEVER ENABLE THIS HOOK!!!!!
)
);

25
class/task.php
View file

@ -11,7 +11,7 @@
* Edited for v2.0.5: Autoload / infinite scroll support added thanks to code from
* @docteurfitness <https://wordpress.org/support/topic/auto-load-post-compatibility-update/>
*
* Last modified 2020-11-05T0524+0100
* Last modified 2020-11-06T1516+0100
*/
// If called directly, abort:
@ -58,7 +58,7 @@ class MCI_Footnotes_Task {
* @author Stefan Herndler
* @since 1.5.0
*
* Edited for v2.0.5 2020-11-02T0330+0100 2020-11-04T2006+0100
* Edited for v2.0.5 through v2.0.7 2020-11-02T0330+0100..2020-11-06T1344+0100
*
* Explicitly setting all priority to (default) "10" instead of lowest "PHP_INT_MAX",
* especially for the_content, makes the footnotes reference container display
@ -66,9 +66,8 @@ class MCI_Footnotes_Task {
* Requested by users: <https://wordpress.org/support/topic/change-the-position-5/>
* Documentation: <https://codex.wordpress.org/Plugin_API/#Hook_in_your_Filter>
*
* But then, the blog engine calls this plugin in the editor, as reported in:
* <https://wordpress.org/support/topic/blogs-all-messed-up/>
* <https://wordpress.org/support/topic/change-the-position-5/#post-13612697>
* But this change is suspected to cause issues and needs to be assessed!
* See <https://wordpress.org/support/topic/change-the-position-5/#post-13612697>
*/
public function registerHooks() {
// append custom css to the header
@ -488,8 +487,14 @@ class MCI_Footnotes_Task {
if (empty($l_str_FootnoteText)) {
continue;
}
// get footnote index
// generate content of footnote index cell
$l_str_FirstFootnoteIndex = ($l_str_Index + 1);
// wrap each index # in a white-space:nowrap span
$l_str_FootnoteArrowIndex = '<span class="footnote_index_item">';
// wrap the arrow in a @media print { display:hidden } span
$l_str_FootnoteArrowIndex .= '<span class="footnote_index_arrow">' . $l_str_Arrow . '&#x200A;</span>';
// get the index; add support for legacy index placeholder:
$l_str_FootnoteArrowIndex .= MCI_Footnotes_Convert::Index(($l_str_Index + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE));
$l_str_FootnoteIndex = MCI_Footnotes_Convert::Index(($l_str_Index + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE));
// check if it isn't the last footnote in the array
@ -501,17 +506,23 @@ class MCI_Footnotes_Task {
// set the further footnote as empty so it won't be displayed later
self::$a_arr_Footnotes[$l_str_CheckIndex] = "";
// add the footnote index to the actual index
$l_str_FootnoteIndex .= ", " . MCI_Footnotes_Convert::Index(($l_str_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE));
$l_str_FootnoteArrowIndex .= ',</span> <span class="footnote_index_item">' . MCI_Footnotes_Convert::Index(($l_str_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE));
$l_str_FootnoteIndex .= ', ' . MCI_Footnotes_Convert::Index(($l_str_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE));
}
}
}
$l_str_FootnoteArrowIndex .= '</span>';
// replace all placeholders in the template templates/public/reference-container-body.html
// The individual arrow and index placeholders are for backcompat
$l_obj_Template->replace(
array(
"post_id" => $l_int_PostID,
"id" => MCI_Footnotes_Convert::Index($l_str_FirstFootnoteIndex, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)),
"arrow" => $l_str_Arrow,
"index" => $l_str_FootnoteIndex,
"arrow-index" => $l_str_FootnoteArrowIndex,
"text" => $l_str_FootnoteText
)
);

14
css/public.css
View file

@ -4,9 +4,9 @@
* Created-Date: 15.05.14
* Created-Time: 16:21
* Since: 1.0
* Version: 2.0.6
* Version: 2.0.8
*
* Last modified: 2020-11-04T2131+0100
* Last modified: 2020-11-06T1511+0100
*/
@ -127,7 +127,7 @@ span.footnote_tooltip {
border:none !important;
text-align: left !important;
vertical-align: top !important;
padding: 10px 5px 5px 0 !important;
padding: 10px 6px 5px 0 !important;
}
.footnote_plugin_index a,
.footnote_plugin_text a {
@ -145,10 +145,12 @@ span.footnote_tooltip {
word-break: unset;
word-break: keep-all !important;
max-width: 140px;
width: 1px; /*auto-extending column to fit widest*/
white-space: nowrap;
width: 2em; /*auto-extending column to fit widest*/
overflow: hidden;
}
.footnote_index_item {
white-space: nowrap;
}
.footnote_plugin_text {
width: unset; /*unset width of text column to fix site issues*/
}
@ -175,7 +177,7 @@ span.footnote_tooltip {
@media print {
.footnote_tooltip,
.footnote_reference_container_collapse_button,
.footnote_plugin_index_arrow {
.footnote_index_arrow {
display: none;
}
.footnote_plugin_tooltip_text {

2
footnotes.php
View file

@ -4,7 +4,7 @@
Plugin URI: https://wordpress.org/plugins/footnotes/
Description: time to bring footnotes to your website! footnotes are known from offline publishing and everybody takes them for granted when reading a magazine.
Author: Mark Cheret
Version: 2.0.4
Version: 2.0.8
Author URI: http://cheret.de/plugins/footnotes-2/
Text Domain: footnotes
Domain Path: /languages

BIN
languages/en_GB.mo
View file

Binary file not shown.

4
languages/en_GB.po
View file

@ -5,7 +5,7 @@ msgstr ""
"Project-Id-Version: footnotes\n"
"Report-Msgid-Bugs-To: http://wordpress.org/tag/footnotes\n"
"POT-Creation-Date: 2014-10-18 20:58+0100\n"
"PO-Revision-Date: 2020-11-04T2152+0100\n"
"PO-Revision-Date: 2020-11-05T1306+0100\n"
"Last-Translator: @pewgeuges\n"
"Language-Team: SHE <s.herndler@methis.at>\n"
"Language: en_GB\n"
@ -168,7 +168,7 @@ msgstr "in the footer"
#: class/dashboard/subpage-main.php:113
msgid "at the end of the post"
msgstr "at the end of the page"
msgstr "at the end of the post"
#: class/dashboard/subpage-main.php:114
msgid "in the widget area"

BIN
languages/en_US.mo
View file

Binary file not shown.

4
languages/en_US.po
View file

@ -5,7 +5,7 @@ msgstr ""
"Project-Id-Version: footnotes\n"
"Report-Msgid-Bugs-To: http://wordpress.org/tag/footnotes\n"
"POT-Creation-Date: 2014-10-18 20:59+0100\n"
"PO-Revision-Date: 2020-11-04T2153+0100\n"
"PO-Revision-Date: 2020-11-05T1307+0100\n"
"Last-Translator: @pewgeuges\n"
"Language-Team: SHE <s.herndler@methis.at>\n"
"Language: en_US\n"
@ -168,7 +168,7 @@ msgstr "in the footer"
#: class/dashboard/subpage-main.php:113
msgid "at the end of the post"
msgstr "at the end of the page"
msgstr "at the end of the post"
#: class/dashboard/subpage-main.php:114
msgid "in the widget area"

39
readme.txt
View file

@ -4,14 +4,12 @@ Tags: footnote, footnotes, bibliography, formatting, notes, Post, posts, referen
Requires at least: 3.9
Tested up to: 5.5
Requires PHP: 5.6
Stable Tag: 2.0.4
Stable Tag: 2.0.8
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
== Description ==
**footnotes** is now continually improved. Please feel free to check our current release candidate v2.0.5rc1, available at the bottom of the [Advanced view](https://wordpress.org/plugins/footnotes/advanced/).
Featured on wpmudev: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/
Cheers for the review, folks!
@ -82,19 +80,34 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest**
== Changelog ==
= 2.0.5rc1 =
- Update: Autoload / infinite scroll support added thanks to @docteurfitness <https://wordpress.org/support/topic/auto-load-post-compatibility-update/>
- Bugfix: Settings style sheet unenqueued to fix input boxes on public pages (enqueued for 2.0.4)
- Bugfix: Public style sheet: Footnote referrers: deleted vertical align tweaks for cross-theme and user agent compatibility
- Bugfix: Public style sheet: Reference container: auto-extending column to fit widest, to fix display with short note texts
- Bugfix: Public style sheet: Reference container: IDs: slightly increased left padding
= 2.0.8 =
- BUGFIX: Priority level back to PHP_INT_MAX (need to get in touch with other plugins)
= 2.0.7 =
- BUGFIX: Disabled hook "the_post" **Any related code in the plugin shall disappear next**
- Update: Set priority level back to 10 assuming it is unproblematic
- Update: Added backwards compatible support for legacy arrow and index placeholders in template
- Update: Settings defaults adjusted for better and more up-to-date tooltip layout
= 2.0.6 =
- Update: Autoload / infinite scroll support thanks to @docteurfitness <https://wordpress.org/support/topic/auto-load-post-compatibility-update/>
- Bugfix: Layout: Footnote referrers: deleted vertical align tweaks for cross-theme and user agent compatibility
- Bugfix: Layout: Reference container: fixed line break behavior in footnote # clusters
- Bugfix: Layout: Reference container: auto-extending column to fit widest, to fix display with short note texts
- Bugfix: Layout: Reference container: IDs: slightly increased left padding
- Bugfix: Translations: fixed spelling error and erroneously changed word in en_GB and en_US
- Update: Typesetting: discarded the dot after footnote numbers as not localizable (should be optional)
- Bugfix: UI: Reference container: Collapse button fully clickable, not sign only
- Bugfix: UI: Reference container: Collapse button 'collapse' with minus sign not hyphen-minus
- Update: UX: Tooltip: set display predelay to 0 for responsiveness (was 800 since 2.0.0, 400 before)
- BUGFIX: Priority level back to PHP_INT_MAX (ref container positioning not this plugin’s responsibility)
= 2.0.5 =
- Bugfix: Get references container close to content, not below all other features, by priority level 10
- Bugfix: Public style sheet: Reference container: unset width of text column to fix site issues
- Update: Enable all hooks by default to prevent footnotes from seeming broken in post titles
- Bugfix: Restore cursor shape pointer over 'Continue reading' button after hyperlink removal
- Update: Tooltip infobox: set display predelay to 0 for responsiveness (was 800 since 2.0.0, 400 before)
- Bugfix: Reference container: collapse button fully clickable, not sign only
- Bugfix: Reference container: collapse button 'collapse' with minus sign not hyphen-minus
- Bugfix: Translations: Spelling error in en_GB and en_US
- Bugfix: Settings style sheet unenqueued to fix input boxes on public pages (enqueued for 2.0.4)
= 2.0.4 =
- Update: Restored arrow settings to customize or disable the now prepended arrow symbol

28
templates/NOTE-FOR-WEBMASTERS.txt Normal file
View file

@ -0,0 +1,28 @@
MCI Footnotes WordPress plugin
NOTE FOR WEBMASTERS
Added: 2020-11-06T0424+0100
Last modified: 2020-11-06T0431+0100
About the public templates
Template "reference-container-body.html"
class/task.php(481)
css/public.css
Supported placeholders:
[[post_id]] makes the footnote ID unique for infinite scroll
[[id]] footnote number (1-based integer)
[[arrow]] symbol alone, for backwards compatibility
[[index]] footnote index alone (or comma-separated enumeration) for backwards compatibility
[[arrow-index]] new compound string starting with the arrow hidden in print
wrapping each index in a no-break span, example:
<span class="footnote_index_item"><span class="footnote_index_arrow">&#8593;&#x200A;</span>4,</span> <span class="footnote_index_item">5,</span> <span class="footnote_index_item">6,</span> <span class="footnote_index_item">7,</span> <span class="footnote_index_item">8,</span> <span class="footnote_index_item">9,</span> <span class="footnote_index_item">10,</span>
[[text]]

7
templates/public/reference-container-body.html
View file

@ -1,13 +1,10 @@
<tr>
<td
class="footnote_plugin_index footnote_plugin_link"
id="footnote_plugin_reference_[[post_id]]_[[id]]"
class="footnote_plugin_index footnote_plugin_link"
onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');"
><a
><span
class="footnote_plugin_index_arrow"
>[[arrow]]&#x200A;</span
>[[index]].</a
>[[arrow-index]]</a
></td>
<td
class="footnote_plugin_text"