KTextTemplate::Engine Class

Detailed Description

The KTextTemplate::Engine is responsible for configuring and creating Template objects. In typical use, one or more AbstractTemplateLoader objects will be added to the Engine to load template objects, and plugin directories will be set to enable finding template tags and filters.

auto engine = new Engine();

auto loader = QSharedPointer<FileSystemTemplateLoader>::create();
loader->setTemplateDirs( {"/usr/share/myapp/templates"} );
engine->addTemplateLoader( loader );

engine->addPluginPath( "/usr/lib/myapp" );

auto template1 = engine->newTemplate( "Template content", "template name" );

auto template2 = engine->loadByName( "templatefile.html" );

Once it is configured, the Engine can be used to create new templates by name by loading the templates with the loadByName method, or by defining the content in the newTemplate method.

By default the builtin tags and filters distributed with KTextTemplate are available in all templates without using the {% load %} tag in the template. These pre-loaded libraries may be configured if appropriate to the application. For example, an application which defines its own tags and filters may want them to be always available, or it may be desirable to restrict the features available to template authors by removing built in libraries.

Different Engine objects can be used to create templates with differing configurations.

Insignificant whitespace

The output of rendering a template depends on the content of the template. In some cases when generating content in which whitespace is significant, this can have undesired effects. For example, given a template to generate C++ code like:

class MyClass {
{# This loop creates the  #}
{# methods in the class   #}
{% for method in methods %}
  {% if method.hasDox %}
    {{ method.dox }}
  {% endif %}
    {{ method.signature }}
{% endfor %}
};

The output would have a lot of whitespace which is not necessarily wanted.

class MyClass {




  void foo() const;

};

It is possible to strip insignificant whitespace by enabling the smartTrim feature with setSmartTrimEnabled. When enabled the output will not contain a newline for any line in the template which has only one token of template syntax, such as a comment, tag or variable.

class MyClass {

  void foo() const;
};