1. Eumaeus
  2. CITEKit

Overview

HTTPS SSH

Title: CITEKit README CSS: http://folio.furman.edu/images/swiss.css copyright: 2013 C.W. Blackwell, D.N. Smith, CC-License/by-nc-sa/3.0 encoding: UTF-8 Format: complete

CITEKit - Simple Citation and Quoting of Primary Sources

CITEKit is a collection of scripts that allow easy end-user display of images, data, and textual passages using the CITE/CTS Architecture.[^citation_cts_docs] This page presents a lengthy list of examples of how to use it to include different kinds of data in an html page. Detailed instructions are available on the help pages: click on the CITEKit Console Show/Hide link at the top of this page to access the menu for help files and tools.

Assumptions

These instructions begin from a few assumptions:

  • That you know what CITE/CTS is.
  • That you know that CITE/CTS objects (data-objects, images, and texts) are uniquely identified by URN-formatted citations.
  • That you know that that those URNs identify an object, and that a CITE or CTS Service is necessary to retrieve an object.
  • That you are reading this because you are familiar with HTML and are interested in the simplest possible way to embed primary sources in an HTML document.

The CITEKit Console Show/Hide link, above, will reveal a menu of links to documentation and further examples.

N.b. CITEKit loads Javascript and CSS dynamically. Occasionally a web-browser’s caching mechanism will confuse this process. If at any point the CITEKit menu fails to appear, and objects fail to load, re-loading the page will usually correct this.

Quickstart

To use CITEKit immediately, do the following:

  • Make an HTML page.
  • In the <head> element of your HTML, insert this line: <script type="text/javascript" src="http://folio.furman.edu/citekit/js/cite-jq.js"> </script>
  • Insert a properly formatted CITEKit citation, e.g.: <blockquote class="cite-cts svc-fu-cts" cite="urn:cts:greekLit:tlg0012.tlg001.fuPers:2.1-2.25"><i>Iliad</i> 2.1-2.25</blockquote>
  • NEED DETAILED INSTRUCTIONS ON FORMATTING SERVICE DEFINITIONS
  • Load the page in a browser.

Notes for Deployment

You can invoke CITEKit for a page in one of two ways. The normal way is with:

`<script type="text/javascript" src="http://folio.furman.edu/citekit/js/cite-jq.js"> </script>`

But if your page is already using jQuery, you won’t want the “normal” way, since it loads its own copy of jQuery. In that case, use:

`<script type="text/javascript" src="http://folio.furman.edu/citekit/js/cite-no-jq.js"> </script>`

That will load a version of CITEKit that will use the copy of jQuery that your page has already loaded.

Specifying Service Addresses

CITEKit needs to know the addresses (URLs) of services that can deliver content based on URN citations. Each CITEKit html page needs to include a section of HTML configuring these services.

The configuration is in the form of an HTML <ul></ul> element: