Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ You don't need to fully understand everything going on right now, but as you lea

1. For every `ContentType` you can define [`defaultContent`]({{< ref "/reference/project-config/content-types#default-content" >}}) and [`defaultMetadata`]({{< ref "/reference/project-config/content-types#default-metadata" >}}) which will be merged with passed content/metadata (passed data are preferred).
2. content (import) and metadata (import + editor) will be validated in a next step
3. metadata plugin hook [`onUpdate`]({{< ref "/customising/server/metadata-plugins#write-a-custom-plugin" >}}) will be called
3. metadata plugin hook `onUpdate` will be called ({{< deprecated-in "release-2026-03" >}})
4. Save the document on the database
5. Call the server event [`document.create`]({{< ref "/customising/advanced/server-events#available-events" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Below is a diagram for the document publication lifecycle. You don't need to ful
{{< img src="assets/document-publication-lifecycle.png" alt="Document Publication Lifecycle" >}}

1. Start "Prepare Publish" phase where you still can modify the document, validate data and throw errors back to the callee
2. Call metadata plugin hook [`onPreparePublish`]({{< ref "/customising/server/metadata-plugins#write-a-custom-plugin" >}}) (modify metadata property, validation)
2. Call metadata plugin hook `onPreparePublish` (modify metadata property, validation) ({{< deprecated-in "release-2026-03" >}})
3. Call server hook [`preparePublishHook`]({{< ref "/customising/server/server-hooks#publication-hooks" >}}) (modify document, validation).
4. Start "Publication" phase
5. Save the publication on the database
Expand Down
7 changes: 3 additions & 4 deletions content/guides/editor/push-notifications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ description: Setup push notifications with a custom dashboard item
weight: 15
---

{{< warning >}}
Please don't use this functionality anymore. it will be removed eventually after a formal deprecation period that has not started yet.
Use the [`li-push-messages` metadata plugin]({{< ref "/reference/document/metadata/plugins/li-push-messages" >}}) instead.
{{< /warning >}}
{{< deprecated-in "release-2026-03" block >}}

`li-push-notifications` is deprecated and will be removed in `release-2026-09`. Please use the [`li-push-messages` metadata plugin]({{< ref "/reference/document/metadata/plugins/li-push-messages" >}}) instead.

This guide explains 2 things:

Expand Down
38 changes: 1 addition & 37 deletions content/guides/setup/editor-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,9 @@ weight: 2

Possible Livingdocs Editor UI customizations:

- custom Angular factories or services (for use in other customizations)
- custom Angular components for metadata fields
- .. or [custom model classes]({{< ref "/guides/documents/metadata" >}}) for existing metadata fields
- custom Angular components for doc-include sidebar user interfaces
- [custom model classes]({{< ref "/guides/documents/metadata" >}}) for existing metadata fields
- custom [Display Filter]({{< ref "/customising/advanced/editor-configuration/display-filter.md" >}})
- custom Dashboard item (a single item in the articles dashboard)
- custom Embed components (the core contains Iframes and Tweets)
- custom Iframely metadata extractors
- locale customizations

## Editor Configuration
Expand All @@ -29,43 +24,12 @@ In addition to this some behaviour can be customised using the JSON configuratio
The editor (like the server) usually has an `app/editor.js` file where code customizations are registered and that looks something like this:

```js
// entry point when using the webpack build of the editor
const liEditor = require('@livingdocs/editor')()
const editingApiModule = window.angular.module('li-editing-api')
// the Angular editorModule -> can be used to register services and factories
const editorModule = window.angular.module('livingdocs-editor')

// example of loading a custom angular module: ui-validate
// require('angular-ui-validate')
// editorModule.requires.push('ui.validate')

// Just require a custom Angular factory using the editorApiModule
require('./custom/scripts/factories/categories')(editingApiModule)

// Register a custom filter for the dashboard
const layoutsFilter = require('./custom/filters/layouts_filter')
liEditor.searchFilters.registerListV2('layouts', layoutsFilter)

// Register a custom doc-include sidebar interface (Angular component)
liEditor.includes.register('brightcove', {
template: require('../plugins/includes/ld-brightcove-include/brightcove_include_template.html'),
controller: require('../plugins/includes/ld-brightcove-include/brightcove_include_controller'),
bindings: {
directive: '=',
componentView: '=',
component: '='
}
})

// Example of custom embeds
// embeds = require('@livingdocs/editor/app/scripts/modules/embeds/embeds')
// Pinterest = require('./custom/scripts/modules/embeds/pinterest/pinterest')
// Facebook = require('./custom/scripts/modules/embeds/facebook/facebook')
// embeds.registerCustomEmbeds [
// Facebook,
// Pinterest
// ]

// Example of changing the date locale
// moment = require('moment')
// momentDe = require('moment/locale/de')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ support:
systemMetadata: true
planningSystem: false
description: |
{{< warning >}}
Support for `li-push-notifications` will soon be removed. Please use [`li-push-messages`]({{< ref "/reference/document/metadata/plugins/li-push-messages" >}}) instead.
{{< /warning >}}
{{< deprecated-in "release-2026-03" block >}}
`li-push-notifications` is deprecated and will be removed in `release-2026-09`. Please use [`li-push-messages`]({{< ref "/reference/document/metadata/plugins/li-push-messages" >}}) instead.
defaultUI: Editor toolbar button which opens a dialog.
storageFormat: |
{
Expand Down