package stog

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Dependencies

stog
- Stog
  - Blocks
    
    Smap
  - Config
  - Cut
  - Date
  - Deps
  - Doclist
  - Dyn
  - Engine
    
    Module
  - Error
  - Exec
  - Filter
  - Filter_lexer
  - Filter_parser
  - Filter_types
  - Find
  - Graph
    
    GMap
    
    Make
    
    Edge
    
    M
    
    Make_with_map
    
    Edge
    
    P
    
    S
  - Highlight
  - Html
  - Html5
  - Info
  - Init
  - Install
    
    Sites
  - Intl
  - Io
  - Latex
  - Log
  - Ocaml
  - Of_latex
    
    SMap
  - Path
    
    Map
    
    Set
  - Plug
  - Server_mode
  - Svg
  - Tags
  - Tmap
    
    S
  - Tmpl
  - Trie
    
    Make
    
    P
    
    S
  - Types
    
    Depset
    
    Doc_set
    
    Graph
    
    Int_map
    
    Int_set
    
    Path_trie
    
    Str_map
    
    Str_set
  - Url
  - Version
stog.base
- Stog_base
  - Misc
  - Ocaml_types
stog.main
- Stog_main
stog.ocaml_session_main
- Stog_ocaml_session_main

Legend:
Library
Module
Module type
Parameter
Class
Class type

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.Rewrite

module Xml = Xtmpl.Xml

val plugin_config_file : Types.stog -> string -> string

plugin_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 -> unit

val register_html_base_rule : Xml.name -> Types.stog XR.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:Types.doc ->
  Types.stog ->
  'a ->
  'a XR.env ->
  ?loc:Xml.loc ->
  string ->
  'a * (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.

parameter src_doc
can be used to specify the source document, to improve the error message.

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.tree

mk_block_node ... creates a <block ... with the given information.

Dependencies

type dependency = Types.doc Types.dependency

val add_dep : Types.stog -> Types.doc -> dependency -> Types.stog

For a given document, add a dependency on a file or another document.