package forester

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

Module Forester_core.TypesSource

Sourcetype xml_qname = Forester_xml_names.xml_qname = {
  1. prefix : string;
  2. uname : string;
  3. xmlns : string option;
}
Sourcetype 'content vertex =
  1. | Uri_vertex of URI.t
  2. | Content_vertex of 'content
Sourceval vertex_t : 'a Repr.t -> 'a vertex Repr.t
Sourcetype section_flags = {
  1. hidden_when_empty : bool option;
  2. included_in_toc : bool option;
  3. header_shown : bool option;
  4. metadata_shown : bool option;
  5. numbered : bool option;
  6. expanded : bool option;
}
Sourceval section_flags_t : section_flags Repr.t
Sourcetype title_flags = {
  1. empty_when_untitled : bool;
}
Sourceval title_flags_t : title_flags Repr.t
Sourceval default_section_flags : section_flags
Sourcetype 'content xml_attr = {
  1. key : xml_qname;
  2. value : 'content;
}
Sourceval xml_attr_t : 'a Repr.t -> 'a xml_attr Repr.t
Sourcetype 'content xml_elt = {
  1. name : xml_qname;
  2. attrs : 'content xml_attr list;
  3. content : 'content;
}
Sourceval xml_elt_t : 'a Repr.t -> 'a xml_elt Repr.t
Sourcetype attribution_role =
  1. | Author
  2. | Contributor
Sourceval attribution_role_t : attribution_role Repr.t
Sourcetype 'content attribution = {
  1. role : attribution_role;
  2. vertex : 'content vertex;
}
Sourceval attribution_t : 'a Repr.t -> 'a attribution Repr.t
Sourcetype 'content frontmatter = {
  1. uri : URI.t option;
  2. title : 'content option;
  3. dates : Human_datetime.t list;
  4. attributions : 'content attribution list;
  5. taxon : 'content option;
  6. number : string option;
  7. designated_parent : URI.t option;
  8. source_path : string option;
  9. tags : 'content vertex list;
  10. metas : (string * 'content) list;
  11. last_changed : float option;
}
Sourceval frontmatter_t : 'a Repr.t -> 'a frontmatter Repr.t
Sourcetype 'content section = {
  1. frontmatter : 'content frontmatter;
  2. mainmatter : 'content;
  3. flags : section_flags;
}
Sourceval section_t : 'a Repr.t -> 'a section Repr.t
Sourcetype 'content article = {
  1. frontmatter : 'content frontmatter;
  2. mainmatter : 'content;
  3. backmatter : 'content;
}
Sourceval pp_article : 'content. (Ppx_deriving_runtime.Format.formatter -> 'content -> Ppx_deriving_runtime.unit) -> Ppx_deriving_runtime.Format.formatter -> 'content article -> Ppx_deriving_runtime.unit
Sourceval show_article : 'content. (Ppx_deriving_runtime.Format.formatter -> 'content -> Ppx_deriving_runtime.unit) -> 'content article -> Ppx_deriving_runtime.string
Sourceval article_t : 'a Repr.t -> 'a article Repr.t
Sourcetype asset = {
  1. uri : URI.t;
  2. content : string;
}
Sourceval asset_t : asset Repr.t
Sourcetype 'a json_blob_syndication = {
  1. blob_uri : URI.t;
  2. query : (string, 'a vertex) Datalog_expr.query;
}
Sourceval json_blob_syndication_t : 'a Repr.t -> 'a json_blob_syndication Repr.t
Sourcetype atom_feed_syndication = {
  1. source_uri : URI.t;
  2. feed_uri : URI.t;
}
Sourceval show_atom_feed_syndication : atom_feed_syndication -> Ppx_deriving_runtime.string
Sourceval atom_feed_syndication_t : atom_feed_syndication Repr.t
Sourcetype 'content syndication =
  1. | Json_blob of 'content json_blob_syndication
  2. | Atom_feed of atom_feed_syndication
Sourceval syndication_t : 'a Repr.t -> 'a syndication Repr.t
Sourcetype 'content resource =
  1. | Article of 'content article
  2. | Asset of asset
  3. | Syndication of 'content syndication
Sourceval resource_t : 'a Repr.t -> 'a resource Repr.t
Sourcetype 'content forest = 'content resource list
Sourceval forest_t : 'a Repr.t -> 'a resource list Repr.t
Sourcetype content_target =
  1. | Full of section_flags
  2. | Mainmatter
  3. | Title of title_flags
  4. | Taxon
Sourceval pp_content_target : Ppx_deriving_runtime.Format.formatter -> content_target -> Ppx_deriving_runtime.unit
Sourceval show_content_target : content_target -> Ppx_deriving_runtime.string
Sourceval content_target_t : content_target Repr.t
Sourcetype transclusion = {
  1. href : URI.t;
  2. target : content_target;
}
Sourceval transclusion_t : transclusion Repr.t
Sourcetype artefact_source = {
  1. type_ : string;
  2. part : string;
  3. source : string;
}
Sourceval artefact_source_t : artefact_source Repr.t
Sourcetype 'content artefact = {
  1. hash : string;
  2. content : 'content;
  3. sources : artefact_source list;
}
Sourceval artefact_t : 'a Repr.t -> 'a artefact Repr.t
Sourcetype 'content content_node =
  1. | Text of string
  2. | CDATA of string
  3. | Xml_elt of 'content xml_elt
  4. | Transclude of transclusion
  5. | Contextual_number of URI.t
  6. | Section of 'content section
  7. | KaTeX of Forester_core__.Base.math_mode * 'content
  8. | Link of 'content link
  9. | Artefact of 'content artefact
  10. | Uri of URI.t
  11. | Route_of_uri of URI.t
  12. | Datalog_script of (string, 'content vertex) Datalog_expr.script
  13. | Results_of_datalog_query of (string, 'content vertex) Datalog_expr.query
Sourceval pp_content_node : 'content. (Ppx_deriving_runtime.Format.formatter -> 'content -> Ppx_deriving_runtime.unit) -> Ppx_deriving_runtime.Format.formatter -> 'content content_node -> Ppx_deriving_runtime.unit
Sourceval show_content_node : 'content. (Ppx_deriving_runtime.Format.formatter -> 'content -> Ppx_deriving_runtime.unit) -> 'content content_node -> Ppx_deriving_runtime.string
Sourceval content_node_t : 'a Repr.t -> 'a content_node Repr.t
Sourcetype content =
  1. | Content of content content_node list
Sourceval pp_content : Ppx_deriving_runtime.Format.formatter -> content -> Ppx_deriving_runtime.unit
Sourceval show_content : content -> Ppx_deriving_runtime.string
Sourceval content_t : content Repr.t
Sourceval compress_nodes : 'a content_node list -> 'a content_node list
Sourceval compress_content : content -> content
Sourceval concat_compressed_content : content -> content -> content
Sourceval html_elt : string -> 'content -> 'content content_node
Sourceval prim : Prim.t -> 'content -> 'content content_node
Sourceval map_content : (content content_node list -> content content_node list) -> content -> content
Sourceval extract_content : content -> content content_node list
Sourcetype dx_query = (string, content vertex) Datalog_expr.query
Sourceval is_whitespace : 'a content_node -> bool
Sourceval strip_whitespace : content -> content
Sourceval trim_whitespace : 'a content_node list -> 'a content_node list
Sourceval default_frontmatter : ?uri:URI.t -> ?source_path:string -> ?designated_parent:URI.t -> ?dates:Human_datetime.t list -> ?attributions:'a attribution list -> ?taxon:'a -> ?number:string -> ?metas:(string * 'a) list -> ?tags:'a vertex list -> ?title:'a -> ?last_changed:float -> unit -> 'a frontmatter
Sourceval article_to_section : ?flags:section_flags -> content article -> content section
Sourceval uri_for_syndication : 'a syndication -> URI.t option
Sourceval uri_for_resource : 'a resource -> URI.t option
Sourcemodule Comparators (I : sig ... end) : sig ... end