Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
...
Multiexcerpt | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Notes:
Include Page | ||||
---|---|---|---|---|
|
<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
.Include Page | ||||
---|---|---|---|---|
|
...
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
.
Include Page | ||||
---|---|---|---|---|
|
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 Maven archetype to build the skeleton of a Magnolia Maven module. The archetype provides options to build different modules:
...
Execute the following maven command:
Include Page | ||||
---|---|---|---|---|
|
Choose an archetype when prompted. Here we choose the option magnolia-module-archetype
which is a simple Magnolia project wrapped into Maven structure. Maven will then ask us for the standard
Next, the script asks to choose the archetype version - we recommend to choose always the latest version.
Now you must prompt typical Maven properties such as which version of Magnolia we will be using.
language | text |
---|
groupId, artifactId, package name and version plus the Magnolia specific parameters magnolia-bundle-version, module-class-name and module-name.
When you have prompted all the parameters - the archetype summarizes your inputs and you must confirm or can skip.
Code Block | ||
---|---|---|
| ||
Define value for property 'groupId': : com.example Define value for property 'artifactId': : myModule Define value for property 'version': 1.0-SNAPSHOT: : Define value for property 'package': com.example: : Define value for property 'magnolia-bundle-version': : 5.6.46 Define value for property 'module-class-name': : MyModule Define value for property 'module-name': myModule: : Confirm properties configuration: groupId: com.example artifactId: myModule version: 1.0-SNAPSHOT package: com.example magnolia-bundle-version: 5.46.6 module-class-name: MyModule module-name: myModule Y: : Y |
If you confirm, Maven generates the archetype skeleton.