API documentation

Relations of text, object and image

DSETriple

Citable relations of text passage, text-bearing surface and documentary image.

triple

Compose a DSETriple from delimited-text source.

triple(src; delimiter)

triples

Compose a Vector of DSETriples from delimited-text source.

triples(src; delimiter)

Compose a Vector of DSETriples from delimited-text source.

triples(lines; delimiter)

passage

Return passage field of trip.

passage(trip)

image

Return image field of trip.

image(trip)

Find image illustrating page.

image(pg)

surface

Return surface field of trip.

surface(trip)

DSECollection

A citable object wrapping a set of DSETriples.

Retrieval:

surfaces

Find unique values for surface field of a collection.

surfaces(dse)

passages

Find unique values for passage field of a collection.

passages(dse; keeppassage)

images

Find unique values for image field of a collection.

images(dse; keepsubref)

textsforsurface

Find text passages on surface surf

textsforsurface(surf, dse)

textsforimage

Find text passages for image(s) identified by URN.

textsforimage(img, dse; keepsubref)

surfacesfortext

Find surfaces for text passage(s) identified by URN.

surfacesfortext(txt, dse; keepsubref)

surfacesforimage

Find surfaces for image(s) identified by URN.

surfacesforimage(img, dse; keepsubref)

imagesfortext

Find surfaces for text passage(s) identified by URN.

imagesfortext(txt, dse; keepsubref, keepversion)

imagesforsurface

Find surfaces for text passage(s) identified by URN.

imagesforsurface(surf, dse; keepsubref)

Model of manuscript and pages

Codex

A codex is a collection of manuscript pages.

codex

Convenience function for creating Codex objects.

codex(pages; description)

MSPage

A single page (one side of a folio) of a codex

rectoverso

Find recto or verso value for page.

rectoverso(pg)

image

Return image field of trip.

image(trip)

Find image illustrating page.

image(pg)

sequence

Find sequence of page within a codex.

sequence(pg)