<ocamldoc with-contents="true"><title>Stog library reference documentation : Stog_plug</title><contents><div class="ocamldoc-page">
<code class="code"><span class="keyword">sig</span><br/>
&#160;&#160;<span class="keyword">val</span>&#160;plugin_config_file&#160;:&#160;<span class="constructor">Stog_types</span>.stog&#160;<span class="keywordsign">-&gt;</span>&#160;string&#160;<span class="keywordsign">-&gt;</span>&#160;string<br/>
&#160;&#160;<span class="keyword">val</span>&#160;register_lang&#160;:&#160;<span class="constructor">Stog_intl</span>.lang_abbrev&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_intl</span>.lang_data&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;register_rule&#160;:&#160;<span class="constructor">Xmlm</span>.name&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Xtmpl</span>.callback&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;unregister_rule&#160;:&#160;<span class="constructor">Xmlm</span>.name&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Xtmpl</span>.callback&#160;option<br/>
&#160;&#160;<span class="keyword">val</span>&#160;stog&#160;:&#160;unit&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_types</span>.stog<br/>
&#160;&#160;<span class="keyword">val</span>&#160;elt_by_href&#160;:<br/>
&#160;&#160;&#160;&#160;?typ:string&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_types</span>.stog&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Xtmpl</span>.env&#160;<span class="keywordsign">-&gt;</span>&#160;string&#160;<span class="keywordsign">-&gt;</span>&#160;(<span class="constructor">Stog_types</span>.elt&#160;*&#160;string&#160;*&#160;string&#160;option)&#160;option<br/>
&#160;&#160;<span class="keyword">val</span>&#160;add_block&#160;:<br/>
&#160;&#160;&#160;&#160;?on_dup:[&#160;<span class="keywordsign">`</span><span class="constructor">Fail</span>&#160;<span class="keywordsign">|</span>&#160;<span class="keywordsign">`</span><span class="constructor">Ignore</span>&#160;<span class="keywordsign">|</span>&#160;<span class="keywordsign">`</span><span class="constructor">Warn</span>&#160;]&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;hid:string&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;id:string&#160;<span class="keywordsign">-&gt;</span>&#160;short:<span class="constructor">Xtmpl</span>.tree&#160;<span class="keywordsign">-&gt;</span>&#160;long:<span class="constructor">Xtmpl</span>.tree&#160;<span class="keywordsign">-&gt;</span>&#160;unit&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;verbose&#160;:&#160;?info:string&#160;<span class="keywordsign">-&gt;</span>&#160;?level:int&#160;<span class="keywordsign">-&gt;</span>&#160;string&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;set_print_verbose&#160;:&#160;(string&#160;<span class="keywordsign">-&gt;</span>&#160;unit)&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;warning&#160;:&#160;?info:string&#160;<span class="keywordsign">-&gt;</span>&#160;string&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;set_print_warning&#160;:&#160;(string&#160;<span class="keywordsign">-&gt;</span>&#160;unit)&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;error&#160;:&#160;?info:string&#160;<span class="keywordsign">-&gt;</span>&#160;?fatal:int&#160;<span class="keywordsign">-&gt;</span>&#160;string&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;set_print_error&#160;:&#160;(string&#160;<span class="keywordsign">-&gt;</span>&#160;unit)&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;register_stage0_fun&#160;:&#160;(<span class="constructor">Stog_types</span>.stog&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_types</span>.stog)&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">type</span>&#160;rule_build&#160;=<br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Stog_types</span>.stog&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Stog_types</span>.elt_id&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Stog_types</span>.elt&#160;<span class="keywordsign">-&gt;</span>&#160;(<span class="constructor">Xmlm</span>.name&#160;*&#160;<span class="constructor">Xtmpl</span>.callback)&#160;list<br/>
&#160;&#160;<span class="keyword">type</span>&#160;level_fun&#160;=<br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Xtmpl</span>.env&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Stog_types</span>.stog&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Stog_types</span>.elt_id&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_types</span>.elt&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_types</span>.elt<br/>
&#160;&#160;<span class="keyword">type</span>&#160;level_fun_on_elt_list&#160;=<br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Xtmpl</span>.env&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;&#160;<span class="constructor">Stog_types</span>.stog&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;&#160;(<span class="constructor">Stog_types</span>.elt_id&#160;*&#160;<span class="constructor">Stog_types</span>.elt)&#160;list&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;&#160;(<span class="constructor">Stog_types</span>.elt_id&#160;*&#160;<span class="constructor">Stog_types</span>.elt)&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;register_level_fun&#160;:&#160;int&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_plug</span>.level_fun&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;compute_elt&#160;:&#160;<span class="constructor">Stog_plug</span>.rule_build&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_plug</span>.level_fun<br/>
&#160;&#160;<span class="keyword">val</span>&#160;register_level_fun_on_elt_list&#160;:<br/>
&#160;&#160;&#160;&#160;int&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_plug</span>.level_fun_on_elt_list&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;register_cache&#160;:&#160;(<span class="keyword">module</span>&#160;<span class="constructor">Stog_cache</span>.<span class="constructor">Cache</span>)&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
&#160;&#160;<span class="keyword">type</span>&#160;dependency&#160;=&#160;<span class="constructor">Stog_deps</span>.dependency&#160;=&#160;<span class="constructor">File</span>&#160;<span class="keyword">of</span>&#160;string&#160;<span class="keywordsign">|</span>&#160;<span class="constructor">Elt</span>&#160;<span class="keyword">of</span>&#160;string<br/>
&#160;&#160;<span class="keyword">val</span>&#160;add_dep&#160;:&#160;<span class="constructor">Stog_types</span>.elt&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_plug</span>.dependency&#160;<span class="keywordsign">-&gt;</span>&#160;unit<br/>
<span class="keyword">end</span></code></div></contents></ocamldoc>