<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <ocamldoc with-contents="true"> <title>Stog library reference documentation : Stog_tmpl</title><contents><div class="ocamldoc-page"> <div class="navbar"><a class="pre" href="Stog_deps.html" title="Stog_deps">Previous</a>  <a class="up" href="index.html" title="Index">Up</a>  <a class="post" href="Stog_cache.html" title="Stog_cache">Next</a> </div> <h1>Module <a href="type_Stog_tmpl.html">Stog_tmpl</a></h1> <pre><span class="keyword">module</span> Stog_tmpl: <code class="code">sig</code> <a href="Stog_tmpl.html">..</a> <code class="code">end</code></pre><div class="info"> Default templates.<br/> </div> <hr width="100%"/> <pre><span id="TYPEcontents"><span class="keyword">type</span> contents</span> = <code class="type"><a href="Stog_types.html#TYPEstog">Stog_types.stog</a> -> Xtmpl.tree</code> </pre> <pre><span id="VALget_template_file"><span class="keyword">val</span> get_template_file</span> : <code class="type"><a href="Stog_types.html#TYPEstog">Stog_types.stog</a> -> <a href="Stog_types.html#TYPEelt">Stog_types.elt</a> -> string -> string</code></pre><div class="info"> <code class="code">get_template_file stog elt file</code> returns absolute filename of the given template filename. If <code class="code">file</code> is relative and implicit then it is concatenated to the stog template directory. If <code class="code">file</code> is relative and not implicit (i.e. it starts with . or ..), it is concatenated to the element source file directory. Else (the filename is absolute), it is returned as is.<br/> </div> <pre><span id="VALread_template_file"><span class="keyword">val</span> read_template_file</span> : <code class="type"><a href="Stog_types.html#TYPEstog">Stog_types.stog</a> -> <a href="Stog_types.html#TYPEelt">Stog_types.elt</a> -> ?raw:bool -> string -> Xtmpl.tree</code></pre><div class="info"> <code class="code">read_template_file stog elt file</code> returns the content of the given template filename, after calling <a href="Stog_tmpl.html#VALget_template_file"><code class="code">Stog_tmpl.get_template_file</code></a> to get the final filename.<br/> </div> <div class="param_info"><code class="code">raw</code> : indicate whether to read the template as XML (<code class="code">false</code>) or as CData (<code class="code">true</code>). Default is <code class="code">false</code>.</div> <pre><span id="VALget_template"><span class="keyword">val</span> get_template</span> : <code class="type"><a href="Stog_types.html#TYPEstog">Stog_types.stog</a> -><br/> ?elt:<a href="Stog_types.html#TYPEelt">Stog_types.elt</a> -> <a href="Stog_tmpl.html#TYPEcontents">contents</a> -> string -> Xtmpl.tree</code></pre><pre><span id="VALpage"><span class="keyword">val</span> page</span> : <code class="type"><a href="Stog_tmpl.html#TYPEcontents">contents</a></code></pre><pre><span id="VALby_keyword"><span class="keyword">val</span> by_keyword</span> : <code class="type"><a href="Stog_tmpl.html#TYPEcontents">contents</a></code></pre><pre><span id="VALby_topic"><span class="keyword">val</span> by_topic</span> : <code class="type"><a href="Stog_tmpl.html#TYPEcontents">contents</a></code></pre><pre><span id="VALby_month"><span class="keyword">val</span> by_month</span> : <code class="type"><a href="Stog_tmpl.html#TYPEcontents">contents</a></code></pre><pre><span id="VALelt_in_list"><span class="keyword">val</span> elt_in_list</span> : <code class="type"><a href="Stog_tmpl.html#TYPEcontents">contents</a></code></pre><pre><span id="VALkeyword"><span class="keyword">val</span> keyword</span> : <code class="type"><a href="Stog_tmpl.html#TYPEcontents">contents</a></code></pre><pre><span id="VALtopic"><span class="keyword">val</span> topic</span> : <code class="type"><a href="Stog_tmpl.html#TYPEcontents">contents</a></code></pre></div></contents></ocamldoc>
