API documentation

Published

June 4, 2024

Public types and functions

The repository

EditingRepository

File organization of a repository for HMT editors.

Members

  • editions Path to directory with source files for textual editions.
  • dse Path to directory with delimited text files recording text, image and surface relations.
  • configs Path to directory with catalog.cex and citation.cex files.

repository

Construct an EditingRepository from a root directory containing all three required directories.

repository(repodir; editions, dse, config)

If the required directories are named “editions”, “dse” and “config”, repodir is the only parameter needed. Optionally, you may supply names for any of those directories relative to reporoot.

configdir

Find configuration directory for repository.

configdir(repo)

dsedir

Find DSE directory for repository.

dsedir(repo)

editionsdir

Find editions directory for repository.

editionsdir(repo)

Text configuration

citationconfig

Read citation configuration into a Table.

citationconfig(repo; filename, delimiter)

filename

No documentation found.

Binding filename does not exist.

o2converter

o2converter(repo, txturn)

Lookup ocho2converter for a text identified by URN. If one than one configuration entry matches txturn, it is assumed that all entries are configured to use the same OHCO2 converter, and only the first entry is instantiated and returned.

diplomaticbuilder

Instantiate a MidDiplomaticBuilder.

diplomaticbuilder(; versionid)

Lookup diplomaticbuilder for a text identified by URN.

diplomaticbuilder(repo, txturn)

If one than one configuration entry matches txturn, it is assumed that all entries are configured to use the same diplomatic builder, and only the first entry is instantiated and returned.

normalizedbuilder

Instantiate a MidNormalizedBuilder.

normalizedbuilder(; versionid)

Lookup normalizedbuilder for a text identified by URN.

normalizedbuilder(repo, txturn)

If one than one configuration entry matches txturn, it is assumed that all entries are configured to use the same normalized builder, and only the first entry is instantiated and returned.

orthography

No documentation found.

Binding orthography does not exist.

Text catalog and contents

textcatalog

Read a TextCatalogCollection for a repository.

textcatalog(repo; catalogname, delimiter)

texturns

Find CTS URNs of all texts cataloged as online.

texturns(repo)

archivalcorpus

Create a citable corpus of all archival text in a repo.

archivalcorpus(r; skipref)

diplomaticcorpus

Create diplomatic editions of all texts in a repo.

diplomaticcorpus(r; sourcecorpus)

normalizedcorpus

Create normalized editions of all texts in a repo.

normalizedcorpus(r; sourcecorpus)

tokencorpus

No documentation found.

Binding tokencorpus does not exist.

Indexing of text and physical artifacts

dsetriples

Create a single composite list of DSE data.

dsetriples(repo; strict)

passageurnsforsurface

passageurnsforsurface(r, u; strict)

Compute list of passages in DSE records for a given surface.

diplomaticforsurface

diplomaticforsurface(r, u; strict)

Assemble citable passages in diplomatic edition for a given surface.

imagesforpassage

imagesforpassage(r, u; strict)

Compute list of images in DSE records for a given passage.

Markdown and HTML displays for validation

indexingaccuracy_md

Compose HTML for verification of accuracy of DSE indexing of a given surface.

indexingaccuracy_md(r, surf; iiif, ict, width, strict)

Juxtapose diplomatic edition of text with displayed image.

indexingcompleteness_md

Compose Markdown for verification of completeness of DSE indexing of a given surface.

indexingcompleteness_md(r, surf; iiif, ict, width, strict)

htmltoken

Format an orthographic token in HTML.

htmltoken(psg, tokentype, ok)

Adds appropriate whitespace to non-punctuation tokens, and wraps orthographically failed tokens in span element.

Internal functions

EditorsRepo.xmlfiles

xmlfiles(repository)

Find names of XML files in editing directory.

EditorsRepo.textpassages

Select from a corpus those matching a given URN, omitting ref passages conventionally used for non-textual metadata.

textpassages(c, u; skipref)

EditorsRepo.isref

True if last component of CTS URN passage is “ref”. MID convention is to exclude elements, like notes on HMT scholia, with this identifier.

isref(urn)

EditorsRepo.passages_for_tokens

Create a list of CitablePassages from a list of OrthographicTokens and a passage URN.

passages_for_tokens(tkns, urn)

Passage URNs are extended with an additional level of citation for the individual token. This citation tier is made up of sequential numbers for lexical tokens, and token number + a character for other kinds of tokens (1a, 1b, etc.).

EditorsRepo.analyzedtokens

Compute a list of OrthographicTokens based on the normalized edition of all texts in the repository. The result is a list of tuples pairing a citable text passage for the token and its type.

analyzedtokens(r)

For a single token citable as a CitablePassage, find its token class and determine if it is orthographically valid.

analyzedtokens(r, cn)

Returns a tuple of a token type and a boolean value.