OpenCms Documentation

ADE configuration

 Show GitHub edit links  Hide GitHub edit links
In OpenCms since: 8.0 Documented since: 9.5 Latest revision for: 11.0.0 Valid for OpenCms: 11.0.2

We explain how to configure

  • the content types shown in the "Add Content" dialog,
  • the available formatters,
  • the available dynamic functions,
  • the "Basic Properties" dialog,
  • the availability of detail pages,
  • the template pages available.

Module configuration

In case a module adds a new resource type (as defined in the module's manifest) to OpenCms and you want to make this automatically available to the ADE after the module is installed, you can place a .config file of the type module_config inside the root folder of your module.

The module configuration file offers three tabs:

Content elements

Defines a content type‘s name and name pattern, default folder, formatter and more.

Property configuration

Defines which properties get displayed under the "Basic Properties" tab for the property dialog in the ADE.

Functions

Define named functions that are shipped with the module. For named functions, function detail pages can be added in the sitemap editor.

Sitemap configuration

The central place where the content types available through ADE's Add Content dialog and other global settings are configured is the /.content/.config file. Settings for sub-sitemaps follow the same mechanism with the .content/.config file based in the sub-sitemap.

The sitemap configuration offers 6 tabs:

Content elements

Defines a content type‘s name and name pattern, default folder, formatter (optional) and more.

Formatters

Configure which formatters should be available.

Dynamic functions

Configure which dynamic functions should be available. (Since OpenCms 11)

Property configuration

Defines which properties get displayed under the "Basic Properties" tab for the property dialog in the ADE.

Templates

Defines template models to be used by the sitemap editor for generating new container pages. Most of the configuration is added when a new template model is added via the sitemap editor. Read more on template models here.

Detail pages

Defines detail pages used for the specified content type in the sitemap. Most of the configuration is done automatically when a detail page is added via the sitemap editor.

Sitemap master configuration

The correct ADE configuration for each site can be cumbersome. Especially, when you have a multi-site installation with various templates present. Typically, the types, formatters and functions that make sense depend (only) on the template that is used. To ease the configuration, sitemap master configurations are introduced.

The idea is to add a sitemap master configurationChoose type "Sitemap master configuration" in the "Configurations"-tab to add a configuration in the explorer. to the module that contains your template (JSP)We recommend to use a configurations subfolder of your module's main folder. and reference it in the sitemap configuration for sites that use the template.

The master configuration file offers four tabs:

where the options are (nearly) identically to the ones in the sitemap configuration.

The sitemap master configuration is a great feature to configure sites already when developing the template. At least for installations with multiple templates, we strongly recommend to use them.

Configuration inheritance

Fig. [configuration_inheritance]: Configuration inheritance

You can improve this page

Please contribute your suggestions or comments regarding this topic on our wiki. For support questions, please use the OpenCms mailing list or go for professional support.