package forester

  1. Overview
  2. Docs
package forester
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Forester_core.SemSource

Sourcemodule MethodTable : sig ... end
Sourcemodule Text_modifier : sig ... end
Sourcetype modifier = Text_modifier.t
Sourcetype node =
  1. | Text of string
  2. | Verbatim of string
  3. | Transclude of transclusion_opts * Forester_core__.Base.addr
  4. | Subtree of transclusion_opts * tree
  5. | Query of transclusion_opts * t Query.t
  6. | Xml_tag of Forester_core__.Base.xml_resolved_qname * (Forester_core__.Base.xml_resolved_qname * t) list * t
  7. | TeX_cs of TeX_cs.t
  8. | Math of Forester_core__.Base.math_mode * t
  9. | Embed_tex of embedded_tex
  10. | Img of string
  11. | If_tex of t * t
  12. | Prim of Prim.t * t
  13. | Object of Symbol.t
  14. | Ref of Forester_core__.Base.addr
Sourceand embedded_tex = {
  1. preamble : t;
  2. source : t;
}
Sourceand 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;
}
Sourceand env
Sourceand tree = {
  1. fm : frontmatter;
  2. body : t;
}
Sourceand 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;
}
Sourcetype obj_method = {
  1. body : Syn.t;
  2. self : Symbol.t;
  3. super : Symbol.t;
  4. env : env;
}
Sourcetype obj = {
  1. prototype : Symbol.t option;
  2. methods : obj_method MethodTable.t;
}
Sourceval is_whitespace : node Range.located -> bool
Sourceval strip_whitespace : node Range.located list -> node Range.located list
Sourceval trim_whitespace : node Range.located list -> node Range.located list
Sourceval sentence_case : node Range.located list -> node Range.located list
Sourceval apply_modifier : Text_modifier.t -> node Range.located list -> node Range.located list
Sourceval string_of_nodes : t -> string

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

Sourcemodule Util : sig ... end
Sourcemodule Query : sig ... end
Sourceval empty_frontmatter : addr:Forester_core__.Base.addr -> frontmatter
Sourceval empty_tree : addr:Forester_core__.Base.addr -> tree
Sourceval default_transclusion_opts : transclusion_opts