package stog

You can search for identifiers within the package.

in-package search v0.2.0

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

Default templates.

type contents = Types.stog -> Types.stog * Xtmpl.Rewrite.tree list

val get_template_file : 
  Types.stog ->
  Types.doc ->
  ?loc:Xtmpl.Xml.loc ->
  string ->
  string

get_template_file stog doc file returns absolute filename of the given template filename. If file is relative and implicit then the file is looked up the stog include directories. If file is relative and not implicit (i.e. it starts with . or ..), it is concatenated to the document source file directory. Else (the filename is absolute), it is returned as is.

raises Error.Template_file_not_found
if no include directory contains the given file (when the file is relative an implicit).

val read_template_file : 
  Types.stog ->
  Types.doc ->
  ?depend:bool ->
  ?raw:bool ->
  ?loc:Xtmpl.Xml.loc ->
  string ->
  Types.stog * Xtmpl.Rewrite.tree list

read_template_file stog doc file returns the content of the given template filename, after calling get_template_file to get the final filename.

parameter raw
indicate whether to read the template as XML (false) or as CData (true). Default is false.

parameter depend
indicate whether to add a dependency from the document on the file. Default is true.

raises Error.Template_file_not_found
(see get_template_file)

val get_template : 
  Types.stog ->
  ?doc:Types.doc ->
  contents ->
  string ->
  Types.stog * Xtmpl.Rewrite.tree list

val get_template_doc : 
  Types.stog ->
  ?doc:Types.doc ->
  contents ->
  string ->
  Types.stog * Xtmpl.Rewrite.tree Xtmpl.Xml.doc

val page : contents

val by_keyword : contents

val by_topic : contents

val by_month : contents

val doc_in_list : contents

val keyword : contents

val topic : contents

val rss : contents

val rss_item : contents

val doc_list : contents