Citepro, Andrew Norcross and the Mechanics of Footnotes

Posted by on Jul 30, 2014 in Nerdery | No Comments

Some time ago I wrote about why I use footnotes, not in-text links on this blog1. Technically, footnotes can be tricky.

Alert: I’m about to get a little nerdy. If you just want to know how to use the amazing Citation Pro footnotes plugin, jump ahead.

You can create footnotes using vanilla HTML, but crafting them by hand is laborious and detailed:

Publishing platforms that support Markdown2 make things a bit easier with references, but even then the behavior isn’t consistent and the implementation process is still manual as far as numbered lists.

For better or worse, I use WordPress, which has the benefit of a robust community of plugin developers. As you might expect, some of them have tackled the problem of footnotes. The best of the lot that I’d found was John Watson’s FD Footnotes3

His format is simple and made a lot of sense. Brackets with numbers created footnotes in both the Visual and Text editors in WordPress. It looks like this:

[1. This is text in a footnote.]

One of the shining features of that plugin was a toggle that hid the reference content of the footnotes on truncated posts (like many posts on my homepage feed). Unfortunately, FD Footnotes was still a bit frustrating to use because the numbering system is broken, requiring me to manually order the content like this:

[1. 1. This is text in a footnote.]

It was still the best of the plugins available so I used it and dealt with the annoyance…that is until I met WordPress guru Andrew Norcross4. He spoke at the Front End Design conference and we had a chance to get acquainted.

After I returned home I thought I’d reach out to Andrew on a whim and share my frustrations about footnotes plugins to see if there was some sort of easy fix. Turns out the guy had old code sitting around that was 90% of the way to a perfect solution.

One new repo, 32 emails and several commits later, Citation Pro was everything I’d been looking for in a solution for awesome footnotes in WordPress.

Citation Pro features and usage

Citation Pro uses a simple shortcode system to generate footnotes. Here’s what they look like in the body text:

Those tags will automatically generate a numbered list at the end of the blog post. You’ll see a live example when you get to the bottom of this article. It’s worth noting that those short tags work when editing in both the Visual editor and Text editor in WordPress, meaning you don’t have to change implementation when switching between the two.  

One really nice interface feature Andrew included was a button in the editor’s toolbar, making it easy for anyone to use the plugin.

citepro-wordpress-plugin-footnotes-editor-button-1

citepro-wordpress-plugin-footnotes-editor-button-2

citepro-wordpress-plugin-footnotes-editor-text-input

As you might expect, clicking a footnote in the body text takes you to the content of the footnote at the end of the post. Go ahead, try it out5.

If you need to get back up to the content, you can click on any non-hyperlinked text in the content of the footnote. That seemed like a bit of an easter egg feature to me, which I told Andrew, but like any good software developer he had a purpose in not adding additional ornamentation and leaving that design decision up to the person implementing the code on their site.

I wanted to add a logical component to the interface of the footnote so that readers would have a road sign telling them there was a way back to the body text they just came from. FD Footnotes uses a “↩” which I think is a great solution, so I implemented it using a little CSS:

Installing Citation Pro

If you want to use Citation Pro, head over to the repo on Github and download the .zip file6. The link to download the file is on the righthand side of the page:

download-citepro-footnotes-plugin-wordpress

Next, follow WordPress’ guide on manually adding a plugin to your site7.

If you want to add custom styles, use CSS to select the “.citepro” class and add it to the CSS Stylesheet Editor of WordPress. Here’s the code I use:

And here’s where to find that CSS Editor in WordPress:

wordpress-css-editor

I owe a huge thank you to Andrew, his programming smarts, and most importantly, his generosity.

1. You can read the original article, Why Footnotes, here.2. You can read about Markdown on Daring Fireball's website.3. Read the documentation on his website.4. Follow Andrew Norcross on Twitter or learn more on his website.5. Neat scrolling feature, huh?6. Download the plugin from Andrew's Github repo7. Adding plugins manually is easy. Follow this guide and you'll have Citepro up and running in no time.