wiki:TracLegosTemplates

TracLegos Templates

TracLegos is designed to be a templating engine for Trac projects. More than one template can be specified in which case the templates are applied in order -- that is, latter templates override trac.ini values from earlier templates.

source:traclegosscript/anyrelease/image/template_aggregation.png

The image shows an example of the application of three templates to create a Trac project. The first template applied, OSS Trac Project, is a skeleton for a trac project. The second template is a (hypothetical) template that applies configuration for Plugin 'A'. This illustrates the value of allowing arbitrary configuration -- a template can be as specific or as general as needed (that is, any portion of the trac.ini may be contained in the template). Both of these templates are generic -- they contain configuration that is agnostic to a specific site or organization. This generic configuration is augmented by the Site Configuration, which contains parameters specific to the site and organization. Any number of these can be applied.

The templates are implied in order, values from latter templates overwriting earlier ones. From the aggregated configuration, a trac project is made using supplied variables.

Convention-based Variables

With a few exceptions (e.g. project), TracLegos does no sort of enforcing of similarity of template parameters. TracLegos asserts a convention-based system where template authors are encouraged to use a convention that works with them and the world at large. For example, the OSS Trac project template uses a variable, $basedir, that defines a base directory relative to which it defines by convention several file locations. If this pattern fits the use case for a new template, keeping the variable name intact allows site configuration and other locations addressing variables by name to work as expected whereas renaming the variable would require more work to incorporate it into existing instances. However, if this convention did not work for your template, then you should use a convention that does, preferably with a variable name that is unambiguous. TracLegos uses a flat namespace for simplicity and is not slated to move towards namespacing variables.

Last modified 6 years ago Last modified on Feb 10, 2009 12:17:37 AM