Editor Metadata Section Configuration
The following properties must be defined to configure an editor metadata section:
- name
-
The display name of the component. The name is only actually displayed when the mouse is held over the metadata section button. Remember also that the
name
property name must be preceded by a hyphen (-
). directive
-
The tag name of the web component. The name you specify must contain a hyphen.
webComponent
-
Information about the web component:
modulePath
-
The URL of the web component
icon
-
The tag name of the web component's icon. The name you specify must contain a hyphen.
mimeTypes
-
An array of MIME types specifying the editors for which this metadata section should be made available. The following MIME types may be specified:
x-ece/story
Escenic content editor for items other than images, videos, galleries and events
x-ece/image
Escenic image editor
x-ece/video
Escenic video editor
x-ece/gallery
Escenic gallery editor
x-ece/event
Escenic event editor
x-ece/new-content
Editor containing new Escenic content that has not yet been saved
x-ece/section
Escenic section editor
x-ece/section-page
Escenic section page editor
x-ece/list
Escenic list editor
x-ece/*
All Escenic editor types
x-cci/assignment
Newsgate assignment editor
x-cci/storyfolder
Newsgate story folder editor
x-cci/*
All Newsgate editor types
*/*
All editor types
order
-
Determines the position of this section in the attributes panel (and the position of the button). The sections are arranged in numerical order from lowest to highest.
All the properties must be entered as a list item belonging to an
editors/metadata
property. They must be indented
correctly and the name
property must be preceded
by a hyphen (-
) to indicate the start of a new
list item. The following example shows the required format:
editors: metadata: - name: "Content History" directive: "content-history" webComponent: modulePath: "http://www.example.com/webcomponents/history/history.js" icon: "content-history-icon" mimeTypes: ["x-ece/story"] order: 803