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

development 2.1.4d1 bugfix, for sharing on Forum

Browse source 
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2426102 b8457f37-d9ea-0310-8a92-e5e31aec5664
This commit is contained in:
pewgeuges 2020-11-25 23:40:45 +00:00
parent 592c663342
commit dacd29c7ca
12 changed files with 95 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
class/dashboard/layout.php
View file

@ -207,7 +207,7 @@ abstract class MCI_Footnotes_LayoutEngine {
'mci-footnotes-admin-styles', 'mci-footnotes-admin-styles',
plugins_url('../../css/settings.css', __FILE__), plugins_url('../../css/settings.css', __FILE__),
'', '',
'2.1.4d0' '2.1.4d1'
); );
// UPDATE version # when making changes to settings.css, FOR CACHE BUSTING // UPDATE version # when making changes to settings.css, FOR CACHE BUSTING

2
class/init.php
View file

@ -160,7 +160,7 @@ class MCI_Footnotes {
'mci-footnotes-css-public', 'mci-footnotes-css-public',
plugins_url('../css/public.css', __FILE__), plugins_url('../css/public.css', __FILE__),
'', '',
'2.1.4d0' '2.1.4d1'
); );
} }

94
class/task.php
View file

@ -19,7 +19,7 @@
* 2.1.2: options for the other hooks 2020-11-19T1849+0100 * 2.1.2: options for the other hooks 2020-11-19T1849+0100
* 2.1.4: fix line wrapping of URLs based on pattern, not link element 2020-11-25T0837+0100 * 2.1.4: fix line wrapping of URLs based on pattern, not link element 2020-11-25T0837+0100
* *
* Last modified: 2020-11-25T0837+0100 * Last modified: 2020-11-26T0036+0100
*/ */
// If called directly, abort: // If called directly, abort:
@ -448,7 +448,7 @@ class MCI_Footnotes_Task {
// to prevent them from hanging out of the tooltip in non-Unicode-compliant user agents // to prevent them from hanging out of the tooltip in non-Unicode-compliant user agents
// spare however values of the href argument! // spare however values of the href argument!
// see public.css // see public.css
$l_str_FootnoteText = preg_replace( '#(?<!href=.)(https?://[^\\s]+)#', '<span class="footnote_url_wrap">$1</span>', $l_str_FootnoteText ); $l_str_FootnoteText = preg_replace( '#(?<!href=.)(https?://[^\\s<]+)#', '<span class="footnote_url_wrap">$1</span>', $l_str_FootnoteText );
// Text to be displayed instead of the footnote // Text to be displayed instead of the footnote
$l_str_FootnoteReplaceText = ""; $l_str_FootnoteReplaceText = "";
@ -479,21 +479,26 @@ class MCI_Footnotes_Task {
// define the HTML element to use for the referrers: // define the HTML element to use for the referrers:
if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS))) { if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS))) {
$l_str_Element = 'sup'; $l_str_SupSpan = 'sup';
} else { } else {
$l_str_Element = 'span'; $l_str_SupSpan = 'span';
} }
// determine whether the link element is used, see below
// fill in 'templates/public/footnote.html': // fill in 'templates/public/footnote.html':
$l_obj_Template->replace( $l_obj_Template->replace(
array( array(
"post_id" => $l_int_PostId, "post_id" => $l_int_PostId,
"id" => $l_int_Index, "id" => $l_int_Index,
"element" => $l_str_Element, "link-start" => '<a>',
"before" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE), "link-end" => '</a>',
"index" => $l_int_Index, "sup-span" => $l_str_SupSpan,
"after" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_AFTER), "before" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE),
"text" => MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED)) ? $l_str_ExcerptText : "", "index" => $l_int_Index,
"after" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_AFTER),
"text" => MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED)) ? $l_str_ExcerptText : "",
) )
); );
$l_str_FootnoteReplaceText = $l_obj_Template->getContent(); $l_str_FootnoteReplaceText = $l_obj_Template->getContent();
@ -551,15 +556,51 @@ class MCI_Footnotes_Task {
*/ */
public function ReferenceContainer() { public function ReferenceContainer() {
// post ID to make everything unique wrt infinite scroll and archive view: // no footnotes have been replaced on this page:
global $l_int_PostId;
$l_int_PostId = get_the_id();
// no footnotes has been replaced on this page
if (empty(self::$a_arr_Footnotes)) { if (empty(self::$a_arr_Footnotes)) {
return ""; return "";
} }
/**
* INFINITE SCROLL / AUTOLOAD, ARCHIVE VIEW
*
* Multiple posts are appended to each other, functions and IDs must be disambiguated.
* Contributed by @docteurfitness <https://wordpress.org/support/topic/auto-load-post-compatibility-update/>
* @since 2.0.5
*
* post ID to make everything unique wrt infinite scroll and archive view:
*/
global $l_int_PostId;
$l_int_PostId = get_the_id();
/**
* OPTIONAL LINK ELEMENT FOR FOOTNOTE REFERRERS AND BACKLINKS
*
* STYLING:
* Link color is preferred for referrers and backlinks.
* Setting a global link color is a common feature in WordPress themes.
* CSS does not support identifiers for link colors (color: link | hover | active | visited)
* These are only supported as pseudo-classes of the link element.
* Hence the link element must be present for styling purposes.
* But styling these elements with the link color is not universally preferred.
* If not, the very presence of the link elements may need to be avoided.
*
* FUNCTIONALITY:
* Although widely used for that purpose, hyperlinks are disliked for footnote linking.
* Browsers may need to be prevented from logging these clicks in the browsing history,
* as logging compromises the usability of the 'return to previous' button in browsers.
* For that purpose, and for scroll animation, this linking is performed by JavaScript.
*
* The link elements have been added and are present @since 2.0.0.
* Then the link addresses were removed @since 2.0.4.
* Then the presence of <a> elements was made optional
* @since 2.1.4
* 2020-11-25T1306+0100
*/
$l_str_LinkSpan = true ? 'a' : 'span';
// in progress ##############################################
// FOOTNOTE INDEX BACKLINK SYMBOL // FOOTNOTE INDEX BACKLINK SYMBOL
@ -584,7 +625,7 @@ class MCI_Footnotes_Task {
} else { } else {
// if it is, set it to empty: // if it is not, set arrow to empty:
$l_str_Arrow = ""; $l_str_Arrow = "";
$l_str_FootnoteArrow = ""; $l_str_FootnoteArrow = "";
@ -659,7 +700,8 @@ class MCI_Footnotes_Task {
$l_str_FootnoteId = $l_str_FootnoteIndex; $l_str_FootnoteId = $l_str_FootnoteIndex;
// in case the footnote is unique: // in case the footnote is unique:
$l_str_FootnoteReference = '<a id="footnote_plugin_reference_'; $l_str_FootnoteReference = "<$l_str_LinkSpan";
$l_str_FootnoteReference .= ' id="footnote_plugin_reference_';
$l_str_FootnoteReference .= $l_int_PostId; $l_str_FootnoteReference .= $l_int_PostId;
$l_str_FootnoteReference .= "_$l_str_FootnoteId\""; $l_str_FootnoteReference .= "_$l_str_FootnoteId\"";
$l_str_FootnoteReference .= ' class="footnote_backlink"'; $l_str_FootnoteReference .= ' class="footnote_backlink"';
@ -674,8 +716,8 @@ class MCI_Footnotes_Task {
$l_str_FootnoteBacklinks .= $l_str_BacklinkEvent; $l_str_FootnoteBacklinks .= $l_str_BacklinkEvent;
// finish both single note and notes cluster: // finish both single note and notes cluster:
$l_str_FootnoteReference .= ">$l_str_FootnoteArrow$l_str_FootnoteId</a>"; $l_str_FootnoteReference .= ">$l_str_FootnoteArrow$l_str_FootnoteId</$l_str_LinkSpan>";
$l_str_FootnoteBacklinks .= ">$l_str_FootnoteArrow$l_str_FootnoteId</a>"; $l_str_FootnoteBacklinks .= ">$l_str_FootnoteArrow$l_str_FootnoteId</$l_str_LinkSpan>";
// If that is the only footnote with this text, we’re done. // If that is the only footnote with this text, we’re done.
@ -706,14 +748,15 @@ class MCI_Footnotes_Task {
$l_str_FootnoteId = MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); $l_str_FootnoteId = MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE));
// resume composing the backlinks enumeration: // resume composing the backlinks enumeration:
$l_str_FootnoteBacklinks .= ', <a id="footnote_plugin_reference_'; $l_str_FootnoteBacklinks .= ", <$l_str_LinkSpan";
$l_str_FootnoteBacklinks .= ' id="footnote_plugin_reference_';
$l_str_FootnoteBacklinks .= $l_int_PostId; $l_str_FootnoteBacklinks .= $l_int_PostId;
$l_str_FootnoteBacklinks .= "_$l_str_FootnoteId"; $l_str_FootnoteBacklinks .= "_$l_str_FootnoteId";
$l_str_FootnoteBacklinks .= '" class="footnote_backlink" '; $l_str_FootnoteBacklinks .= '" class="footnote_backlink" ';
$l_str_FootnoteBacklinks .= 'onclick="footnote_moveToAnchor_' . $l_int_PostId; $l_str_FootnoteBacklinks .= 'onclick="footnote_moveToAnchor_' . $l_int_PostId;
$l_str_FootnoteBacklinks .= "('footnote_plugin_tooltip_$l_int_PostId"; $l_str_FootnoteBacklinks .= "('footnote_plugin_tooltip_$l_int_PostId";
$l_str_FootnoteBacklinks .= "_$l_str_FootnoteId');\""; $l_str_FootnoteBacklinks .= "_$l_str_FootnoteId');\"";
$l_str_FootnoteBacklinks .= ">$l_str_FootnoteArrow$l_str_FootnoteId</a>"; $l_str_FootnoteBacklinks .= ">$l_str_FootnoteArrow$l_str_FootnoteId</$l_str_LinkSpan>";
// this legacy is not used: // this legacy is not used:
//$l_str_FootnoteIndex .= ', ' . MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); //$l_str_FootnoteIndex .= ', ' . MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE));
@ -723,7 +766,7 @@ class MCI_Footnotes_Task {
} }
// line wrapping of URLs already fixed, see: // line wrapping of URLs already fixed, see:
// $l_str_FootnoteText = preg_replace( '#(?<!href=.)(https?://[^\\s]+)#', '<span class="footnote_url_wrap">$1</span>', $l_str_FootnoteText ); // $l_str_FootnoteText = preg_replace( '#(?<!href=.)(https?://[^\\s<]+)#', '<span class="footnote_url_wrap">$1</span>', $l_str_FootnoteText );
// replace all placeholders in 'templates/public/reference-container-body.html' // replace all placeholders in 'templates/public/reference-container-body.html'
// or in 'templates/public/reference-container-body-combi.html' // or in 'templates/public/reference-container-body-combi.html'
@ -737,6 +780,9 @@ class MCI_Footnotes_Task {
// used in standard layout W/O COMBINED FOOTNOTES: // used in standard layout W/O COMBINED FOOTNOTES:
"post_id" => $l_int_PostId, "post_id" => $l_int_PostId,
"id" => MCI_Footnotes_Convert::Index($l_int_FirstFootnoteIndex, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)), "id" => MCI_Footnotes_Convert::Index($l_int_FirstFootnoteIndex, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)),
"link-start" => $l_str_LinkSpan == 'a' ? '<a>' : '',
"link-end" => $l_str_LinkSpan == 'a' ? '</a>' : '',
"link-span" => $l_str_LinkSpan,
// used in standard layout WITH COMBINED IDENTICALS TURNED ON: // used in standard layout WITH COMBINED IDENTICALS TURNED ON:
"pointer" => empty($l_str_BacklinkEvent) ? '' : ' pointer', "pointer" => empty($l_str_BacklinkEvent) ? '' : ' pointer',
@ -751,7 +797,7 @@ class MCI_Footnotes_Task {
$l_str_Body .= $l_obj_Template->getContent(); $l_str_Body .= $l_obj_Template->getContent();
// extra line breaks for page source legibility: // extra line breaks for page source readability:
$l_str_Body .= "\r\n\r\n"; $l_str_Body .= "\r\n\r\n";
$l_obj_Template->reload(); $l_obj_Template->reload();

8
css/public.css
View file

@ -4,9 +4,9 @@
* Created-Date: 15.05.14 * Created-Date: 15.05.14
* Created-Time: 16:21 * Created-Time: 16:21
* Since: 1.0 * Since: 1.0
* Version: 2.1.4d0 * Version: 2.1.4d1
* *
* Last modified: 2020-11-25T0836+0100 * Last modified: 2020-11-26T0037+0100
*/ */
@ -76,7 +76,9 @@ templates/public/footnote-alternative.html
text-decoration: none !important; text-decoration: none !important;
border-bottom: none !important; border-bottom: none !important;
line-height: 0; line-height: 0;
cursor: pointer; cursor: pointer;
position: relative;
vertical-align: baseline;
} }
.footnote_referrer:hover, .footnote_referrer:hover,
.footnote_referrer a:hover, .footnote_referrer a:hover,

4
css/settings.css
View file

@ -4,9 +4,9 @@
* Created-Date: 15.05.14 * Created-Date: 15.05.14
* Created-Time: 16:21 * Created-Time: 16:21
* Since: 1.0 * Since: 1.0
* Version: 2.1.4d0 * Version: 2.1.4d1
* *
* Last modified: 2020-11-25T0837+0100 * Last modified: 2020-11-26T0036+0100
*/ */

2
footnotes.php
View file

@ -4,7 +4,7 @@
Plugin URI: https://wordpress.org/plugins/footnotes/ 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. 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 Author: Mark Cheret
Version: 2.1.4d0 Version: 2.1.4d1
Author URI: http://cheret.de/plugins/footnotes-2/ Author URI: http://cheret.de/plugins/footnotes-2/
Text Domain: footnotes Text Domain: footnotes
Domain Path: /languages Domain Path: /languages

2
readme.txt
View file

@ -80,7 +80,7 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest**
== Changelog == == Changelog ==
= 2.1.4d0 = = 2.1.4d1 =
- Bugfix: Reference container, tooltips: fix line wrapping of URLs based on pattern, not link element - Bugfix: Reference container, tooltips: fix line wrapping of URLs based on pattern, not link element
= 2.1.3 = = 2.1.3 =

6
templates/public/footnote-alternative.html
View file

@ -2,12 +2,12 @@
class="footnote_referrer relative" class="footnote_referrer relative"
onmouseover="footnoteTooltipShow('footnote_plugin_tooltip_text_[[post_id]]_[[id]]')" onmouseover="footnoteTooltipShow('footnote_plugin_tooltip_text_[[post_id]]_[[id]]')"
onmouseout="footnoteTooltipHide('footnote_plugin_tooltip_text_[[post_id]]_[[id]]')" onmouseout="footnoteTooltipHide('footnote_plugin_tooltip_text_[[post_id]]_[[id]]')"
><a><[[element]] >[[link-start]]<[[sup-span]]
id="footnote_plugin_tooltip_[[post_id]]_[[id]]" id="footnote_plugin_tooltip_[[post_id]]_[[id]]"
class="footnote_plugin_tooltip_text" class="footnote_plugin_tooltip_text"
onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_reference_[[post_id]]_[[id]]');" onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_reference_[[post_id]]_[[id]]');"
>[[before]][[index]][[after]]</[[element]] >[[before]][[index]][[after]]</[[sup-span]]
></a><span >[[link-end]]<span
id="footnote_plugin_tooltip_text_[[post_id]]_[[id]]" id="footnote_plugin_tooltip_text_[[post_id]]_[[id]]"
class="footnote_tooltip position hidden" class="footnote_tooltip position hidden"
onmouseout="footnoteTooltipHide('footnote_plugin_tooltip_text_[[post_id]]_[[id]]')" onmouseout="footnoteTooltipHide('footnote_plugin_tooltip_text_[[post_id]]_[[id]]')"

6
templates/public/footnote.html
View file

@ -1,11 +1,11 @@
<span <span
class="footnote_referrer" class="footnote_referrer"
><a><[[element]] >[[link-start]]<[[sup-span]]
id="footnote_plugin_tooltip_[[post_id]]_[[id]]" id="footnote_plugin_tooltip_[[post_id]]_[[id]]"
class="footnote_plugin_tooltip_text" class="footnote_plugin_tooltip_text"
onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_reference_[[post_id]]_[[id]]');" onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_reference_[[post_id]]_[[id]]');"
>[[before]][[index]][[after]]</[[element]] >[[before]][[index]][[after]]</[[sup-span]]
></a><span >[[link-end]]<span
id="footnote_plugin_tooltip_text_[[post_id]]_[[id]]" id="footnote_plugin_tooltip_text_[[post_id]]_[[id]]"
class="footnote_tooltip" class="footnote_tooltip"
>[[text]]</span >[[text]]</span

8
templates/public/reference-container-body-3column.html
View file

@ -1,18 +1,18 @@
<tr> <tr>
<td <td
class="footnote_plugin_index" class="footnote_plugin_index"
><span ><[[link-span]]
id="footnote_plugin_reference_[[post_id]]_[[id]]" id="footnote_plugin_reference_[[post_id]]_[[id]]"
class="footnote_index" class="footnote_index"
onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');" onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');"
>[[index]].</span >[[index]].</[[link-span]]
></td> ></td>
<td <td
class="footnote_plugin_link" class="footnote_plugin_link"
><span ><[[link-span]]
onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');" onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');"
class="footnote_backlink" class="footnote_backlink"
>[[arrow]]</span >[[arrow]]</[[link-span]]
></td> ></td>
<td <td
class="footnote_plugin_text" class="footnote_plugin_text"

4
templates/public/reference-container-body-switch.html
View file

@ -3,9 +3,9 @@
id="footnote_plugin_reference_[[post_id]]_[[id]]" id="footnote_plugin_reference_[[post_id]]_[[id]]"
class="footnote_plugin_index pointer" class="footnote_plugin_index pointer"
onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');" onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');"
><span ><[[link-span]]
class="footnote_plugin_link" class="footnote_plugin_link"
>[[index]].[[arrow]]</span >[[index]].[[arrow]]</[[link-span]]
></td> ></td>
<td <td
class="footnote_plugin_text" class="footnote_plugin_text"

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

@ -3,9 +3,9 @@
id="footnote_plugin_reference_[[post_id]]_[[id]]" id="footnote_plugin_reference_[[post_id]]_[[id]]"
class="footnote_plugin_index pointer" class="footnote_plugin_index pointer"
onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');" onclick="footnote_moveToAnchor_[[post_id]]('footnote_plugin_tooltip_[[post_id]]_[[id]]');"
><a ><[[link-span]]
class="footnote_plugin_link" class="footnote_plugin_link"
>[[arrow]][[index]]</a >[[arrow]][[index]]</[[link-span]]
></td> ></td>
<td <td
class="footnote_plugin_text" class="footnote_plugin_text"