<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class SiteHelper</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="parser_render_sitehelper.html">Up: Module parser.render.sitehelper</a></li>
<li class="prev"><a href="parser_render_sitehelper.html">Previous: Module parser.render.sitehelper</a></li>
<li class="next"><a href="sdl.html">The SDL Falcon Module.</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">15.8.1</span>Class SiteHelper</h1><p class="brief">Base abstract class for site helpers. </p>
<pre class="prototype">Class SiteHelper( page_name, topnode )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<p>Site helpers are classes used to render items whose rendering is specific to a certain site. For example, inline images and link to file requre a knowledge of the target site that can't be directly embedded in the renderer. </p>
<p>The user of the renderer classes should use class to help rendering those elements whose final format depends on where they should be rendered. </p>
<p>Those are namely: <ul><li>code elements, which may require special formatting. </li><li>link to internal wiki pages, that must be generated by the owning engine. </li><li>Wiki interlinks. </li><li>img elements. </li><li>Link to local file resources. </li><li>plugins. </li></ul></p>
<p>As some of these elements (most notabily the plugins) may require to have some context information, the site helper can be initialized using a entity id or page name, and the syntax top node (or tree root). </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Properties</td></tr>
<tr><td colspan="2"><a href="#page_name">page_name</a></td></tr>
<tr><td colspan="2"><a href="#topnode">topnode</a></td></tr>
</tbody>
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td colspan="2"><a href="#code">code</a></td></tr>
<tr><td colspan="2"><a href="#file">file</a></td></tr>
<tr><td colspan="2"><a href="#iLink">iLink</a></td></tr>
<tr><td colspan="2"><a href="#img">img</a></td></tr>
<tr><td colspan="2"><a href="#pageLink">pageLink</a></td></tr>
<tr><td colspan="2"><a href="#plugin">plugin</a></td></tr>
</tbody>
</table>
<h2>Properties</h2><h3><a name="page_name">page_name</a></h3><h3><a name="topnode">topnode</a></h3><h2>Methods</h2><h3><a name="code">code</a></h3><pre class="prototype">code( v, lang )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="file">file</a></h3><pre class="prototype">file( v )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="iLink">iLink</a></h3><pre class="prototype">iLink( wiki, v )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="img">img</a></h3><pre class="prototype">img( v )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="pageLink">pageLink</a></h3><pre class="prototype">pageLink( v )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="plugin">plugin</a></h3><pre class="prototype">plugin( plugin_name, params, node, isDuringStandout )</pre>
<table class="prototype">
<tbody></tbody>
</table>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="parser_render_sitehelper.html">Up: Module parser.render.sitehelper</a></li>
<li class="prev"><a href="parser_render_sitehelper.html">Previous: Module parser.render.sitehelper</a></li>
<li class="next"><a href="sdl.html">The SDL Falcon Module.</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
