package forester

  1. Overview
  2. Docs
module MethodTable : sig ... end
module Text_modifier : sig ... end
type modifier = Text_modifier.t
type node =
  1. | Text of string
  2. | Verbatim of string
  3. | Subtree of transclusion_opts * tree
  4. | Query of transclusion_opts * t Query.t
  5. | TeX_cs of TeX_cs.t
  6. | Embed_tex of embedded_tex
  7. | Img of string
  8. | If_tex of t * t
  9. | Prim of Prim.t * t
  10. | Object of Symbol.t
and embedded_tex = {
  1. preamble : t;
  2. source : t;
}
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
and tree = {
  1. fm : frontmatter;
  2. body : t;
}
and frontmatter = {
  1. title : t option;
  2. taxon : string option;
  3. authors : Forester_core__.Base.addr list;
  4. contributors : Forester_core__.Base.addr list;
  5. dates : Forester_prelude.Date.t list;
  6. addr : Forester_core__.Base.addr;
  7. metas : (string * t) list;
  8. tags : string list;
  9. physical_parent : Forester_core__.Base.addr option;
  10. designated_parent : Forester_core__.Base.addr option;
  11. source_path : string option;
  12. number : string option;
}
val show_embedded_tex : embedded_tex -> Ppx_deriving_runtime.string
val show_transclusion_opts : transclusion_opts -> Ppx_deriving_runtime.string
val show_frontmatter : frontmatter -> Ppx_deriving_runtime.string
type obj_method = {
  1. body : Syn.t;
  2. self : Symbol.t;
  3. super : Symbol.t;
  4. env : env;
}
type obj = {
  1. prototype : 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 : Text_modifier.t -> 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 : addr:Forester_core__.Base.addr -> frontmatter
val empty_tree : addr:Forester_core__.Base.addr -> tree
val default_transclusion_opts : transclusion_opts
OCaml

Innovation. Community. Security.