Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Light modules can contain more or less fewer folders compared to this example.

...

Light modules folder: magnolia.resources.dir 

...

Magnolia light modules

...

Please note that a Magnolia Light module must reside within the so called "magnolia Magnolia resources directory", the ; this directory is also often referred to as the Magnolia light modules folder. The name and the location of this directory are arbitrary - , but you have provide must provide the path to the folder via configuration.

Include Page
_What is magnolia.resources.dir
_What is magnolia.resources.dir

(warning) Magnolia 5.6.1+: A change in the light modules folder may also flush the server cache. You can configure this behavior under /modules/cache/config/contentCaching/defaultPageCache/flushPolicy/policies/lightModule/pathToCacheMappings/defaultPageCache with the pattern property, which specifies the pattern for the operation. The default value is .*/(templates|webresources|i18n)/.* .

What items can be defined in a light module?

The following items all can be defined within a light module with using YAML. Items defined by YAML can be decorated, or they can be reused with YAML inherit and include

Multiexcerpt include
MultiExcerptNamebullet-point-list
PageWithExcerpt_list of definition items with registries which can be done with YAML

Other non YAML-based items which can be in a light module:

...

Creating a light module with Magnolia CLI

Include Page
_Creating a
With Magnolia CLI you can create the complete
light module
structure
with
a single command. (If you want to install CLI, see 
Magnolia CLI
- Installation.)

Open a shell, change to you the light modules folder and run the following command:

Code Block
mgnl create-light-module my-module

_Creating a light module with Magnolia CLI
Instead of my-module use an appropriate name (no special characters such as space or german umlaut).