Create Module HowTo

Introduction

this HowTo will take you through a process of creating your own module extension to OpenCms administration view.

Create Module

First you must create module container for your extension. Creation of a new module is described in detail at Defining_OpenCMS_structured_XML_content#Step_1_.E2.80.93_Create_the_module_and_configure_it. Make sure that you select all module folders to be created.

Create and Install Message Bundle

Next we need to create and install message bundle for our new module, so will be able to customise all workplace labels based on user's selected language. This requires the following steps:-

1. Create messages class.
2. Create action class and initiate the message bundle as part of the action class.
3. Create your module specific workplace.properties file.

Create messages class

Message class is used to reference your module specific workplace.properties file at part of OpenCms. Is is just a simple class extending org.opencms.i18n.A_CmsMessageBundle and the bundle name variable pointing to the module specific workplace.properties file location. Below is a sample Messages class in order to illustrate this.

Create action class and initiate the message bundle as part of the action class

text

Create your module specific workplace.properties file

text