module Stog_tmpl: sig
.. end
Default templates.
type contents = Stog_types.stog -> Stog_types.stog * Xtmpl.tree
exception Template_file_not_found of string
val get_template_file : Stog_types.stog -> Stog_types.doc -> 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 Template_file_not_found
if no include directory contains the
given file (when the file is relative an implicit).
val read_template_file : Stog_types.stog ->
Stog_types.doc ->
?depend:bool -> ?raw:bool -> string -> Stog_types.stog * Xtmpl.tree
depend
: indicate whether to add a dependency from the document
on the file. Default is true
.
raw
: indicate whether to read the template as XML (false
) or
as CData (true
). Default is false
.
val get_template : Stog_types.stog ->
?doc:Stog_types.doc ->
contents -> string -> Stog_types.stog * Xtmpl.tree
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
: contents
: contents