Classes
		builtins.object Content AdministrativeRegion BioOrEvent DictionaryUnit DoxographicalItem Editorial MorphologicalPattern Paragraph Riwayat SectionHeader Document Line RouteOrDistance Verse LinePart Age Date Hemistich Hukm Isnad Matn Milestone NamedEntity OpenTagAuto OpenTagUser RouteDist RouteFrom RouteTowa TextPart MagicValue PageNumber SimpleMetadataField   class AdministrativeRegion(Content)     AdministrativeRegion(orig: str)   An administrative region     Method resolution order: AdministrativeRegion Content builtins.object Methods defined here: __str__(self) Return str(self). Methods inherited from Content: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Age(LinePart)     Age(orig: str, value: str)   A number indicating age in running text     Method resolution order: Age LinePart builtins.object Methods defined here: __init__(self, orig: str, value: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class BioOrEvent(Content)     BioOrEvent(orig: str, be_type: str)   Marks a biography or an event     Method resolution order: BioOrEvent Content builtins.object Methods defined here: __init__(self, orig: str, be_type: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Content(builtins.object)     Content(orig: str)   A content structure     Methods defined here: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Date(LinePart)     Date(orig: str, value: str, date_type: str)   A date in running text     Method resolution order: Date LinePart builtins.object Methods defined here: __init__(self, orig: str, value: str, date_type: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class DictionaryUnit(Content)     DictionaryUnit(orig: str, dic_type: str)   Marks a dictionary unit     Method resolution order: DictionaryUnit Content builtins.object Methods defined here: __init__(self, orig: str, dic_type: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Document(builtins.object)     Document(text)   The OpenITI mARkdown document     Methods defined here: __init__(self, text) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). add_content(self, content: oimdp.structures.Content) get_clean_text(self, includeMetadata: bool = False) set_magic_value(self, orig: str) set_simple_metadata_field(self, orig: str, value: str) Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class DoxographicalItem(Content)     DoxographicalItem(orig: str, dox_type: str)   Marks a doxographical section     Method resolution order: DoxographicalItem Content builtins.object Methods defined here: __init__(self, orig: str, dox_type: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Editorial(Content)     Editorial(orig: str)   Marks the beginning of an editorial section     Method resolution order: Editorial Content builtins.object Methods defined here: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Hemistich(LinePart)     Hemistich(orig: str)   Tags the beginning of a hemistic in a verse     Method resolution order: Hemistich LinePart builtins.object Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Hukm(LinePart)     Hukm(orig: str)   A ḥukm part of a riwāyaŧ unit     Method resolution order: Hukm LinePart builtins.object Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Isnad(LinePart)     Isnad(orig: str)   An isnād part of a riwāyaŧ unit     Method resolution order: Isnad LinePart builtins.object Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Line(builtins.object)     Line(orig: str, text_only: str, parts: List[oimdp.structures.LinePart] = None)   A line of text that may contain parts     Methods defined here: __init__(self, orig: str, text_only: str, parts: List[oimdp.structures.LinePart] = None) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). add_part(self, part: oimdp.structures.LinePart) Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class LinePart(builtins.object)     LinePart(orig: str)   A line-level tag     Methods defined here: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class MagicValue(builtins.object)     MagicValue(orig: str)   Magic Value of OpenITI mARkdown file     Methods defined here: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Matn(LinePart)     Matn(orig: str)   A matn part of a riwāyaŧ unit     Method resolution order: Matn LinePart builtins.object Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Milestone(LinePart)     Milestone(orig: str)   Milestone typically used for splitting text in 300-word blocks     Method resolution order: Milestone LinePart builtins.object Methods defined here: __str__(self) Return str(self). Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class MorphologicalPattern(Content)     MorphologicalPattern(orig: str, category: str)   A milestone to tag passages that can be categorized thematically.     Method resolution order: MorphologicalPattern Content builtins.object Methods defined here: __init__(self, orig: str, category: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class NamedEntity(LinePart)     NamedEntity(orig: str, prefix: int, extent: int, text: str, ne_type: str)   A named entity     Method resolution order: NamedEntity LinePart builtins.object Methods defined here: __init__(self, orig: str, prefix: int, extent: int, text: str, ne_type: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class OpenTagAuto(LinePart)     OpenTagAuto(orig: str, resp: str, t_type: str, category: str, review: str)   A custom tag added automatically     Method resolution order: OpenTagAuto LinePart builtins.object Methods defined here: __init__(self, orig: str, resp: str, t_type: str, category: str, review: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class OpenTagUser(LinePart)     OpenTagUser(orig: str, user: str, t_type: str, t_subtype: str, t_subsubtype: str)   A custom tag added by a specific user     Method resolution order: OpenTagUser LinePart builtins.object Methods defined here: __init__(self, orig: str, user: str, t_type: str, t_subtype: str, t_subsubtype: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class PageNumber(builtins.object)     PageNumber(orig: str, vol: str, page: str)   A page and volume number. Can be Content or LinePart object     Methods defined here: __init__(self, orig: str, vol: str, page: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Paragraph(Content)     Paragraph(orig='#')   Marks the beginning of a paragraph     Method resolution order: Paragraph Content builtins.object Methods defined here: __init__(self, orig='#') Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Riwayat(Paragraph)     Riwayat(orig='#')   Riwāyāt unit     Method resolution order: Riwayat Paragraph Content builtins.object Methods inherited from Paragraph: __init__(self, orig='#') Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class RouteDist(LinePart)     RouteDist(orig: str)   Distance of a Route     Method resolution order: RouteDist LinePart builtins.object Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class RouteFrom(LinePart)     RouteFrom(orig: str)   Origin of a Route     Method resolution order: RouteFrom LinePart builtins.object Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class RouteOrDistance(Line)     RouteOrDistance(orig: str, text_only: str, parts: List[oimdp.structures.LinePart] = None)   A route or distance     Method resolution order: RouteOrDistance Line builtins.object Methods inherited from Line: __init__(self, orig: str, text_only: str, parts: List[oimdp.structures.LinePart] = None) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). add_part(self, part: oimdp.structures.LinePart) Data descriptors inherited from Line: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class RouteTowa(LinePart)     RouteTowa(orig: str)   Destination of a Route     Method resolution order: RouteTowa LinePart builtins.object Methods inherited from LinePart: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class SectionHeader(Content)     SectionHeader(orig: str, value: str, level: int)   A section header     Method resolution order: SectionHeader Content builtins.object Methods defined here: __init__(self, orig: str, value: str, level: int) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from Content: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class SimpleMetadataField(builtins.object)     SimpleMetadataField(orig: str, value: str)   A non-machine readable metadata field     Methods defined here: __init__(self, orig: str, value: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class TextPart(LinePart)     TextPart(orig: str)   Phrase-level text     Method resolution order: TextPart LinePart builtins.object Methods defined here: __init__(self, orig: str) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). Data descriptors inherited from LinePart: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Verse(Line)     Verse(orig: str, text_only: str, parts: List[oimdp.structures.LinePart] = None)   A line of poetry     Method resolution order: Verse Line builtins.object Methods inherited from Line: __init__(self, orig: str, text_only: str, parts: List[oimdp.structures.LinePart] = None) Initialize self.  See help(type(self)) for accurate signature. __str__(self) Return str(self). add_part(self, part: oimdp.structures.LinePart) Data descriptors inherited from Line: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)

Data
		List = typing.List Literal = typing.Literal