package stog
Module Stog.Plug
Interface for plugins.
Even if all modules are accessible from dynamically loaded code, this Plug module should remain compatible from one release to another.
module XR = Xtmpl.Rewritemodule Xml = Xtmpl.Xmlval plugin_config_file : Types.stog -> string -> stringplugin_config_file stog plugin_name returns the configuration file for this plugin name, for consistency purpose.
val register_lang : Intl.lang_abbrev -> Intl.lang_data -> unitval register_html_base_rule : Xml.name -> Types.stog XR.callback -> unitregister_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:Types.doc ->
Types.stog ->
'a ->
'a XR.env ->
?loc:Xml.loc ->
string ->
'a * (Types.doc * string * string option) optiondoc_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.
val mk_block_node :
id:string ->
?label:XR.tree list ->
?clas:string ->
title:XR.tree list ->
?counter:string ->
short_fmt:XR.tree list ->
long_fmt:XR.tree list ->
XR.tree list ->
XR.treemk_block_node ... creates a <block ... with the given information.
Dependencies
type dependency = Types.doc Types.dependencyval add_dep : Types.stog -> Types.doc -> dependency -> Types.stogFor a given document, add a dependency on a file or another document.