API documentation
Types
CitableText.CtsUrn
— TypeImplementation of the CTS URN. See http://cite-architecture.org/ctsurn/.
CitableText.CitableByCtsUrn
— TypeA value of CitableBase.CitableTrait
that can be used for content citable by CtsUrn
.
CitableText.CtsUrnComparable
— TypeValue for URN comparison trait on CtsUrn
DocStringExtensions
Functions
CitableText.namespace
— Functionnamespace(u)
Extract CTS namespace from a CtsUrn.
Examples
julia>
namespace(CtsUrn("urn:cts:greekLit:tlg0012.tlg001.msA:1.1"))
CitableText.workcomponent
— Functionworkcomponent(u)
Extract work component from a CtsUrn.
Examples
julia>
workcomponent(CtsUrn("urn:cts:greekLit:tlg0012.tlg001.msA:1.1"))
CitableText.passagecomponent
— Functionpassagecomponent(u)
Extract passage component from a CtsUrn.
Examples
julia>
passagecomponent(CtsUrn("urn:cts:greekLit:tlg0012.tlg001.msA:1.1"))
CitableText.passagedepth
— Functionpassagedepth(u)
Count number of levels in the passage hierarchy of a CTS URN.
Examples
julia>
passagedepth(CtsUrn("urn:cts:greekLit:tlg0012.tlg001.msA:1.1"))
CitableText.passageparts
— Functionpassageparts(u)
Extract an array with all the parts of the passage hierarchy of a CTS URN.
Examples
julia>
workparts(CtsUrn("urn:cts:greekLit:tlg0012.tlg001.msA:1.1"))
CitableText.workdepth
— Functionworkdepth(u)
Count number of levels in the work hierarchy of a CTS URN.
Examples
julia>
workdepth(CtsUrn("urn:cts:greekLit:tlg0012.tlg001.msA:1.1"))
CitableText.workparts
— Functionworkparts(u)
Extract an array with all the parts of the work hierarchy of a CTS URN.
Examples
julia>
workparts(CtsUrn("urn:cts:greekLit:tlg0012.tlg001.msA:1.1"))
CitableText.groupid
— FunctionExtract textgroup identifier from u
.
groupid(u)
CitableText.workid
— FunctionExtract work identifier from u
.
workid(u)
CitableBase.versionid
— FunctionUrn subtypes should implement addversion(urn::U, versionid)::U
.
versionid(u)
Extract version identifier from u
.
versionid(u)
CitableText.exemplarid
— FunctionExtract exemplar identifier from u
.
exemplarid(u)
Missing docstring for isrange
. Check Documenter's build log for details.
Missing docstring for range_begin
. Check Documenter's build log for details.
Missing docstring for range_end
. Check Documenter's build log for details.
CitableText.droppassage
— Functiondroppassage(u)
Create a new CtsUrn by dropping the passage component of a given CtsUrn.
Examples
julia>
droppassage(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1-1.10"))
CitableText.addpassage
— Functionaddpassage(u, psg)
Create a new CtsUrn by replacing any passage component in a given CtsUrn with a new passage component.
Examples
julia>
addpassage(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1-1.10"))
Missing docstring for dropversion
. Check Documenter's build log for details.
Missing docstring for addversion
. Check Documenter's build log for details.
CitableText.dropexemplar
— Functiondropexemplar(u)
Create a new CtsUrn by dropping the exemplar part of a given CtsUrn's work component.
Examples
julia>
dropexemplar(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1-1.10"))
CitableText.addexemplar
— Functionaddexemplar(u, ex)
Create a new CtsUrn by replacing any exemplar part of a given CtsUrn's work component with a new exemplar part.
Examples
julia>
addexemplar(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1-1.10"))
CitableText.collapsePassageTo
— FunctioncollapsePassageTo(u, count)
Create a new CtsUrn by collapsing a given CtsUrn's passage hierarchy to a given level.
Examples
julia>
collapsePassageTo(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1-1.10"))
CitableText.collapsePassageBy
— FunctioncollapsePassageBy(u, n)
Create a new CtsUrn by collapsing a given CtsUrn's passage hierarchy by a given number of levels.
Examples
julia>
collapsePassageBy(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1-1.10"))
CitableText.workcontains
— Functionworkcontains(urn1, urn2)
True if work component of urn1
contains or is equal to work component of urn2
.
Examples
julia>
workcontains(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1")
CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1")
)
CitableText.passagecontains
— Functionpassagecontains(urn1, urn2)
True if passage component of urn1
contains or is equal to passage component of urn2
.
Examples
julia>
passagecontains(CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1.1")
CtsUrn("urn:cts:greekLit:tlg0012.tlg001:1")
)