Template Context Contributor Template

In this article, you’ll learn how to create a Liferay template context contributor as a Liferay module. To create a template context contributor via the command line using Blade CLI or Maven, use one of the commands with the following parameters:

blade create -t template-context-contributor -v 7.0 [-p packageName] [-c className] projectName

or

mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \
    -DarchetypeArtifactId=com.liferay.project.templates.template.context.contributor \
    -DartifactId=[projectName] \
    -Dpackage=[packageName] \
    -DclassName=[className] \
    -DliferayVersion=7.0

You can also insert the -b maven parameter in the Blade command to generate a Maven project using Blade CLI.

The template for this kind of project is template-context-contributor. Suppose you want to create a template context contributor project called my-template-context-contributor with a package name of com.liferay.docs.theme.contributor and a class name of SampleTemplateContextContributor. You could run the following command to accomplish this:

blade create -t template-context-contributor -v 7.0 -p com.liferay.docs -c Sample my-template-context-contributor

or

mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \
    -DarchetypeArtifactId=com.liferay.project.templates.template.context.contributor \
    -DgroupId=com.liferay \
    -DartifactId=my-template-context-contributor \
    -Dpackage=com.liferay.docs \
    -Dversion=1.0 \
    -DclassName=Sample \
    -Dauthor=Joe Bloggs \
    -DliferayVersion=7.0

After running the command above, your project’s directory structure would look like this

• my-template-context-contributor
  • gradle (only in Blade CLI generated projects)
    • wrapper
      • gradle-wrapper.jar
      • gradle-wrapper.properties
  • src
    • main
      • java
        • com/liferay/docs/theme/contributor
          • SampleTemplateContextContributor.java
  • bnd.bnd
  • build.gradle
  • [gradlew|pom.xml]

The generated module is functional and is deployable to a Liferay DXP instance. To build upon the generated app, modify the project by adding logic and additional files to the folders outlined above. You can visit the template-context-contributor sample project for a more expanded sample of a template context contributor. Likewise, see the Context Contributors tutorial for instructions on customizing a template context contributor project.