API documentation

Published

June 12, 2024

Exported functions

For a cataloged text

entry

Construct a CatalogedText allowing for some default values.

entry(
    u,
    citation,
    group,
    work,
    version;
    exemplar,
    online,
    lang
)

citation

Retrieve label for citation pattern of txt.

citation(txt)

textgroup

Retrieve label for text group of txt.

textgroup(txt)

work

Retrieve label for work of txt.

work(txt)

version

Retrieve label for version of txt.

version(txt)

exemplar

Retrieve label for exemplar (if any) of txt.

exemplar(txt)

online

True if txt is online.

online(txt)

Retrieve entries for online texts in catalog.

online(catalog)

lang

Retrieve ISO language code for txt.

lang(txt)

Other

text

Text content of psg.

text(psg)

document_urns

Identify documents in a corpus by URN.

document_urns(c)

Identify documents in a list of passages by URN.

document_urns(v)

API documentation

Exported functions

For a cataloged text

entry citation textgroup work version exemplar online lang

Other

text document_urns

API documentation

Exported types and functions

The main types

CitablePassage

A canonically citable text node.

CitableTextCorpus

A canonically citable text corpus.

CatalogedText

A catalog description of a text.

Building a corpus

combine

No documentation found.

Binding combine does not exist.

textdf

No documentation found.

Binding textdf does not exist.

Building a catalog

catalogedtext catalogdf_fromcex catalogdf_fromfile catalogdf_fromurl

Reading the catalog of a corpus

groupname worktitle versionlabel exemplarlabel citationlabels online lang

API documentation

Exported types and functions

The main types

CitablePassage

A canonically citable text node.

CitableTextCorpus

A canonically citable text corpus.

CatalogedText

A catalog description of a text.

Building a corpus

combine

No documentation found.

Binding combine does not exist.

textdf

No documentation found.

Binding textdf does not exist.

Building a catalog

catalogedtext catalogdf_fromcex catalogdf_fromfile catalogdf_fromurl

Reading the catalog of a corpus

groupname worktitle versionlabel exemplarlabel citationlabels online lang