Global theme modules

Available elements for global theme modules.

Element: Module

The module that provides contributions.

Attributes:

• id: The system-wide identifier for this module. The id value is a String that must be unique in the system.

• version: The version of the module provided with this contribution. The version value uses the format major.minor.revision.

Child-elements

• 0..* capability

• 0..1 moduleActivation

• 0..* prereq

• 0..* contribution

Element: Contribution

Defines a theme contribution of the module.

Attributes:

• type: The type of content spot that this module contributes to. The value is either head, config, or menu.

Child-elements

• 0..* subcontribution

Element: subcontribution

Part of the overall contribution.

For example, in the head contribution, subcontributions can add CSS, JavaScript, or head-specific markup.

Attributes

• type: Declares what type of contribution is provided.

• values:

  • markup: HTML markup
  • css: Cascading style sheet statements.

  • js: JavaScript libraries, functions, and objects. These contributions are loaded after contributions with a config_* value.
  • config_static: JavaScript configuration contributione that are not request-dependent variable definitions. These contributions are collected in a separate file.
  • config_dynamic: JavaScript configuration contributione that are request-dependent variable definitions. These contributions are injected into the markup.

Child-elements

• 0..1 uri

Element: prereq

A module that is required by another module that defines the requirement.

Attributes:

• id: The id of the required module.

• minversion: The minimum version of the required module that is required by the module that defines the requirement.

Element: capability

The declaration of a capabilito that this module delivers.

Attributes:

• id: The unique name to be used for this capability.

• value: the version of the capability provided by this module. The capability value uses the format major.minor.revision.

Element: uri

A URI pointing to a theme module resource.

Attributes:

• value: The URI of the resource to be used.

• lang: The language to which the defined URI applies, for example, en_US.

• type: The type to which this URI applies. For the subcontribution type of CSS the URI type is rtl, and for JavaScript the URI type is debug.

Different schemes can be used within the value attribute:

Use this scheme with caution as it can severely impact performance, because the remote file is included on the server and not on the browser. When this scheme is used, remote requests are sent from the virtual machine of the portal during portal page rendering to the remote system in a synchronous manner. Therefore, the response time of the remote system affects portal page rendering time and the number of available threads available for other requests. Use HTTP only for static sources that can be cached in a proxy or HTTP server in front of portal.

Also be aware that the Ajax proxy is used to perform the remote call so that the configuration must be updated for the remote request to occur.

• http: Use HTTP to reference file that are accessible using HTTP.

• res: Use the res scheme to access an arbitrary resource, such as a JSP, a servlet, or a static file, in a web module that is installed on the server.
• dav: Use the dav scheme to access resources in the portal file store. We can also use replacement tokens for the URI value, for example:

  res:{rep=WP
  
  CommonComponentConfigService;key=cc.theme.context}/themes/html/PageBuilder2/modules/css/markup/head_m.jsp
  

  This means that the code

  {rep=WP CommonComponentConfigService;key=cc.theme.context}
  

  is replaced with the value of the custom property cc.theme.context in the resource environment provider WP CommonComponentConfigService.

Element: moduleActivation

Declaration of a class that controls whether the module is active.

Attributes:

• class: The class name that implements the ModuleActiveChecker interface.

Child-elements

• 0..* parameters

Element: parameter

Declaration of a resource environment entry that specifies whether the module is active or not (values: true or false) Default is true.

Attributes:

• name: The name of the parameter.

• value: The value of the parameter.

Parent: Registering theme modules