package stog
Module Stog.Types
Types.
module XR = Xtmpl.Rewritemodule Xml = Xtmpl.Xmltype date = Date.ttype body = XR.tree listtype def = XR.name * XR.attributes * bodyval get_def : def list -> XR.name -> (XR.attributes * body) optiontype doc = {doc_path : Path.path;doc_parent : Path.path option;doc_children : Path.path list;doc_type : string;doc_prolog : Xml.prolog option;doc_body : body;doc_date : date option;doc_title : string;doc_keywords : string list;doc_topics : string list;doc_defs : def list;doc_src : string;doc_sets : string list;(*list of sets ("blog", "foo", etc.) this document belongs to
*)doc_lang_dep : bool;(*whether a file must be generated for each language
*)doc_out : body option;doc_used_mods : Str_set.t;
}val make_doc :
?typ:string ->
?path:Path.path ->
?prolog:Xml.prolog ->
unit ->
docmodule Depset : Set.S with type elt = string dependencytype stog = {stog_dir : string;stog_docs : (doc, doc) Tmap.t;stog_docs_by_path : doc_id Path_trie.t;stog_defs : def list;stog_tmpl_dirs : string list;stog_mod_dirs : string list;stog_cache_dir : string;stog_title : string;stog_desc : body;stog_graph : Graph.t;stog_docs_by_kw : Doc_set.t Str_map.t;stog_docs_by_topic : Doc_set.t Str_map.t;stog_archives : Doc_set.t Int_map.t Int_map.t;stog_base_url : Url.t;stog_email : string;stog_rss_length : int;stog_lang : string option;stog_outdir : string;stog_main_doc : doc_id option;stog_files : file_tree;stog_modules : stog_mod Str_map.t;stog_used_mods : Str_set.t;stog_depcut : bool;stog_deps : stog_dependencies;stog_id_map : (Path.path * string option) Str_map.t Path.Map.t;stog_levels : (string * int list) list Str_map.t;stog_publish_only : Filter_types.t option;stog_source : [ `Dir | `File ];
}val create_stog : ?source:[ `Dir | `File ] -> string -> stogval stog_md5 : stog -> stringval make_path : stog -> string -> string listval id_map_add :
stog ->
Path.Map.key ->
Str_map.key ->
Path.path ->
string option ->
stogval map_href :
stog ->
Path.Map.key ->
Str_map.key ->
Path.Map.key * Str_map.keyval map_doc_ref : stog -> doc -> Str_map.key -> doc * Str_map.key