diff --git a/class/dashboard/subpage-main.php b/class/dashboard/subpage-main.php index 5b45240..f97a8ae 100644 --- a/class/dashboard/subpage-main.php +++ b/class/dashboard/subpage-main.php @@ -15,8 +15,9 @@ * 2.1.6 option to disable URL line wrapping 2020-12-09T1604+0100 * 2.1.6 remove expert mode setting as irrelevant 2020-12-09T2105+0100 * 2.2.0 add options, redistribute, update strings 2020-12-12T2135+0100 + * 2.2.0 shortcode for reference container custom position 2020-12-13T2055+0100 * - * Last modified: 2020-12-12T2202+0100 + * Last modified: 2020-12-13T2055+0100 */ /** @@ -115,8 +116,10 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { $this->addMetaBox("settings", "love", MCI_Footnotes_Config::C_STR_PLUGIN_HEADING_NAME . ' ' . MCI_Footnotes_Config::C_STR_LOVE_SYMBOL_HEADING, "Love"), $this->addMetaBox("customize", "superscript", __("Referrer typesetting and formatting", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "Superscript"), - $this->addMetaBox("customize", "mouse-over-box-display", __("Tooltip display", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "MouseOverBoxDisplay"), + $this->addMetaBox("customize", "mouse-over-box", __("Tooltips", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "MouseOverBox"), $this->addMetaBox("customize", "mouse-over-box-truncation", __("Tooltip truncation", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "MouseOverBoxTruncation"), + $this->addMetaBox("customize", "mouse-over-box-position", __("Tooltip position", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "MouseOverBoxPosition"), + $this->addMetaBox("customize", "mouse-over-box-timing", __("Tooltip timing", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "MouseOverBoxTiming"), $this->addMetaBox("customize", "mouse-over-box-appearance", __("Tooltip appearance", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "MouseOverBoxAppearance"), $this->addMetaBox("expert", "lookup", __("WordPress hooks and priority levels", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "LookupHooks"), @@ -190,8 +193,13 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { "label-collapse" => $this->addLabel(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_COLLAPSE, __("Collapse by default:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "collapse" => $this->addSelectBox(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_COLLAPSE, $l_arr_Enabled), - "label-position" => $this->addLabel(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION, __("Position:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "label-shortcode" => $this->addLabel(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE, __("Position shortcode:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "shortcode" => $this->addTextBox(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE), + "notice-shortcode" => __("If present in the content, this shortcode will be replaced with the reference container.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + "label-position" => $this->addLabel(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION, __("Default position:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "position" => $this->addSelectBox(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION, $l_arr_Positions), + "notice-position" => __("Will be overridden in the presence of the shortcode.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "label-page-layout" => $this->addLabel(MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT, __("Apply basic responsive page layout:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "page-layout" => $this->addSelectBox(MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT, $l_arr_PageLayoutOptions), @@ -349,9 +357,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { "label-identical" => $this->addLabel(MCI_Footnotes_Settings::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES, __("Combine identical footnotes:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "identical" => $this->addSelectBox(MCI_Footnotes_Settings::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES, $l_arr_Enable), "notice-identical" => __("This option may require copy-pasting footnotes in multiple instances.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "description1-identical" => __("Even when footnotes are combined, footnote numbers keep incrementing.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "description2-identical" => __("This avoids suboptimal referrer and backlink disambiguation using a secondary numbering system.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "description3-identical" => __("Repeating the content is an opportunity to add details.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "description-identical" => __("Even when footnotes are combined, footnote numbers keep incrementing. This avoids suboptimal referrer and backlink disambiguation using a secondary numbering system. Repeating the content is an opportunity to add details.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), ) ); // display template with replaced placeholders @@ -454,8 +460,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { "excerpts" => $this->addSelectBox(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_IN_EXCERPT, $l_arr_Enabled), "notice-excerpts" => __("The recommended value is No.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), // In some themes, the Advanced Excerpt plugin is indispensable to display footnotes in excerpts. - "description1-excerpts" => sprintf(__("In some themes, the %s plugin is indispensable to display footnotes in excerpts.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), 'Advanced Excerpt'), - "description2-excerpts" => __("Footnotes cannot be disabled in excerpts. A workaround is to avoid footnotes in the first 55 words.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "description-excerpts" => sprintf(__("In some themes, the %s plugin is indispensable to display footnotes in excerpts. Footnotes cannot be disabled in excerpts. A workaround is to avoid footnotes in the first 55 words.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), 'Advanced Excerpt'), ) ); // display template with replaced placeholders @@ -495,6 +500,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { "label-link" => $this->addLabel(MCI_Footnotes_Settings::C_BOOL_LINK_ELEMENT_ENABLED, __("Use the link element for referrers and backlinks:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "link" => $this->addSelectBox(MCI_Footnotes_Settings::C_BOOL_LINK_ELEMENT_ENABLED, $l_arr_Enabled), "notice-link" => __("The link element is needed to apply the theme’s link color.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "description-link" => __("If the link element is not desired for styling, a simple span is used instead when the above is set to No. The link addresses have been removed. Else footnote clicks are logged in the browsing history and make the back button unusable.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), ) ); // display template with replaced placeholders @@ -508,25 +514,14 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { * @since 1.5.2 * * Edited: - * @since 2.2.0 3 parts to address increased settings number + * @since 2.2.0 5 parts to address increased settings number */ - public function MouseOverBoxDisplay() { + public function MouseOverBox() { // options for Yes/No select box: $l_arr_Enabled = array( "yes" => __("Yes", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "no" => __("No", MCI_Footnotes_Config::C_STR_PLUGIN_NAME) ); - // options for the Mouse-over box position - $l_arr_Position = array( - "top left" => __("top left", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "top center" => __("top center", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "top right" => __("top right", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "center right" => __("center right", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "bottom right" => __("bottom right", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "bottom center" => __("bottom center", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "bottom left" => __("bottom left", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "center left" => __("center left", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - ); // load template file $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_DASHBOARD, "mouse-over-box-display"); @@ -536,41 +531,12 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { "label-enable" => $this->addLabel(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED, __("Display tooltips:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "enable" => $this->addSelectBox(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED, $l_arr_Enabled), + "notice-enable" => __("Formatted text boxes allowing hyperlinks, displayed on mouse-over or on tap and hold.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "label-alternative" => $this->addLabel(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE, __("Display alternative tooltips:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "alternative" => $this->addSelectBox(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE, $l_arr_Enabled), - "notice-alternative" => __("Intended to work around a tooltip outage.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - - "label-position" => $this->addLabel(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION, __("Position:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "position" => $this->addSelectBox(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION, $l_arr_Position), - - "label-offset-x" => $this->addLabel(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X, __("Horizontal offset rightwards:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "offset-x" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X, -150, 150), - "notice-offset-x" => __("pixels; negative value for a leftwards offset", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - - "label-offset-y" => $this->addLabel(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y, __("Vertical offset downwards:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "offset-y" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y, -150, 150), - "notice-offset-y" => __("pixels; negative value for an upwards offset", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - - "label-max-width" => $this->addLabel(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH, __("Maximum width:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "max-width" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH, 0, 1280), - "notice-max-width" => __("pixels; 0 to disable this setting", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - - "label-fade-in-delay" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY, __("Fade-in delay:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "fade-in-delay" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY, 0, 20000), - "notice-fade-in-delay" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - - "label-fade-in-duration" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION, __("Fade-in duration:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "fade-in-duration" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION, 0, 20000), - "notice-fade-in-duration" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - - "label-fade-out-delay" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY, __("Fade-out delay:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "fade-out-delay" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY, 0, 20000), - "notice-fade-out-delay" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - - "label-fade-out-duration" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION, __("Fade-out duration:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), - "fade-out-duration" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION, 0, 20000), - "notice-fade-out-duration" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "notice-alternative" => __("Intended to work around a configuration-related tooltip outage.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "description-alternative" => sprintf(__("Some themes inhibit jQuery tooltips. For alternative tooltips, animated by CSS, %s does not load any external scripts.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . ''), ) ); @@ -596,6 +562,8 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { "label-max-length" => $this->addLabel(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH, __("Maximum number of characters in the tooltip:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "max-length" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH, 3, 10000), + // The feature trims back until the last full word. + "notice-max-length" => __("No weird cuts.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "label-readon" => $this->addLabel(MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL, __("‘Read on’ button label:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), "readon" => $this->addTextBox(MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL), @@ -606,6 +574,77 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { echo $l_obj_Template->getContent(); } + public function MouseOverBoxPosition() { + + // options for the Mouse-over box position + $l_arr_Position = array( + "top left" => __("top left", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "top center" => __("top center", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "top right" => __("top right", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "center right" => __("center right", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "bottom right" => __("bottom right", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "bottom center" => __("bottom center", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "bottom left" => __("bottom left", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "center left" => __("center left", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + ); + + // load template file + $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_DASHBOARD, "mouse-over-box-position"); + // replace all placeholders + $l_obj_Template->replace( + array( + + "label-position" => $this->addLabel(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION, __("Position:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "position" => $this->addSelectBox(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION, $l_arr_Position), + + "label-offset-x" => $this->addLabel(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X, __("Horizontal offset rightwards:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "offset-x" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X, -150, 150), + "notice-offset-x" => __("pixels; negative value for a leftwards offset", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + "label-offset-y" => $this->addLabel(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y, __("Vertical offset downwards:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "offset-y" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y, -150, 150), + "notice-offset-y" => __("pixels; negative value for an upwards offset", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + "label-max-width" => $this->addLabel(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH, __("Maximum width:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "max-width" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH, 0, 1280), + "notice-max-width" => __("pixels; 0 to disable this setting", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + ) + ); + // display template with replaced placeholders + echo $l_obj_Template->getContent(); + } + + public function MouseOverBoxTiming() { + + // load template file + $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_DASHBOARD, "mouse-over-box-timing"); + // replace all placeholders + $l_obj_Template->replace( + array( + + "label-fade-in-delay" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY, __("Fade-in delay:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "fade-in-delay" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY, 0, 20000), + "notice-fade-in-delay" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + "label-fade-in-duration" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION, __("Fade-in duration:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "fade-in-duration" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION, 0, 20000), + "notice-fade-in-duration" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + "label-fade-out-delay" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY, __("Fade-out delay:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "fade-out-delay" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY, 0, 20000), + "notice-fade-out-delay" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + "label-fade-out-duration" => $this->addLabel(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION, __("Fade-out duration:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)), + "fade-out-duration" => $this->addNumBox(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION, 0, 20000), + "notice-fade-out-duration" => __("milliseconds", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + + ) + ); + // display template with replaced placeholders + echo $l_obj_Template->getContent(); + } + public function MouseOverBoxAppearance() { // options for Yes/No select box: $l_arr_Enabled = array( @@ -748,11 +787,9 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_LayoutEngine { array( "description-1" => __('The priority level determines whether Footnotes is executed timely before other plugins, and how the reference container is positioned relative to other features.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), - "description-2" => sprintf(__('For the_content, this figure must be lower than %1$d so that certain strings added by a plugin running at %1$d may not be mistaken as a footnote.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), 99), - "description-3" => sprintf(__('This makes also sure that the reference container displays above a feature inserted by a plugin running at %d.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), 1200), - "description-4" => sprintf(__('%d is lowest priority, %d is highest.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), PHP_INT_MAX, 0), - "description-5" => sprintf(__('To set priority level to lowest, set it to %d, interpreted as %d, the constant %s.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), -1, PHP_INT_MAX, 'PHP_INT_MAX'), - "description-6" => __('The widget_text hook must be disabled, because a footnotes container is inserted at the bottom of each widget, but multiple containers in a page are not disambiguated.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), + "description-2" => sprintf(__('For the_content, this figure must be lower than %1$d so that certain strings added by a plugin running at %1$d may not be mistaken as a footnote. This makes also sure that the reference container displays above a feature inserted by a plugin running at %2$d.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), 99, 1200), + "description-3" => sprintf(__('%1$d is lowest priority, %2$d is highest. To set priority level to lowest, set it to %3$d, interpreted as %1$d, the constant %4$s.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), PHP_INT_MAX, 0, -1, 'PHP_INT_MAX'), + "description-4" => __('The widget_text hook must be disabled, because a reference container is inserted at the bottom of each widget with footnotes, but multiple containers in a page are not functional.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "head-hook" => __("WordPress hook function name", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), "head-checkbox" => __("Activate", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), diff --git a/class/settings.php b/class/settings.php index d0d8a4e..839403b 100644 --- a/class/settings.php +++ b/class/settings.php @@ -20,8 +20,9 @@ * 2.1.4 more settings container keys 2020-12-03T0955+0100 * 2.1.6 option to disable URL line wrapping 2020-12-09T1606+0100 * 2.1.6 set default priority level of the_content to 98 2020-12-10T0447+0100 + * 2.2.0 reference container custom position shortcode 2020-12-13T2056+0100 * - * Last modified: 2020-12-12T1224+0100 + * Last modified: 2020-12-13T2057+0100 */ @@ -467,17 +468,26 @@ class MCI_Footnotes_Settings { /** * Settings Container Key for URL wrap option * - * This is made optional because it may cause issues when the regex catches too much; - * alongside the regex now contains a catch-all negative lookbehind excluding every URL - * preceded by '\w=.' + * This is made optional because it causes weird line breaks. + * Unicode-compliant browsers break URLs at slashes. * * @since 2.1.6 * @var bool * - * 2020-12-09T1554+0100..2020-12-10T0446+0100 + * 2020-12-09T1554+0100..2020-12-13T1313+0100 */ const C_BOOL_FOOTNOTE_URL_WRAP_ENABLED = "footnote_inputfield_url_wrap_enabled"; + /** + * Settings Container Key for reference container position shortcode + * + * @since 2.2.0 + * @var string + * + * 2020-12-13T2056+0100 + */ + const C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE = "footnote_inputfield_reference_container_position_shortcode"; + /** * Stores a singleton reference of this class. @@ -524,9 +534,10 @@ class MCI_Footnotes_Settings { // whether to enqueue additional style sheet: self::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT => 'none', - self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE => 'yes', + self::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE => '[[references]]', self::C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE => 'yes', self::C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE => 'no', + self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE => 'yes', self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH => 'no', // backlink separators and terminators are often not preferred. @@ -671,11 +682,11 @@ class MCI_Footnotes_Settings { // shows "9223372036854780000" instead of 9223372036854775807 in the numbox // empty should be interpreted as PHP_INT_MAX, but a numbox cannot be set to empty: // - // define -1 as PHP_INT_MAX instead + // interpret -1 as PHP_INT_MAX instead self::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, - // Priority level of the_content as the only relevant one - // must be less than 99 because social icons may yield scripts that + // Priority level of the_content, as the only relevant priority level + // must be less than 99 because social buttons may yield scripts that // contain the strings '((' and '))', i.e. the default footnote start // and end short codes, causing issues with fake footnotes. self::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL => 98, @@ -834,7 +845,10 @@ class MCI_Footnotes_Settings { * @since 1.5.0 * * Edit: This didn’t actually work. - * @since 2.2.0 this function is not called any longer when deleting the plugin + * @since 2.2.0 this function is not called any longer when deleting the plugin, + * to protect user data against loss, since manually updating a plugin is safer + * done by deleting and reinstalling (see the warning about database backup). + * 2020-12-13T1353+0100 */ public function ClearAll() { // iterate through each Settings Container diff --git a/class/task.php b/class/task.php index 38597d9..cf518c5 100644 --- a/class/task.php +++ b/class/task.php @@ -27,8 +27,9 @@ * 2.1.4 tooltip display duration settings 2020-12-06T1320+0100 * 2.1.6 option to disable URL line wrapping 2020-12-09T1606+0100 * 2.1.6 add catch-all exclusion to fix URL line wrapping 2020-12-09T1921+0100 + * 2.2.0 support for custom position shortcode for reference container 2020-12-13T2058+0100 * - * Last modified: 2020-12-11T1437+0100 + * Last modified: 2020-12-13T2058+0100 */ // If called directly, abort: @@ -282,7 +283,7 @@ class MCI_Footnotes_Task { * * @author Stefan Herndler * @since 1.5.0 - * + * * Edited: * @since 2.2.0 more options 2020-12-11T0506+0100 */ @@ -431,8 +432,20 @@ class MCI_Footnotes_Task { $p_str_Content = $this->search($p_str_Content, false, $p_bool_HideFootnotesText); // append the reference container + // or insert at shortcode: (2.2.0 2020-12-13T2057+0100) + $l_str_ReferenceContainerPositionShortcode = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE); + if ($p_bool_OutputReferences) { - $p_str_Content = $p_str_Content . $this->ReferenceContainer(); + + if (strpos( $p_str_Content, $l_str_ReferenceContainerPositionShortcode ) !== false ) { + + $p_str_Content = str_replace( $l_str_ReferenceContainerPositionShortcode, $this->ReferenceContainer(), $p_str_Content ); + + } else { + + $p_str_Content .= $this->ReferenceContainer(); + + } } // take a look if the LOVE ME slug should NOT be displayed on this page/post, remove the short code if found diff --git a/css/public.css b/css/public.css index 1db27e7..79086b9 100755 --- a/css/public.css +++ b/css/public.css @@ -5,14 +5,14 @@ * Created-Time: 16:21 * Since: 1.0 * - * Version: 2.2.0d8 + * Version: 2.2.0 * * Classes added to public.css may be added to the * list documenting CSS classes for Custom CSS if * recommended for general use. * List in templates/dashboard/customize-css.html * - * Last modified: 2020-12-12T2203+0100 + * Last modified: 2020-12-13T2059+0100 */ diff --git a/css/settings.css b/css/settings.css index e815e19..64776be 100755 --- a/css/settings.css +++ b/css/settings.css @@ -5,9 +5,9 @@ * Created-Time: 16:21 * Since: 1.0 * - * Version: 2.2.0d8 + * Version: 2.2.0 * - * Last modified: 2020-12-12T2203+0100 + * Last modified: 2020-12-13T2059+0100 */ @@ -79,6 +79,7 @@ Limited to a number of IDs to not affect all dashboards #footnote_inputfield_combine_identical, #footnotes_inputfield_scroll_offset, #footnotes_inputfield_scroll_duration, +#footnote_inputfield_custom_mouse_over_box_excerpt_enabled, #footnote_inputfield_custom_mouse_over_box_offset_x, #footnote_inputfield_custom_mouse_over_box_offset_y, #footnote_inputfield_custom_mouse_over_box_max_width, @@ -122,7 +123,7 @@ label { } .postbox > h3 > span { - padding-left: 10px; + padding: 0 10px; } .postbox > .inside > table { @@ -140,15 +141,13 @@ label { span.footnote_highlight_placeholder { font-weight: bold !important; - padding-left: 8px !important; - padding-right: 8px !important; + padding: 0 8px !important; } .footnote_placeholder_box_example { border: 2px solid #2bb975 !important; border-radius: 4px !important; - padding-top: 16px !important; - padding-bottom: 16px !important; + padding-top: 16px 0 !important; width: 50% !important; display: block !important; margin: 20px auto !important; @@ -208,7 +207,7 @@ helping edit CSS, as tab support and syntactic colors. } #customize_css .list p { font-family: monospace; - padding-left: 10px; + padding: 0 10px; text-indent: -10px; margin: .5em 0; } @@ -239,6 +238,8 @@ since 2.1.4 */ .footnotes_notice { font-style: italic; + display: inline-block; + text-align: end; } /************************************************************ diff --git a/footnotes.php b/footnotes.php index 07d0e48..e7812d5 100755 --- a/footnotes.php +++ b/footnotes.php @@ -4,12 +4,12 @@ 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.2.0d8 + Version: 2.2.0 Author URI: http://cheret.de/plugins/footnotes-2/ Text Domain: footnotes Domain Path: /languages */ -define( 'FOOTNOTES_VERSION', '2.2.0d8' ); +define( 'FOOTNOTES_VERSION', '2.2.0' ); /* Copyright 2020 Mark Cheret (email: mark@cheret.de) diff --git a/readme.txt b/readme.txt index 1f84c7a..f82ce86 100755 --- a/readme.txt +++ b/readme.txt @@ -80,7 +80,10 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest** == Changelog == -= 2.2.0d8 = += 2.2.0 = +- Add: Reference container: support for custom position shortcode +- Update: Priority levels: update the notice in the dashboard Priority tab +- Bugfix: Tooltips: add 'important' property to z-index to fix display overlay issue - Add: Start/end short codes: more predefined options - Add: Numbering styles: lowercase Roman numerals support - Update: Dashboard: Tooltip settings: grouped into 3 thematic containers @@ -88,10 +91,8 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest** - Update: Dashboard: moved link element option to the Referrers options - Update: Dashboard: moved URL wrap option to the Reference container options - Update: Dashboard: grouped both Custom CSS and priority level settings under the same tab -- Update: Dashboard: tab labels 'Referrers and tooltips', 'Priority and CSS' -- Bugfix: Tooltips: add 'important' property to z-index to fix display overlay issue +- Update: Dashboard: renamed tab labels 'Referrers and tooltips', 'Priority and CSS' - Bugfix: Localization: correct arguments for plugin textdomain load function -- Update: Priority levels: update the notice in the dashboard Priority tab - Bugfix: Reference container, tooltips: URL wrap: specifically catch the quotation mark - Add: Footnotes mention in the footer: more options diff --git a/templates/dashboard/customize-superscript.html b/templates/dashboard/customize-superscript.html index bfba65c..464bf47 100644 --- a/templates/dashboard/customize-superscript.html +++ b/templates/dashboard/customize-superscript.html @@ -18,3 +18,6 @@ +
+

[[description-link]]

+
diff --git a/templates/dashboard/expert-lookup.html b/templates/dashboard/expert-lookup.html index 9eda1e6..d296c7e 100644 --- a/templates/dashboard/expert-lookup.html +++ b/templates/dashboard/expert-lookup.html @@ -1,7 +1,7 @@

[[description-1]]

-

[[description-2]] [[description-3]]

-

[[description-4]] [[description-5]]

+

[[description-2]]

+

[[description-3]]

@@ -46,5 +46,5 @@
-

[[description-6]]

+

[[description-4]]

diff --git a/templates/dashboard/mouse-over-box-display.html b/templates/dashboard/mouse-over-box-display.html index bba708a..963f15e 100644 --- a/templates/dashboard/mouse-over-box-display.html +++ b/templates/dashboard/mouse-over-box-display.html @@ -2,43 +2,14 @@ [[label-enable]] - [[enable]] + [[enable]] [[notice-enable]] [[label-alternative]] [[alternative]] [[notice-alternative]] - - [[label-position]] - [[position]] - - - [[label-offset-x]] - [[offset-x]] [[notice-offset-x]] - - - [[label-offset-y]] - [[offset-y]] [[notice-offset-y]] - - - [[label-max-width]] - [[max-width]] [[notice-max-width]] - - - [[label-fade-in-delay]] - [[fade-in-delay]] [[notice-fade-in-delay]] - - - [[label-fade-in-duration]] - [[fade-in-duration]] [[notice-fade-in-duration]] - - - [[label-fade-out-delay]] - [[fade-out-delay]] [[notice-fade-out-delay]] - - - [[label-fade-out-duration]] - [[fade-out-duration]] [[notice-fade-out-duration]] - +
+

[[description-alternative]]

+
diff --git a/templates/dashboard/mouse-over-box-position.html b/templates/dashboard/mouse-over-box-position.html new file mode 100644 index 0000000..2ffa1d9 --- /dev/null +++ b/templates/dashboard/mouse-over-box-position.html @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + +
[[label-position]][[position]]
[[label-offset-x]][[offset-x]] [[notice-offset-x]]
[[label-offset-y]][[offset-y]] [[notice-offset-y]]
[[label-max-width]][[max-width]] [[notice-max-width]]
diff --git a/templates/dashboard/mouse-over-box-timing.html b/templates/dashboard/mouse-over-box-timing.html new file mode 100644 index 0000000..a15b234 --- /dev/null +++ b/templates/dashboard/mouse-over-box-timing.html @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + +
[[label-fade-in-delay]][[fade-in-delay]] [[notice-fade-in-delay]]
[[label-fade-in-duration]][[fade-in-duration]] [[notice-fade-in-duration]]
[[label-fade-out-delay]][[fade-out-delay]] [[notice-fade-out-delay]]
[[label-fade-out-duration]][[fade-out-duration]] [[notice-fade-out-duration]]
diff --git a/templates/dashboard/mouse-over-box-truncation.html b/templates/dashboard/mouse-over-box-truncation.html index 3fc7bf6..66a8be0 100644 --- a/templates/dashboard/mouse-over-box-truncation.html +++ b/templates/dashboard/mouse-over-box-truncation.html @@ -6,7 +6,7 @@ [[label-max-length]] - [[max-length]] + [[max-length]] [[notice-max-length]] [[label-readon]] diff --git a/templates/dashboard/settings-excerpts.html b/templates/dashboard/settings-excerpts.html index c7b86bd..e2236a3 100644 --- a/templates/dashboard/settings-excerpts.html +++ b/templates/dashboard/settings-excerpts.html @@ -7,5 +7,5 @@
-

[[description1-excerpts]] [[description2-excerpts]]

+

[[description-excerpts]]

diff --git a/templates/dashboard/settings-numbering.html b/templates/dashboard/settings-numbering.html index 19a59a8..1b328dd 100644 --- a/templates/dashboard/settings-numbering.html +++ b/templates/dashboard/settings-numbering.html @@ -11,5 +11,5 @@
-

[[description1-identical]] [[description2-identical]] [[description3-identical]]

+

[[description-identical]]

diff --git a/templates/dashboard/settings-reference-container.html b/templates/dashboard/settings-reference-container.html index 2b94c1b..e3e97eb 100644 --- a/templates/dashboard/settings-reference-container.html +++ b/templates/dashboard/settings-reference-container.html @@ -8,9 +8,13 @@ [[label-collapse]] [[collapse]] + + [[label-shortcode]] + [[shortcode]] [[notice-shortcode]] + [[label-position]] - [[position]] + [[position]] [[notice-position]] [[label-page-layout]]