Project

incite

0.0
No commit activity in last 3 years
No release in over 3 years
Incite is an academic citation library that lets you easily define objects for typical academic sources (eg. books, articles) which can be used to output formatted html for a variety of bibliographical formats (eg. Chicago Manual of Style, MLA). Right now only CMS is supported. Incite is in alpha alpha stage. It's useless, don't install it.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 0.9.2.2
 Project Readme

Overview Incite Build Status

Incite is in alpha alpha stage. It's useless, don't install it.

Installation

Incite is available as a ruby gem.

gem install incite

Usage

  • Note: This syntax is very experimental, and will likely--no, definitely--change in a radical way (see overview).

First you need to instantiate a source you want to cite:

source = Incite::Source.new
# => #<Incite::Source:0x8c5f0>

Configure the source with the bibliographical data. The minimum required attributes are title, author(s), publisher, and year.

source.authors = ["Sam Dandy"]
source.title = "A Brief Flirtation"
source.publisher = "Rainbow Unicorn Press"
source.year = 1985

Yes, I just made all of that up. I should have been a writer. Now you can cite your source:

source.citation(:entry)
# => "Sam Dandy. <em>A Brief Flirtation</em>. : Rainbow Unicorn Press, 1985."

If you try to create a citation when this data is missing you'll get an error.

source.title = nil
# => nil
source.citation(:entry)
# => ArgumentError: Source lacks attributes required to construct citation

Most citations require more data, viz. page numbers.

Other future plans

  • Integration with various bibliographies (Google Books, Amazon, &c)
  • Citation text (for annotated notes/bibliographies)
  • Source types (book, article, chapter &c)
  • Different type of formats (to_s, to_rtf, &c)