CITE Collections

A minimum valid CITE Collection is made up:

a CITE URN identifying the collection
a CiteProperty object for the collection's canonical ID property
a CiteProperty object for the collection's labelling property
a URI uniquely identifying the abbreviated CITE namespace named in the Collection's URN

Examples

We can initialize a valid CITE Collection as follows.

First, using these properties:

name = Image
type = citeurn
label = Image URN

we can construct a valid CiteProperty for the Collection's canonical ID property.

Then, using these properties, we can construct a valid CiteProperty for the Collection's label property:

name = label
type = string
label = Caption

we can construct a valid CiteProperty for the Collection's label property.

If we give this collection the URN urn:cite:hmt:vaimg, with the hmt namespace abbreviation expanded to http://homermultitext.org/citens, and source named images.csv we can create a valid CITE Collection object.

CITE Properties

Every CITEProperty object is defined by three strings: a name that is unique within the Collection a belongs to, a type, and a human-readable display label. The value of type must be one of string, number, boolean, or markdown. The cite library can construct CITEProperty objects from ordered triples of strings in the sequence name, type and label.

Examples

Given these definitions:

name = rv
type = string
label = Recto or Verso

we can construct a valid CiteProperty.

If instead we use the string text_data for the type value, the library throws an Exception, because text_data is not a valid value for a CITEProperty type.

For string properties, it is also possible to define a set of controlled vocabulary items.

Examples

If we use these values:

name = rv
label = Recto or Verso

and further define a list of allowed values [recto,verso], we can construct a CITEProperty with controlled vocabulary.

Extensions

A valid CITE Extension includes:

an abbreviation identifying the extension
a URI expanding the extension's abbreviation
an RDF type, expressed with abbreviated RDF namespace
a URI expanding the RDF namespace abbreviation
a boolean value indicating whether this extension defines an extended citation notation
a set of one or more names of requests

If we define an extension with these values:

abbreviation image
URI for extension http://cite-architecture.github.io/extensions/image
RDF type cite:Image
URI for the cite RDF namespace http://cite-architecture.github.io/extensions/image
extended notation true
a set of request names GetBinaryImage,GetCaption,GetRights,GetIIPMooviewer

then we can construct a valid CITE Extension object.