Magnolia 6.0 reached end of life on June 26, 2019. This branch is no longer supported, see End-of-life policy.
A Magnolia module can be purely file based or it can be wrapped in a Maven project.
Magnolia module wrapped in a typical Maven module
structure before it is built.File-based Magnolia module under $magnolia.resources.dir
=
Light module <maven-module-name>/
├── pom.xml
└── src/
└── main/
├── java/
└── resources/
├── META-INF/
│ └── magnolia/
│ └── module-name.xml
└── <module-name>/
├── apps/
├── dialogs/
│ └── myDialog.yaml
├── webresources/
└── templates/
├── components/
│ ├── myComponent.ftl
│ └── myComponent.yaml
└── pages/
├── myTemplate.ftl
└── myTemplate.yaml
$magnolia.resources.dir/
└── <module-name>/
├── apps/
├── dialogs/
│ └── myDialog.yaml
├── module.yaml
├── webresources/
└── templates/
├── components/
│ ├── myComponent.ftl
│ └── myComponent.yaml
└── pages/
├── myTemplate.ftl
└── myTemplate.yaml
Notes:
magnolia.resources.dir
is a property defining the directory from which resources are loaded in a Magnolia instance. This directory is used for file-based resources such as light modules and for overriding classpath resources. The property is configured in WEB-INF/config/default/magnolia.properties
and has the default value $magnolia.home/modules
. To see the current value of the property, go to the Config Info tab in the About Magnolia app. Set the property magnolia.resources.filesystem.observation.excludedDirectories
to exclude directories from being observed for changes. (See Configuration management - magnolia.resources.filesystem.observation.excludedDirectories.)
<module-name>
folder contains exactly the same content in a Maven module and folder-based module. In a Maven module this folder is within src/main/resources
. In a folder-based modules this folder is within $magnolia.resources.dir
.é
, à
, ç
, ä
, ö
, ü
or special characters such as slashes /
, \
and so on. The name must match the regular expression [a-zA-Z0-9-_]
.The create-light-module
command in the Magnolia CLI creates the module folder structure on the file system automatically.
apps | optional Configuration data for apps (YAML files) |
decorations | optional Definition decorator files (YAML files) |
dialogs | optional Dialogs (YAML files), may have subfolders |
fieldTypes | optional FieldType definitions (YAML files). |
i18n | optional i18n message bundle (.properties files). |
messageViews | optional MessageView definitions (YAML files). |
webresources | optional All the web resources, typically contains subfolders. (Folder name is arbitrary.) |
templates | optional Template definitions (YAML files) and scripts with subfolders |
Starting with Magnolia 5.4, a Magnolia module does not have to be a Maven module. You can add a file-based module in the $magnolia.resources.dir
directory.
By default $magnolia.resources.dir
is the webapp folder, for instance magnoliaAuthor
or magnoliaPublic
. See Add the module folder to $magnolia.home for more information about $magnolia.home
.
create-light-module
. Open a shell, cd
to your light modules directory, and execute the following command:mgnl create-light-module one-pager-module
é
, à
, ç
, ä
, ö
, ü
or special characters (e.g. slashes /
, \
and so on). The name must match the regular expression [a-zA-Z0-9-_]
.Note that this only works if you have installed Magnolia CLI, see Magnolia CLI Installation.
If you are familiar with Java and Maven you may want to use Maven to create and build your Magnolia module. Using Maven eases the process of creating a JAR file, deployment, and dependency management of your modules. All modules provided by Magnolia are built with Maven. This makes it easy to install or uninstall them by adding or removing a JAR file.
Magnolia provides a set of Maven archetypes for various tasks, one of which is creating a Magnolia Maven module.
Before running the Maven archetype
command, please read How to use Magnolia Maven archetypes: Check Maven settings.
If you are not familiar with the Maven archetype plugin, please also read How to use Magnolia Maven archetypes: The archetype plugin.
Open a shell and change to the directory where you want the Magnolia Maven module skeleton to be created.
cd /Users/jdoe/repositories/magnolia
Run the following command:
mvn archetype:generate -DarchetypeGroupId=info.magnolia.maven.archetypes -DarchetypeArtifactId=magnolia-module-archetype -DarchetypeVersion=RELEASE
Maven prompts you to specify values for several parameters. Use values that fit your requirements:
Parameter | Example value | Explanation |
---|---|---|
Maven groupId |
com.example
| Typically reflects the name or domain of your company or projects. |
Maven artifactId | foobar-module | Project-specific identifier. |
Maven artifact version | 1.0-SNAPSHOT | Project version. Typically, when creating a new project, use the value suggested by Maven, for example 1.0-SNAPSHOT . |
package |
com.example.modules.foobar
| Package name for Java classes reflecting both your company (or domain) and the specific project. |
magnolia-bundle-version | 6.1 | Magnolia version from which your custom project inherits. |
module-class-name | FoobarModule | The Java class name of the autogenerated module class. |
project-name | foobar-module | Project name. |
After you have finished entering the values, the archetype plugin displays their list and asks you to confirm it. If you confirm by pressing ENTER
, the plugin generates the skeleton of your archetype. You should see a BUILD SUCCESS
message at the end of the process. If you press N
or CTRL
+ C
, nothing is generated.
my-module/ ├── pom.xml └── src ├── main │ ├── java │ └── resources └── test ├── java └── resources
The
java
and resources
directories contain more subfolders. For further details, see above.