Feetnotes: A Plugin for Expression Engine

Contents:

Introduction

About the Plugin

Feetnotes is a plugin for Expression Engine. It was written by Brent C. Wilson.

Feetnotes allows the user to embed footnotes within EE weblog entries (and elsewhere). The plugin parses the footnotes, automatically numbers them, and displays them in an ordered list.

Questions, Comments, Feature Requests, Bug Reports, &c.

For any of the above, .

About the Author

Brent C. Wilson is a shy guy. Or maybe he's just lazy. Either way, this is all he has to say about himself.

Download

Download the most current version of the plugin: Feetnotes 1.0.

This software is made available for free to the EE community. If you would like to make a donation to support the development of this plugin and other Expression Engine plugins, extensions, and modules, you may do so. I sincerely appreciate your support, whether it come via a donation, a kind word, or even just letting me know how the plugin was useful to you.

Requirements

Expression Engine version

Feetnotes should work on any version of Expression Engine. If you find that it does not, please contact the author.

Usage

General Usage Instructions

Feetnotes turns a paragraph like this:

<p>Brent Wilson is awesome.[[According to his wife.]]
He loves to eat potatoes.[[According to anecdotal reports.]]
Larry King thinks Brent Wilson should be president.[[It's possible I mis-heard that one.]]</p>
	

into this:

{feetnotes:item id="1"}

Brent Wilson is awesome.1 He loves to eat potatoes.2 Larry King thinks Brent Wilson should be president.3

  1. According to his wife.
  2. According to anecdotal reports.
  3. It's possible I mis-heard that one.
{/feetnotes:item}

All you need to do is embed your footnotes in your text by placing them between two sets of brackets, [[like so]]. (Don't like the brackets? They're configurable.) Feetnotes takes care of the rest by finding all of the bracketed footnotes, numbering them, and creating an ordered list that you can place and style as you like.

A basic setup on a single-entry page on your blog might look like this:

{exp:feetnotes}
  {exp:weblog:entries limit="1"}
    {feetnotes:item id="{entry_id}"}
      <h1>{title}</h1>
      {body}
      {feetnotes:header}<h2>Footnotes:</h2>{/feetnotes:header}
      {feetnotes:list}
    {/feetnotes:item}
  {/exp:weblog:entries}
{/exp:feetnotes}
	

Parameters

reset_counter

Optional. If set to "yes", the footnote counter will reset for each {feetnotes:item id=""}{/feetnotes:item} pair. If set to "no", the counter will note reset. The default is "yes".

Variables

{feetnotes:item id=""}{/feetnotes:item}

Required. Wrap this tag pair around the content you want parsed and returned. The plugin ONLY returns content wrapped in this tag pair. Content that falls between the tags but outside the {feetnotes:item} tags will not be returned. An ID is required. In many cases it will make sense to use id="{entry_id}", but any distinct value is fine.

{feetnotes:list}

Required. The ordered list containing your footnotes. Place wherever you like within the {feetnotes:item id=""} variable pair.

{feetnotes:header}{/feetnotes:header} and {feetnotes:footer}{/feetnotes:footer}

Optional. Place content between one or both of these variable pairs to display content immediately before (header) or after (footer) the ordered list. These variables pairs must be plaed between {feetnotes:item id=""} tags.

Examples

I suppose I should come up with some examples. In the mean time, hopefully you can figure out what's going on by using the instructions above.

To-Do List

Change Log

1.0