The 5.7 branch of Magnolia reached End-of-Life on December 31, 2023, as specified in our End-of-life policy. This means the 5.7 branch is no longer maintained or supported. Please upgrade to the latest Magnolia release. By upgrading, you will get the latest release of Magnolia featuring significant improvements to the author and developer experience. For a successful upgrade, please consult our Magnolia 6.2 documentation. If you need help, please contact info@magnolia-cms.com.
The Content Editor module provides a platform for handling well-defined blocks of content in Magnolia. The core of the platform is the Magnolia Content Editor submodule, implemented as the stories-app submodule which allows editors to create and edit stories in the Author instance using the Stories app.
Module structure
artifactID | |
---|---|
| Parent reactor. |
| Provides a free-form content editor (including the ContentEditorSubApp). |
| Provides a custom widgetset for the Content editor. |
| Provides the Stories app, the default Magnolia implementation. |
| Provides the Articles app, an example Magnolia implementation. |
| Provides a basic API for the blocks (content sections). |
| Provides the functionality to render the blocks. |
| Provides utilities for unfurling external web links. Unfurling means fetching and displaying metadata for a given URL (for example. a preview image, a title and description etc.). |
Installing
Maven is the easiest way to install the modules. Add the following dependencies to your bundle:
If you want to use the example Magnolia implementation – the Stories app – add this dependency to your webapp:
<dependency> <groupId>info.magnolia.editor</groupId> <artifactId>stories-app</artifactId> </dependency>
If you want to build your own custom implementation, add this dependency to your module:
<dependency> <groupId>info.magnolia.editor</groupId> <artifactId>magnolia-content-editor</artifactId> </dependency>
If you intent to build custom blocks, add this dependency to your module:
<dependency> <groupId>info.magnolia.block</groupId> <artifactId>magnolia-block-templating</artifactId> </dependency>
Maven dependency management will include the other required content-editor submodules. Make sure use for all dependencies the same version.
Content editor modules in Magnolia webapps and bundles
Preconfigured Magnolia EE bundles or webapps already contain the following six submodules:
magnolia-content-editor
magnolia-content-editor-widgetset
stories-app
magnolia-block-api
magnolia-block-templating
magnolia-link-unfurl
Demo modules decorate the stories-app
Be aware that Demo decorates the stories-app
.