package forester

  1. Overview
  2. Docs
module MethodTable : sig ... end
type node =
  1. | Text of string
  2. | Transclude of transclusion_opts * string
  3. | Subtree of transclusion_opts * tree
  4. | Query of transclusion_opts * t Query.t
  5. | Unresolved of string
  6. | Embed_tex of {
    1. preamble : t;
    2. source : t;
    }
  7. | Img of {
    1. path : string;
    }
  8. | If_tex of t * t
  9. | Prim of Prim.t * t
  10. | Ref of {
    1. addr : string;
    }
and transclusion_opts = {
  1. toc : bool;
  2. show_heading : bool;
  3. show_metadata : bool;
  4. title_override : t option;
  5. taxon_override : string option;
  6. expanded : bool;
  7. numbered : bool;
}
and t = node Range.located list
and env = t Stdlib__Map.Make(Core__.Symbol).t
and tree = {
  1. fm : frontmatter;
  2. body : t;
}
and frontmatter = {
  1. title : t option;
  2. taxon : string option;
  3. authors : string list;
  4. contributors : string list;
  5. dates : Prelude.Date.t list;
  6. addr : string option;
  7. metas : (string * t) list;
  8. tags : string list;
  9. physical_parent : string option;
  10. designated_parent : string option;
  11. source_path : string option;
  12. number : string option;
}
val pp_node : Ppx_deriving_runtime.Format.formatter -> node -> Ppx_deriving_runtime.unit
val pp_transclusion_opts : Ppx_deriving_runtime.Format.formatter -> transclusion_opts -> Ppx_deriving_runtime.unit
val show_transclusion_opts : transclusion_opts -> Ppx_deriving_runtime.string
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unit
val pp_env : Ppx_deriving_runtime.Format.formatter -> env -> Ppx_deriving_runtime.unit
val pp_tree : Ppx_deriving_runtime.Format.formatter -> tree -> Ppx_deriving_runtime.unit
val pp_frontmatter : Ppx_deriving_runtime.Format.formatter -> frontmatter -> Ppx_deriving_runtime.unit
val show_frontmatter : frontmatter -> Ppx_deriving_runtime.string
type obj_method = {
  1. body : Syn.t;
  2. self : Core__.Symbol.t;
  3. super : Core__.Symbol.t;
  4. env : env;
}
type obj = {
  1. prototype : Core__.Symbol.t option;
  2. methods : obj_method MethodTable.t;
}
val is_whitespace : node Range.located -> bool
val strip_whitespace : node Range.located list -> node Range.located list
val trim_whitespace : node Range.located list -> node Range.located list
val sentence_case : node Range.located list -> node Range.located list
val apply_modifier : [< `Sentence_case ] option -> node Range.located list -> node Range.located list
val string_of_nodes : t -> string

Best-effort rendering of a nodes as a string, to use in text-only contexts.

module Util : sig ... end
module Query : sig ... end
val empty_frontmatter : frontmatter
val default_transclusion_opts : transclusion_opts
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct