Stog library reference documentation : Stog_plug

Module Stog_plug

module Stog_plug: sig .. end
Interface for plugins.
Even if all modules are accessible from dynamically loaded code, this Stog_plug module should remain compatible from one release to another.

val plugin_config_file : Stog_types.stog -> string -> string
plugin_config_file stog plugin_name returns the configuration file for this plugin name, for consistency purpose.
val register_lang : Stog_intl.lang_abbrev -> Stog_intl.lang_data -> unit
val register_html_base_rule : Xmlm.name -> Stog_types.stog Xtmpl.callback -> unit
register_html_base_rule name f registers a new function associated to name in the set of base rules of the "html" predefined module.
val doc_by_href : ?typ:string ->
?src_doc:Stog_types.doc ->
Stog_types.stog ->
'a ->
'a Xtmpl.env ->
string -> 'a * (Stog_types.doc * string * string option) option
doc_by_href ?typ ?src_doc stog env href returns the document, path and optional if matching the given href string, of the form path[#id]. Return None if the document could not be found, of the id could not be found, and an error is issued.
src_doc : can be used to specify the source document, to improve the error message.
val mk_block_node : id:string ->
?label:Xtmpl.tree list ->
?clas:string ->
title:Xtmpl.tree list ->
?counter:string ->
short_fmt:Xtmpl.tree list ->
long_fmt:Xtmpl.tree list -> Xtmpl.tree list -> Xtmpl.tree
mk_block_node ... creates a <block ... with the given information.

Outputting message.

val verbose : ?info:string -> ?level:int -> string -> unit
val set_print_verbose : (string -> unit) -> unit
val warning : ?info:string -> string -> unit
val set_print_warning : (string -> unit) -> unit
val error : ?info:string -> ?fatal:int -> string -> unit
val set_print_error : (string -> unit) -> unit

Dependencies

type dependency = Stog_types.doc Stog_types.dependency 
val add_dep : Stog_types.stog -> Stog_types.doc -> dependency -> Stog_types.stog
For a given document, add a dependency on a file or another document.