Content Editor module

Edition DX Core

License

MLA

Issues

CONTEDIT

Maven site

Content Editor

Latest

1.3.5

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.).

If you want to use the example Magnolia implementation – the Stories app – add this dependency to your webapp:

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.editor</groupId>
  <artifactId>stories-app</artifactId>
  <version>1.3.5</version>
</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.3.4</version>
</dependency>

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.4</version>
</dependency>

Maven dependency management will include the other required content-editor submodules. Make sure you use the same version for all dependencies. The latest version of the module is 1.3.4.

Content editor modules in Magnolia webapps and bundles

Preconfigured DX Core bundles or webapps, such as 6.2.6 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

Demo modules decorate the stories-app

Be aware that Demo decorates the stories-app.

Feedback