API documentation

The `readcitable` function

Use the readcitable function to create a citable corpus from a source document.

CitableTeiReaders.readcitable — Function

Read from src a citable document identified by urn. Its citation scheme must be parseable using the type citescheme.

readcitable(src, urn, citescheme)

source

Read from file fname a citable document identified by urn. Its citation scheme must be parseable using the type citescheme.

readcitable(fname, urn, citescheme, rdr)

source

Read from url a citable document identified by urn. Its citation scheme must be parseable using the type citescheme.

readcitable(url, urn, citescheme, rdr)

source

Implementation of readcitable for type TEIPoeticLine.

source

Implementation of readcitable for type TEIAnonblock.

source

Implementation of readcitable for type TEIDivAb.

source

Implementation of readcitable for type TEIDivLine.

source

Implementation of readcitable for type TEIDivDivLine.

source

Implementation of readcitable for type TEIDivDivDiv.

source

Implementation of readcitable for type TEIThreeDivsGrouped.

source

Implementation of readcitable for type DelimitedText.

source

Implementation of readcitable for type TEIDivDivDiv.

source

Subtypes of `CiteStructureTrait`

Any package can implement the CiteStructure with a custom type to supply to the readcitable function. The following types are included in the CitableTeiReaders package.

Delimited-text file

CitableTeiReaders.DelimitedText — Type

Singleton type for delimited-text document with citation scheme of arbitrary depth already expressed with URNs.

source

XML cited by one-tier citation scheme

CitableTeiReaders.TEIPoeticLine — Type

Singleton type for TEI document cited by poetic line using TEI l.

source

CitableTeiReaders.TEIAnonblock — Type

Singleton type for TEI document cited by prose block using TEI ab.

source

XML cited by two-tier citation scheme

CitableTeiReaders.TEIDivAb — Type

Singleton type for TEI document cited in two tiers using TEI div and ab elements.

source

CitableTeiReaders.TEIDivLine — Type

Singleton type for TEI document cited in two tiers using TEI div and l.

source

XML cited by three-tier citation scheme

CitableTeiReaders.TEIDivDivDiv — Type

Singleton type for TEI document cited in three tiers using TEI div, div and div.

source

CitableTeiReaders.TEIThreeDivsGrouped — Type

Singleton type for grouped TEI documents cited in three tiers using TEI group, div and div.

source

A useful utility function

CitableTeiReaders.ezxmlstring — Function

ezxmlstring(n)

Serialize an EzXML.Node to an XML string. If a node n was created by parsing an XML string, the output of ezxmlstring(n) will be XML equivalent to the source string.

source

Functions used internally

CitableTeiReaders.citeNAttr — Function

citeNAttr(n, docUrn)

Construct a CitablePassage from an element with a citable value on @n attribute.

source

citeNAttr(n, docUrn, psg)

Construct a CitablePassage from an element with citable value on @n attribute.

source

CitableTeiReaders.nodefromline — Function

Create a CitablePassage from a string of delimited text.

source