17.8.1Class SiteHelper

Base abstract class for site helpers.

Class SiteHelper( page_name, topnode )

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.

The user of the renderer classes should use class to help rendering those elements whose final format depends on where they should be rendered.

Those are namely:

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).

Properties
page_name
topnode
Methods
code
file
iLink
img
pageLink
plugin

Properties

page_name

topnode

Methods

code

code( v, lang )

file

file( v )

iLink

iLink( wiki, v )

img

img( v )

pageLink

pageLink( v )

plugin

plugin( plugin_name, params, node, isDuringStandout )
Made with http://www.falconpl.org