Giter Site home page Giter Site logo

wpcorner / footnotes-made-easy Goto Github PK

View Code? Open in Web Editor NEW
0.0 0.0 3.0 91 KB

A WordPress plugin that allows post authors to easily add and manage footnotes in posts and pages.

Home Page: https://wordpress.org/plugins/footnotes-made-easy/

License: GNU General Public License v2.0

PHP 93.59% JavaScript 3.20% CSS 3.21%
bibliography footnotes formatting referencing

footnotes-made-easy's Introduction

Footnotes Made Easy

Footnotes Made Easy is a simple, but powerful, method of adding footnotes into your posts and pages.

Key features include…

  • Simple footnote insertion via double parentheses
  • Combine identical notes
  • Solution for paginated posts
  • Suppress Footnotes on specific page types
  • Option to display ‘pretty’ tooltips using jQuery
  • Lots of configuration options

And much, much more!

Footnotes Made Easy is a fork of WP Footnotes, a plugin by Simon Elvery which was abandoned some years ago.

Installation & Usage

Installation is best handled from within the WordPress admin area, but you can download the latest release from the WordPress Plugin Directory.

Documentation on using Footnotes Made Easy is at the author's website. Further support is crowd-sourced via the WordPress support forums.

Getting Started

Creating a footnote is incredibly simple – you just need to include your footnote in double parentheses, such as this…

This is a sentence ((and this is your footnote)).

The footnote will then appear at the bottom of your post/page.

Important note: Make sure you include a space before your opening double parentheses or the footnote won’t work!

Options

You have a fair few options on how the identifier links, footnotes and back-links look which can be found in the WordPress admin area under Settings -> Footnotes.

Paginated Posts

Some of you seem to like paginating post, which is kind of problematic. By default, each page of your post will have its own set of footnotes at the bottom and the numbering will start again from 1 for each page.

The only way to get around this is to know how many posts are on each page and tell Footnotes Made Easy what number you want the list to start at for each of the pages. So at some point on each page (that is, between each <!--nextpage--> tag) you need to add a tag to let the plugin know what number the footnotes on this page should start at. The tag should look like this <!--startnum=5--> where “5” is the number you want the footnotes for this page to start at.

Referencing

Sometimes it’s useful to be able to refer to a previous footnote a second (or third, or fourth…) time. To do this, you can either simply insert the exact same text as you did the first time and the identifier should simply reference the previous note.

Alternatively, if you don’t want to do all that typing again, you can construct a footnote like this: ((ref:1)) and the identifier will reference the footnote with the given number.

Even though it’s a little more typing, using the exact text method is much more robust. The number referencing will not work across multiple pages in a paged post (but will work within the page).

Also, if you use the number referencing system you risk them identifying the incorrect footnote if you go back and insert a new footnote and forget to change the referenced number.

Bug Reports

Bug reports are best made via the plugin’s Github Issues tracker page.

Maintainers

Contributors

Contributions are welcomed. Please review the guidelines for contributing to Footnotes Made Easy before submitting a pull request on GitHub.

footnotes-made-easy's People

Contributors

lumumbapl avatar manuell18 avatar

footnotes-made-easy's Issues

Add option to display footnote list at bottom of posts

In version 3.0.3, footnote list is displayed by default at the bottom of posts. Adding the option of displaying footnote list at the bottom posts would make it possible to use a shortcode to display footnotes in other places like the sidebar.

FireShot Capture 420 - Modern Footnotes Settings ‹ Nebula — WordPress - icv paluhost co ke

WPML compatibility

I found that at least the ‘Footnotes Header’ field was not translated correctly with WPML.
I contacted WPML support and they gave me the following solution:

Open the ‘footnotes-made-easy.php’ file found in wp-content/plugins/footnotes-made-easy.
Search for line 290.
Replace:

$footnotes_markup = $footnotes_markup . $this->current_options[ ‘pre_footnotes’ ];
by
$footnotes_markup = $footnotes_markup . get_option( ‘swas_footnote_options’ )[ ‘pre_footnotes’ ];

Always in the same file but on line 314 you will find a similar code. change it to this one.

$footnotes_markup = $footnotes_markup . ” . get_option( ‘swas_footnote_options’ )[ ‘post_footnotes’ ];

It worked for me!

footnotes size preference

I find the text to be too small, and I'm required to use this code to adjust it:

header: <div style="font-size: initial;">
footer: </div>

It took me a long time to figure this out, and I feel there would be others who would benefit from a font percentage configuration option.

Footnotes not working in Advanced Custom Fields WYSIWYG

Hi Patrick,

Thanks for taking over this plugin! I posted on the plugin's support page at wordpress.org a couple months ago about footnotes not working within Advanced Custom Fields WYSIWYG fields.

https://wordpress.org/support/topic/footnotes-not-working-in-advanced-custom-fields-wysiwyg

I'm revamping a site for a client who has close to 1,000 existing posts that use the plugin for footnotes. Would love to be able to continue using the same plugin for future posts within the ACF layout. Any thoughts?

Incompatility with bootstrap library

Hi,
The plugin is incompatible with bootstrap js library. I use a plugin that includes that library. When pointing a footnote in the text, I guest the following error:

bootstrap.bundle.min.js?ver=1716011111:6 Uncaught TypeError: No method named "close" at HTMLAnchorElement.<anonymous> (bootstrap.bundle.min.js?ver=1716011111:6:69766) at Function.each (jquery.min.js?ver=3.7.1:2:3129) at e.<computed>.each (jquery.min.js?ver=3.7.1:2:1594) at e.<computed>.jQueryInterface [as tooltip] (bootstrap.bundle.min.js?ver=1716011111:6:69664) at tooltips.min.js?ver=6.5.3:1:295

With the 2.5 version of the plugin, no error. Issue appears only with version > 3.

Concatenate footnotes like [4-7] instead of [4][5][6][7]

This plugin is perfect and works way better than any other I've tested. But I do have one issue: note numbers are not concatenated. So when I cite a number of sources, they show up as long trailing tails of numbers. I cannot currently use the plugin as intended because it ends up looking unprofessional in a way.

It would be great to be able to concatenate ranges of numbers, for example if all the citations between 4 and 7 are used, then instead of displaying [4][5][6][7], it would just show [4-7].

Add filter to processed fields

Thanks for taking over this plugin! Would love to see a filter added to line 161 of footnotes-made-easy.php that would allow the fields processed by the plugin to be modified (e.g. add acf_the_content).

Change heading level for footnote list

I’d like to change Heading for footnote list from the default paragraph to something like Heading 2 or Heading 3.

The new version of the plugin should have a setting where you can make this change. To change the heading level on footnote lists, one would need to go to Settings > Footnotes and change the Heading tag name for the footnote list setting.

FireShot Capture 421 - Modern Footnotes Settings ‹ Nebula — WordPress - icv paluhost co ke

PHP 8.2 Deprecated Creation of dynamic property

Hi,
Just updated to latest footnotes made easy from 2.5 version. A longstanding PHP 8.2 bug is back again.

I get the message

Deprecated: Creation of dynamic property swas_wp_footnotes::$styles is deprecated in wp-content/plugins/footnotes-made-easy/footnotes-made-easy.php on line 54

on any admin page.

Thanks for looking into it!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.