Page tree

Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

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

content-editor-parent

Parent reactor.

magnolia-content-editor

Provides a free-form content editor (including the ContentEditorSubApp).

magnolia-content-editor-widgetset

Provides a custom widgetset for the Content editor.

stories-app

Provides the Stories app, the default Magnolia implementation.

article-editor

Provides the Articles app, an example Magnolia implementation.

magnolia-block-api

Provides a basic API for the blocks (content sections).

magnolia-block-templating

Provides the functionality to render the blocks.

magnolia-link-unfurl

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>
  <version>1.2.2</version>
</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. The latest version of the module is 1.2.2

Pre-built JARs are also available for download. See Installing a module for help.

Content editor modules in Magnolia webapps and bundles

Preconfigured Magnolia EE bundles or webapps, such as magnolia-enterprise-pro-demo-bundle-5.7.25-tomcat-bundle.zip or magnolia-enterprise-pro-demo-webapp-5.7.25.war 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

Demo modules decorate the stories-app

Be aware that Demo decorates the stories-app