package forester

  1. Overview
  2. Docs

Module Forester_core.Xml_treeSource

Sourcetype xml_qname = {
  1. prefix : string;
    (*

    The prefix to a qualified XML name; this prefix is expected to be rendered in the scope of a corresponding xmlns binding.

    *)
  2. uname : string;
    (*

    The unqualified part of the XML name.

    *)
  3. xmlns : string option;
    (*

    The XML namespace bound by the current scope to prefix. This is not used when serialising to XML, but can be helpful for other analyses.

    *)
}
Sourceval xml_qname_t : xml_qname Repr.t
Sourcetype xml_attr = {
  1. key : xml_qname;
  2. value : string;
}
Sourceval xml_attr_t : xml_attr Repr.t
Sourcetype 'content attribution =
  1. | Author of 'content
  2. | Contributor of 'content
Sourceval attribution_t : 'a Repr.t -> 'a attribution Repr.t
Sourcetype date_ = {
  1. addr : Base.addr option;
  2. year : int;
  3. month : int option;
  4. day : int option;
}
Sourceval date__t : date_ Repr.t
Sourcetype date =
  1. | Date of date_
Sourceval date_t : date Repr.t
Sourcetype 'content meta_ = {
  1. key : string;
  2. body : 'content;
}
Sourceval meta__t : 'a Repr.t -> 'a meta_ Repr.t
Sourcetype 'content meta =
  1. | Meta of 'content meta_
Sourceval meta_t : 'a Repr.t -> 'a meta Repr.t
Sourcetype 'content xml_tag = {
  1. name : xml_qname;
  2. attrs : xml_attr list;
  3. content : 'content;
}
Sourceval xml_tag_t : 'a Repr.t -> 'a xml_tag Repr.t
Sourcetype ref = {
  1. addr : Base.addr;
  2. taxon : string option;
  3. number : string option;
}
Sourceval ref_t : ref Repr.t
Sourcetype tex = {
  1. display : [ `Inline | `Block ];
  2. body : string;
}
Sourceval tex_t : tex Repr.t
Sourcetype img = {
  1. src : string;
}
Sourceval img_t : img Repr.t
Sourcetype embedded_tex = {
  1. hash : string;
  2. preamble : string;
  3. source : string;
}
Sourceval embedded_tex_t : embedded_tex Repr.t
Sourcetype ('content, 'tree) content_node =
  1. | Text of string
  2. | CDATA of string
  3. | Xml_tag of 'content xml_tag
  4. | Prim of Prim.t * 'content
  5. | Subtree of 'tree
  6. | Ref of ref
  7. | Local_link of 'content local_link
  8. | External_link of 'content external_link
  9. | TeX of tex
  10. | Img of img
  11. | Embedded_tex of embedded_tex
  12. | Info of string
Sourceval content_node_t : 'a Repr.t -> 'b Repr.t -> ('a, 'b) content_node Repr.t
Sourcetype 'content frontmatter = {
  1. title : 'content option;
  2. title_text : string option;
  3. anchor : string option;
  4. number : string option;
  5. taxon : string option;
  6. designated_parent : string option;
  7. metas : 'content meta list;
  8. addr : Base.addr option;
  9. source_path : string option;
  10. dates : date list;
  11. last_changed : date option;
  12. attributions : 'content attribution list;
}
Sourceval frontmatter_t : 'a Repr.t -> 'a frontmatter Repr.t
Sourcetype tree_options = {
  1. toc : bool;
  2. numbered : bool;
  3. show_heading : bool;
  4. show_metadata : bool;
  5. expanded : bool;
  6. root : bool;
}
Sourceval tree_options_t : tree_options Repr.t
Sourcetype 'content tree = {
  1. options : tree_options;
  2. frontmatter : 'content frontmatter;
  3. mainmatter : 'content;
  4. backmatter : 'content tree list;
}
Sourceval tree_t : 'a Repr.t -> 'a tree Repr.t
Sourcetype tree_ =
  1. | Tree of content tree
Sourceand content =
  1. | Content of (content, tree_) content_node list
Sourceval tree__t : tree_ Repr.t
Sourceval content_t : content Repr.t
Sourceval splice : content -> (content, tree_) content_node list
Sourceval splice_tree : tree_ -> content tree