Content Editor module - 5 UI
| Edition | DX Core |
|---|---|
License |
|
Issues |
|
Maven site |
|
Latest |
1.3.16 |
|
This page has been created for the Magnolia 5 UI framework. For the 6 UI framework page, see Content Editor module instead. |
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.
|
Compatibility note Custom content editor and block definitions created in the Magnolia 5 UI framework must be migrated. |
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.). |
If you want to use the example Magnolia implementation – the Stories app – add this dependency to your webapp:
Installing with Maven
Bundled modules are automatically installed for you.
If the module is unbundled, add the following to your bundle including your project’s <dependencyManagement> section and your webapp’s <dependencies> section.
If the module is unbundled but the parent POM manages the version, add the following to your webapp’s <dependencies> section.
<dependency>
<groupId>info.magnolia.editor</groupId>
<artifactId>magnolia-content-editor</artifactId>
<version>1.3.16</version> (1)
</dependency>| 1 | Should you need to specify the module version, do it using <version>. |
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>
<version>1.3.16</version> (1)
</dependency>| 1 | Should you need to specify the module version, do it using <version>. |
If you intend to build custom blocks, add this dependency to your module:
<dependency>
<groupId>info.magnolia.block</groupId>
<artifactId>magnolia-block-templating</artifactId>
<version>1.3.16</version> (1)
</dependency>| 1 | Should you need to specify the module version, do it using <version>. |
Maven dependency management will include the other required content-editor submodules. Make sure you use the same version for all dependencies.
Content editor modules in Magnolia webapps and bundles
Preconfigured DX Core bundles or webapps, such as 6.2.52 WAR file for example, already contain the following six submodules:
-
magnolia-content-editor -
magnolia-content-editor-widgetset -
stories-app -
magnolia-block-api -
magnolia-block-templating -
magnolia-link-unfurl
| The module bundled (version 1.3.16) in the 6.2 Magnolia branch is compatible with the 5 UI framework. |
Demo modules decorate the stories-app
Be aware that Demo decorates
the stories-app.