HTML::Pipeline Cite Gem Build Status

An HTML::Pipeline filter for WikiMedia-style Cite references.

Installation

Add this line to your application's Gemfile:

gem 'html-pipeline-cite'

And then execute:

$ bundle

Or install it yourself as:

$ gem install html-pipeline-cite

Usage

This gem offers an HTML::Pipeline filter that collects references in the text and inserts a table of footnotes where instructed.

Example:

<ref>This is a footnote</ref>

Becomes:

<sup class="reference" id="wiki-cite_ref-1">[<a href="#wiki-cite_note-1">1</a>]</sup>

It will show up as a bracketed, superscripted and anchored number at that location in the text. Then when <references/> is placed in the text, an ordered list of the references and their text will be placed at that location. The example above would generate a list that looks like this:

<ol>
  <li id="wiki-cite_note-1"><b><a href="#wiki-cite_ref-1">^</a></b> This is a footnote.</li>
</ol>

Development

To see what has changed in recent versions of the html-pipeline-cite gem, see the CHANGELOG.

Core Team Members

Copyright

Copyright © 2013 Lee Dohm, Lifted Studios. See LICENSE for details.

Project is a member of the OSS Manifesto.