{{soju:hello_world(node)}}

Soju is an extension mechanism that lets you create your own user-defined Python functions, and reference them in substitution parameters when your web site is built.

This is a powerful tool that lets you add most of the benefits of dynamic code to a static web site.

The lib/soju.py file is a Python module within a Uriel project where you can create your own user-defined functions.

Once you have a user-defined function in lib/soju.py, you can reference it in the rvalue portion of a {{soju:hello_world(node)}} parameter.

For example, the lib/soju.py file for this documentation site contains the following function:

# {{soju:hello_world(node)}}
def hello_world(node):
    """
    Hello world function.

    Accepts a Node.

    Returns an HTML escaped hello world message.

    """

    return "Hello from lib/soju.py, called from " + escape(node.get_path())

And when we use the {{soju:hello_world(node)}} parameter on this node, it evaluates to:

Hello from lib/soju.py, called from parameters/soju-hello-world

See the Soju section for more information on writing your own user-defined functions.

Tags: parameters, soju, user-defined-python-code