Jump to content

TextformatterFootnotes


monollonom
 Share

Recommended Posts

TextformatterFootnotes

Github: https://github.com/eprcstudio/TextformatterFootnotes
Modules directory: https://processwire.com/modules/textformatter-footnotes/

This textformatter adds footnotes using Markdown Extra’s syntax, minus Markdown

screenshot

About

This textformatter was primarly created to ease the addition of footnotes within HTML textareas (CKEditor or TinyMCE) using Markdown Extra’s syntax. It will also retain any inline formatting tags that are whitelisted.

Usage

To create a footnote reference, add a caret and an identifier inside brackets ([^1]). Then add the footnote in its own line using another caret and number inside brackets with a colon and text ([^1]: My footnote.). It will be put automatically inside the footnotes block at the end of the text.

Notes

  • the identifier has to be a positive number (int)
  • if a reference has no corresponding footnote (or vice-versa) based on their identifier, both will be ignored and left as is
  • by default references/footnotes are sequenced per field, meaning if you are outputting several fields with this textformatter each footnotes group will start from 1
  • block elements are not guaranteed to work in footnotes and are thus removed by defaut

Options

In the module settings you have some options regarding the generated markup:

  • you can change the icon (string) used for the backreference link
  • you can change the classes used for the wrapper, the reference and backreference links
  • you can decide to sequence the footnotes from different fields continuously, instead of restarting from 1
  • you can edit the list of whitelisted HTML tags that won’t be removed in the footnotes

Hook

Dynamically change options

If you want to have a more granular control over the footnotes (e.g. per field), you can use this hook:

$wire->addHookBefore("TextformatterFootnotes::addFootnotes", function(HookEvent $event) {
	$str = $event->arguments(0);
	$options = $event->arguments(1);
	$field = $event->arguments(2);

	if($field != "your-field-name") return;

	// Say you want to change the icon for a <svg>
	$options["icon"] = file_get_contents("{$event->config->paths->templates}assets/icons/up.svg");
	// Or change the wrapper’s class
	$options["wrapperClass"] = "my-own-wrapper-class";

	// Put back the updated options array
	$event->arguments(1, $options);
});

Check the source code for more options.

Group all footnotes in a page

Since a textformatter is applied per field, its footnotes are appended right after its content. If you have multiple fields and want to ouput all footnotes in the same place you can use the outputAsArray option:

// in init/ready.php

$wire->addHookBefore("TextformatterFootnotes::addFootnotes", function(HookEvent $event) {
	$options = $event->arguments("options");
	$options["outputAsArray"] = true;
	$event->arguments("options", $options);
});

$wire->addHookAfter("TextformatterFootnotes::addFootnotes", function(HookEvent $event) {
	if(empty($event->return["footnotes"])) return;

	$footnotes = setting("footnotes") ?: [];
	$footnotes = [
		...$footnotes,
		...$event->return["footnotes"]
	];
	setting("footnotes", $footnotes);
});

// in your template file

echo $modules->get("TextformatterFootnotes")->generateFootnotesMarkup(setting("footnotes"));

Note: if you are using this method to output your footnotes and want to dynamically change the markup/icon, please use the TextformatterFootnotes::generateFootnotesMarkup hook instead of TextformatterFootnotes::addFootnotes

  • Like 7
  • Thanks 1
Link to comment
Share on other sites

  • 2 weeks later...

Small thing, I was getting an error without any custom options defined.

As is, the line where you set up the arguments:

public function ___addFootnotes($str, $options = [], $field = "") {

This results in an error if you do not pass an additional options array - e.g. just a $str and $field.

An error on line 83 array_merge results - second argument is not an array.

I didn't pull the repo via git so I can't do a PR handily, but reversing the parameter order resolves it. 

public function ___addFootnotes($str, $field = "", $options = []) {

 

  • Like 1
Link to comment
Share on other sites

Quick question regarding your usage: were you calling the function on its own? Or was it through the textformatter applied to a text field?

What I could do is check if $options is not an array and in this case assume it's $field, but the $field argument is not used within the function as it's just there so you can do field-specific stuff using the hook.

Edit: oh wait I just saw my mistake... on line 44 ?

  • Like 2
Link to comment
Share on other sites

  • monollonom changed the title to TextformatterFootnotes

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...