Templates Usage

Magnolia Compatibility
5.5
5.6
5.7
6.1

The Templates Usage Module gives you an overview of page and component templates usage, and helps you locate those in your website. This allows you, for example, to check for regression of pages or components that have been changed.

Templates are grouped by module name and displayed in a tree view identical to the setup of the templates. Here you can see how often a template is used. When requesting the details of a particular template, a list is displayed with the paths where it is used. From here you can navigate to the pages.

A filter helps you to narrow down the amount of templates listed either by selecting a module, selecting a type of template (page or component) and/or by searching for a name.

Installation

This module requires Enterprise Edition of Magnolia. The module can be added as a Maven dependency in the main and webapp POM file:

<dependency>
    <groupId>nl.info.magnolia</groupId>
    <artifactId>templates-usage</artifactId>
    <version>{moduleVersion}</version>
</dependency>

Additionally a dependency from your main module descriptor is necessary:

<dependency>
    <name>templates-usage</name>
    <version>{2/* | 3/*}</version>
</dependency>

Versions and compatibility table

Compatibility

Module Version	Magnolia Version
3.1.x	6.1.x
3.0.x	5.7.x
2.1.x	5.6.x
1.1.x	5.5.x

History

Version 3.1.0. first public release for Magnolia 6.1.x
- Fixed issue TPLTSUSAGE-2 - Getting issue details... STATUS - now when allowedModules are empty, all modules are displayed to all users
Version 3.0.3
- Fixed issue TPLTSUSAGE-2 - Getting issue details... STATUS - now when allowedModules are empty, all modules are displayed to all users
Version 3.0.0: first public release for Magnolia 5.7.x
Version 2.1.0: first public release for Magnolia 5.6.x

Version 1.1.0: first public release for Magnolia 5.5.x

Configuration

When no configuration done at all (no properties under allowedModules node in config), all modules are displayed to all users,
Configuration is stored and managed in main module node in JCR (/modules/templates-usage/config)
By adding properties to /templates-usage/config/allowedModules you can control which modules are displayed,
The superuser will always see all modules available,
In the template definition (YAML), the 'title' and 'description' field can be used to describe the component.

Sample configuration

/modules/templates-usage/config.yaml

'config': 
  jcr:primaryType: 'mgnl:content'
  'allowedModules': 
    '0': 'main-website'
    '1': 'google-maps-magnolia'

Licensing

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Contributions, questions or findings

Please share your ideas or questions in the comments area on this page.

If you run into a problem, you can report it here: https://jira.magnolia-cms.com/projects/TPLTSUSAGE

Page tree