Creating Plug & Play Modules for OpenCms 8

Track: Workshop
Speaker: Rüdiger Kurz (Alkacon Software GmbH)

Abstract

OpenCms, since its first public version, features a module mechanism that allows encapsulating functionalities in separate modules. However, the template mechanism of OpenCms up to version 7.5 left many details to the developer. It turned out that developing reusable modules is quite difficult, since there used to be many dependencies from a module to the template it was developed for. The improved template and module mechanism of OpenCms 8 addresses these issues, removes theses dependencies and therefore allows creating modules that are not depended on the template.

Rüdigers presentation did include an overview of the problem with pre-OpenCms 8 modules using the “Template 2” example from the OpenCms 7.x distribution. He did then show how the problems have been addressed in OpenCms 8. Among other things, this includes the possibility to create HTML output that is rendered differently depending on the space available in the template.

Best practices for structuring modules were also explained, for example how to layout module resources in different folders and naming conventions we suggest.

Latest News

  • OpenCms 17 available

    Apr 9, 2024 - OpenCms 17 gives content managers the new app "Date search" to find content that has been changed in a certain time range. The "Websites" app allows to easily export the content of a complete site for archiving. An option has been added to hide "sensitive" content in the Offline project. The default Mercury template has been further improved, e.g. with SEO optimized job postings, a "spacer" function and marker clusters for maps. OpenCms 17 has also been tested and certified using Java 17 LTS and 21 LTS.

  • OpenCms 17 Release Notes

    Apr 9, 2024 - The OpenCms 17 release notes contain detailed information about the new features and fixes in this version.

  • Alkacon OCEE 17

    Apr 9, 2024 - Alkacon OCEE 17 is the latest OCEE release for OpenCms 17. This version improves the cluster shutdown behaviour when using the CmsShell.

  • OpenCms Docker image

    Apr 9, 2024 - Test OpenCms using the official image from the Docker hub registry - the fastest way to evaluate and test OpenCms. The image is well suited for evaluation and test purposes of the latest OpenCms release. We provide a docker-compose file to get OpenCms and the database running with just one command.

Try the OpenCms Live Demo