Module Stog_writingSource

Sourceval module_name : string
Sourceval info : ((?loc:Xtmpl.Types.loc -> ?tags:Logs.Tag.set -> ('a, Format.formatter, unit, unit) format4 -> 'a) -> unit) -> unit
Sourceval warn : ((?loc:Xtmpl.Types.loc -> ?tags:Logs.Tag.set -> ('a, Format.formatter, unit, unit) format4 -> 'a) -> unit) -> unit
Sourceval err : ((?loc:Xtmpl.Types.loc -> ?tags:Logs.Tag.set -> ('a, Format.formatter, unit, unit) format4 -> 'a) -> unit) -> unit
Sourceval rc_file : Stog.Types.stog -> string
Sourcetype auto_id_spec =
module XR = Xtmpl.Rewrite
module XH = Xtmpl.Xhtml
module Xml = Xtmpl.Xml
module W = Ocf.Wrapper
module J = Yojson.Safe
Sourceval smap_wrapper : 'a W.t -> 'a Smap.t W.t
Sourceval auto_id_spec_wrapper : auto_id_spec Ocf.Wrapper.t
Sourceval default_tags : auto_id_spec Smap.t
Sourcetype spec = {
  1. tags : auto_id_spec Smap.t;
}
Sourceval default_spec : spec
Sourceval spec_wrapper : bool -> spec W.t
Sourcetype auto_ids = {
  1. default : spec;
  2. by_type : spec Smap.t;
}
Sourceval default_auto_ids : auto_ids
Sourceval auto_ids_wrapper : auto_ids Ocf.Wrapper.t
Sourcetype wdata = {
  1. auto_ids : auto_ids;
  2. bib_entries : (Stog.Path.path * Stog_writing__.Bibtex.entry) Smap.t;
  3. bibs_by_path : Stog_writing__.Bibtex.entry list Smap.t Stog.Path.Map.t;
  4. generated_by_doc : Stog.Types.Str_set.t Stog.Path.Map.t;
}
Sourceval empty_data : wdata
Sourceval load_config : 'a -> (Stog.Types.stog * wdata) -> 'b -> Stog.Types.stog * wdata

Notes

Sourceval note_source_id : int -> string
Sourceval note_target_id : int -> string
Sourceval fun_prepare_notes : 'a -> 'b -> ?loc:'c -> 'd -> XR.tree list -> 'a * XR.tree list
Sourceval rules_notes : ((string * string) * ('a -> 'b -> ?loc:'c -> 'd -> XR.tree list -> 'a * XR.tree list)) list
Sourceval fun_level_notes : wdata Stog.Engine.level_fun

Bibliographies

Sourceval add_bib_entry : wdata -> Stog.Path.path -> Stog_writing__.Bibtex.entry -> wdata
Sourceval bib_entries_of_file : ?prefix:string -> ?loc:(Lexing.position * Lexing.position) -> string -> Stog_writing__.Bibtex.entry list
Sourceval get_bib_entry_field : Stog_writing__.Bibtex.entry -> string -> string
Sourceval sort_bib_entries : string list -> bool -> Stog_writing__.Bibtex.entry list -> Stog_writing__.Bibtex.entry list
Sourceval add_bibliography : ?name:Smap.key -> ?sort:string -> ?reverse:bool -> ?prefix:string -> ?loc:(Lexing.position * Lexing.position) -> Stog.Types.doc -> (wdata * Stog_writing__.Bibtex.entry list Smap.t * int) -> string -> wdata * Stog_writing__.Bibtex.entry list Smap.t * int
Sourceval fun_level_init : wdata Stog.Engine.level_fun
Sourceval fun_bib_field : Stog_writing__.Bibtex.entry -> 'a -> 'b -> ?loc:'c -> XR.attributes -> 'd -> 'a * XR.tree list
Sourceval add_bib_entry_env : 'a XR.env -> Stog_writing__.Bibtex.entry -> 'a XR.env
Sourceval xml_of_format : string -> XR.X.tree list
Sourceval escape_bib_entry_id : string -> string
Sourceval mk_bib_entry_anchor : Stog_writing__.Bibtex.entry -> string
Sourceval mk_bib_entry_link : 'a -> Stog.Path.path -> Stog_writing__.Bibtex.entry -> XR.tree list -> XR.tree
Sourceval fun_cite : ('a * wdata) -> ('a * wdata) XR.env -> ?loc:'b -> XR.attributes -> XR.attr_value -> ('a * wdata) * XR.attr_value
Sourceval xml_of_bib_entry : (Stog.Types.stog * 'a) XR.env -> Stog.Types.doc_id -> Stog.Types.doc -> ((Stog.Types.stog * 'a) * Xtmpl.Rewrite.tree list) -> Stog_writing__.Bibtex.entry -> (Stog.Types.stog * 'a) * Xtmpl.Rewrite.tree list
Sourceval get_in_env : 'a -> 'a Stog.Html.XR.env -> Stog.Html.Xml.name -> 'a * Stog.Html.XR.tree list
Sourceval get_in_args_or_env : 'a -> 'a Stog.Engine.XR.env -> Stog.Engine.XR.attributes -> Stog.Types.Xml.name -> 'a * Stog.Engine.XR.tree list
Sourceval get_path : 'a -> 'a Stog.Html.XR.env -> 'a * Stog.Path.path
Sourceval fun_bibliography : Stog.Types.doc Stog.Tmap.key -> (Stog.Types.stog * wdata) -> (Stog.Types.stog * wdata) Stog.Html.XR.env -> ?loc:(Lexing.position * Lexing.position) -> XR.attributes -> 'a -> (Stog.Types.stog * wdata) * Xtmpl.Rewrite.tree list
Sourceval rules_bib : 'a -> Stog.Types.doc Stog.Tmap.key -> ((string * string) * ((Stog.Types.stog * wdata) -> (Stog.Types.stog * wdata) Stog.Html.XR.env -> ?loc:(Lexing.position * Lexing.position) -> XR.attributes -> XR.attr_value -> (Stog.Types.stog * wdata) * XR.attr_value)) list

Adding references to paragraphs and handling blocks (like environments in latex).

Sourceval add_string : Buffer.t -> string -> unit
Sourceval text_of_xml : bool -> Buffer.t -> XR.tree -> unit
Sourceval text_of_atts : Buffer.t -> XR.attributes -> unit
Sourceval text_of_xmls : bool -> Buffer.t -> XR.P.attr_value -> unit
Sourceval max_size : int
Sourceval create_id : XR.P.attr_value -> string
Sourceval fun_p : ?embed:string -> XR.name -> Stog.Types.doc -> ('a * wdata) -> ('a * wdata) XR.env -> ?loc:(Lexing.position * Lexing.position) -> XR.attributes -> XR.P.attr_value -> ('a * wdata) * XR.tree list
Sourceval tags_of_tag_spec : auto_id_spec Smap.t -> (Smap.key * string option) list
Sourceval rules_auto_ids : Stog.Types.stog -> wdata -> Stog.Types.doc Stog.Tmap.key -> (Xtmpl.Xml.Name.t * (('a * wdata) -> ('a * wdata) XR.env -> ?loc:'b -> XR.attributes -> XR.P.attr_value -> ('a * wdata) * XR.tree list)) list
Sourceval fun_level_auto_ids : wdata Stog.Engine.level_fun
Sourceval level_funs : (string * wdata Stog.Engine.level_fun) list
Sourceval default_levels : int list Stog.Types.Str_map.t
Sourceval make_engine : ?levels:(string * int list) list -> unit -> (module Stog.Engine.Module)