Maldini

Maldini is a Nesta plugin allowing citations and bibliographies to be automatically generated from BibTeX files. It is intended to streamline the workflow of those who write content both in LaTeX and for the web. It is also intended to make Nesta the tool of choice for academic websites. For more on the idea behind Maldini, see the Maldini project homepage.

Installation

Maldini is presently in pre-release development. The first official release, of version 0.0.1, will occur only when a gem is released to rubygems.org. For now, the development version of Maldini may be installed by adding the following line to the Gemfile of your Nesta site:

gem 'nesta-plugin-maldini', :git => 'git://github.com/etc/nesta-plugin-maldini.git'

For guidelines for working with Nesta plugin sources, see the Nesta plugin documentation.

Usage

Maldini provides a syntax modeled on (a very small subset of) the syntax provided by biblatex (it is basically a wrapper for bibtex-ruby, which looks after the hard work of parsing the BibTeX file). The Maldini project homepage is itself an example of how to employ Maldini. The source from which it is generated can be browsed here, and the BibTeX file it employs can be browsed here. More detailed information can be found in the Maldini YARD Documentation, which is automatically generated every time the Maldini sources are updated.

Utilities

See utilities/maldini.bbx for a biblatex style file that approximates (poorly, for now) the bibliography style output by Maldini. Install by first installing biblatex, then placing maldini.bbx in the local texmf tree (on OS X, this means in ~/Library/texmf/tex/latex/biblatex/bbx), then including (for example) the following in your LaTeX document:

\usepackage{underscore}
\usepackage{csquotes}
\usepackage[
    citestyle=authoryear-comp,
    bibstyle=maldini,
    hyperref=true,
    backref=false,
    abbreviate=false,
    sorting=nyt,
    useprefix=true
]{biblatex}

ACKNOWLEDGEMENTS

VERSION HISTORY

0.0.1

  • Initial skeleton release.
  • Supported features:
    • Correctly parses LaTeX code in field data (to the extent enabled by latex-decode)
    • Sorts reference list by surname, then first name, then year
    • Citation methods have optional prenote and postnote parameters, modeled on biblatex syntax
    • nocite('*'), like biblatex command \nocite(*), invisibly cites every entry in the bibliography, thereby providing a simple way to print the entire contents of a bibliography.
  • Nesta::Plugin::Maldini::Bibliography public methods:
    • open()
    • nocite()
    • cite()
    • parencite()
    • textcite()
    • citeauthor()
    • fullcite()
    • printbibliography()
  • Supported entry types:
    • article
    • book
    • inbook
    • incollection
    • inproceedings
    • unpublished
  • Unsupported entry types:
    • phdthesis

TODO

  • Minor issues are flagged method by method in the source with "TODO".

Known Issues

  • Better treatment of cases where a bibliography contains authors with the same last name with multiple publications in a single year. Default behaviour should be to incrementally append a lowercase letter to the year field (Name, 2001a; Name, 2001b).
  • Heroku deployments do not like bibliographies stored in the Nesta attachments directory.

Milestones

0.0.1

  • Automate testing with RSpec or something similar.

0.0.2

  • Add support for DOI field, formatting as URI iff there is no URL field.
  • Provide methods for simultaneously citing multiple entries, modeled on biblatex syntax.

0.1

  • Create BibDesk template for copying entries as Maldini citations.
  • Allow bibliography file to be specified in custom Nesta metadata.
  • Generate HTML marked up with identifiers to permit:
    • Customised styling of citations and (especially) reference lists.
    • Hyperlinks to references.
    • Citation tooltips displaying the complete reference.
  • Add support for entry notes, including notes that include biblatex citations to other entries.

1.0

  • Find a way to embed citations directly in Markdown pages, perhaps by totally re-engineering everything to utilise the citation processing implemented by Pandoc.
  • Allow BibTeX file to be sourced directly from a GitHub repository, perhaps by accessing it through libgit2.
  • Implement option to format citations in any format specified in Citation Style Language, by wrapping citeproc-ruby.
  • Add support for Biber.

AUTHOR

Maldini is an existence proof that a total amateur can easily build a useful Nesta plugin. For comments and suggestions, please contact the author.

LICENSE

Copyright © 2011 Brad Weslake.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.