Skip to the content
Documentation
Version 6.x Supported

[TemplateSettings]

Written by Frederik Holljen, Updated by Graham Brookins
No ratings yet

You can read more about the template system in the templates chapter.

Setting Summary
AutoloadPathList Sets the directories inside eZ publish itself where eZ publish will look for operator and function definitions.
Debug Turns on/off template debug output.
DelayedCacheBlockCleanup Enables delayed removal of expired cache blocks with the "subtree_expiry" parameter.
DevelopmentMode Controls if development is enabled or not.
ExtensionAutoloadPath Sets the extensions that contain template function or operator definitions.
NodeTreeCaching Sets if the template interpreter should cache parsed template files.
ShowMethodDebug Sets if debug information about called functions and operators should be displayed.
ShowUsedTemplates Enables a table in the debug displaying all the templates used to render the current page.
ShowXHTMLCode Sets if eZ publish should display template load debug inline or not.
TemplateCache Main switch for all the template related caches.
TemplateCompile Sets if the template compiler should be used or not.
TemplateCompression Sets if compiled templates should be compressed or not.
TemplateOptimization Sets if the template compiler should try to optimize the produced PHP code.
UseFormatting Sets if the template compiler should keep whitespace in the compiled template.

Changed in Exponential 6.0.15

Settings of this group in the settings files of Exponential 6.0.15 that this page does not describe:

Setting File Default Description
ShowTemplatePathComments settings/site.ini disabled If enabled, wraps every rendered template in HTML comments naming its path, e.g. <!-- START design/media/templates/pagelayout/footer.tpl --> ... <!-- STOP ... --> This mirrors the Symfony/Twig debug output and makes layout debugging and block tracking possible in the legacy pipeline. Works with the template compiler on or off. Development only: it injects markup into every template's output, so it must stay disabled in production and on any siteaccess serving JSON, XML or RSS.
TemplatesWithoutDebugComments settings/site.ini parts/exp_content_direction.tpl Templates that Debug and ShowTemplatePathComments never wrap in comments, by their path below templates/ (a file of that path in any design or extension), like <h1 class="title"{include uri='design:parts/exp_content_direction.tpl' ...}>, which prints into a start tag. Most templates need no entry: the comments are taken out of every rendered output where they would break it (inside a tag or an attribute value, inside <script>, <style>, <title> and <textarea>, and everywhere in output that is not HTML: XML, JSON, plain text), and a set-block that captures a value rather than HTML (a name, a URL, attributes, nothing) gets no comments. List a template whose output reaches the page some other way, e.g. through an operator that changes it before it is printed.
ShareCompiledTemplates settings/site.ini disabled If you share compiled templates with other site accesses
SharedCompiledTemplatesDir settings/site.ini (empty) Where to store shared compiled templates
DevelopmentMode settings/site.ini disabled Controls if development is enabled or not. When enabled the system will perform more checks like modification time on compiled vs source file and will reduce need for clearing template compiled files. Note: Live sites should not have this enabled since it increases file access and can be slower. Note: When switching this setting the template compiled files must be cleared.
CompileComments settings/site.ini disabled NOTE: The following settings are for template compilation development only and are not useful for normal sites. Whether to include comments inside cache files or not.
CompileAccumulators settings/site.ini disabled Whether to include debug accumulators.
CompileTimingPoints settings/site.ini disabled Whether to include debug timing points.
CompileResourceFallback settings/site.ini disabled Whether to fallback code for resource handling Should not be needed unless one has to debug the compilation process
CompileNodePlacements settings/site.ini enabled If disabled the template compilation will not include placement information for nodes The placement information is used to display line and column numbers for warnings and errors.
CompileExecution settings/site.ini enabled If disabled the template compilation files will only be generated but not executed, this means that the normal template process is used for the result.
CompileAlwaysGenerate settings/site.ini disabled If enabled the templates are always compiled even if a sufficient cache already exists.
CompileIncludeNodeTree settings/site.ini (empty) An array with node trees to include in the compiled template file. Including them will increase the size of the cache files and is only useful for template compilation development. Possible entries are: transformed - The tree after node transformation has been done static - The tree after static extraction has been done combined - The tree after static element combines has been done original - The originally parsed tree

In this section

Contributors

Comments (1 historical)

Written by readers of the earlier documentation sites, kept as they were.

Comments

Add a comment

Comments are read by a moderator before they appear.