Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fix by script - Avoid cross space links to DOCS56

...

You don't need to know Java or Maven to create a perfectly valid Magnolia module. Put your project files into a file-system directory to create a so-called light module. Use YAML-based configuration and Magnolia's unified resource loading.

This enables light development, a development style which does not require Java skills or a Java development environment. It's a straightforward way to get started with Magnolia development and works well for front-end developers. The Hello Magnolia tutorial uses light development to create a fully-functional template module.

Tip

It is best practice to store your light modules outside of the apache-tomcat directory so that the modules you add can be accessed by any Magnolia instance. If you already have a light modules directory you want to use, edit the magnolia.resources.dir property in your magnolia.properties file to point to it.

...

Multiexcerpt include
MultiExcerptNamestructure-comparison
PageWithExcerptDOCS57:Module structure

Folders:

<module-name>

The root folder of the module; the folder name is the name of the module.

(warning) For the name of the module use only the characters from the [a-zA-Z0-9-_] regex range.

apps

Configuration data for apps (YAML files)

A Magnolia module can contain 0 to many apps.

dialogsDialogs (YAML files), may have subfolders
i18nA bundle of localization (*.properties) files
resourcesAll the resources, typically contains subfolders
templatesTemplate definitions (YAML files) and scripts with subfolders
themesTheme definitions (YAML files), may have subfolders.
module.yamlLight module descriptor.

...

Magnolia modules can define a couple of items as parts of the module. Such items are apps, fieldTypes, dialogs, commands, virtualURIMapping, templates. See Modules#Module Module structure above and Module configuration for further details.

...