Defines resource types, property configurations and functions provided by a module.
Editor field description for Module configuration
Tab "Content elements"
Content element configuration
Optional - Can occur as often as necessary
Content element configuration for the page editor.
Type name
(???msg.page.md.widgetname.org.opencms.widgets.CmsTypeFilterWidget???)
The representation of this field in the documentation does not correspond exactly to the appearance in the editor.
The content element type name.
Availability
(Select box)
Optional
Controls the availability for content elements of the given type in this subsitemap. Note that disabling creation also applies to all sub-sitemaps regardless of the availability setting.
Folder
Choice
Optional
Select a folder where new content elements of this type should be created.
Choice option 1
Name
(Text input)
Optional
Specify a folder name where new resources of this type should be created. Will be created automatically within the '.content'-folder.
Choice option 2
Path
(File selection)
Optional
Select a folder where new resources of this type should be created.
Choice option 3
With page
(Display field)
Optional
New elements are stored in an element folder, which is contained in the same folder as the page.
Name pattern
(Text input)
Optional
Naming pattern for newly created content elements (e.g. my_file%(number).xml).
The name pattern needs to contain the %(number) macro.
Display order
(Text input)
Optional
This integer (the smaller the higher) specifies the display order for this content element type.
Element view
(File selection)
Optional
The representation of this field in the documentation does not correspond exactly to the appearance in the editor.
The element view content elements of this type should be visible in.
Delete mode
(Select box)
Optional
Determines the behavior when container elements of this type are removed from a page and are no longer referenced from any pages: Should they be kept or deleted, or should the user be asked to decide?
Localization
(File selection)
Optional
Set the link to a file of the a message bundle that contains the workplace messages for the content element type.
Detail pages disabled
(Check box)
Optional
Check to disable detail pages for content elements of this type.
Show in default view
(Check box)
Optional
The type will be shown in the 'add' menu in the default view in addition to the element view it is assigned to.
Copy in templates
(Check box)
Optional
Sets whether elements of this type that are used in templates should be copied instead of reused.
Check for multiple use
(Check box)
Optional
If this is enabled, the page editor shows whether elements of this type are reused on other pages.
Tab "Property configuration"
Property
Optional - Can occur as often as necessary
Property configuration within the advanced direct edit.
Property name
(Text input)
Name of the property to be set.
Display name
(Text input)
Optional
The displayed property name.
Description
(Text input)
Optional
Supplies a brief description what this property is used for.
Widget
(Select box)
The widget to use to edit the property.
Default
(Text input)
Optional
The default value.
Widget configuration
(Text input)
Optional
The widget configuration parameter.
Validation rule
(Text input)
Optional
The regular expression used to validate the users input.
Validation type
(Select box)
Optional
Specifies if failing the regular expression test causes an error or a warning.
Error message
(Text input)
Optional
The error message to display when the validation fails.
Prefer folder
(???msg.page.md.widgetname.org.opencms.widgets.CmsCheckboxWidget???)
Optional
If selected, newly set properties will be set on the folder (instead of index.html). Only applicable to "Navigation Mode" in Sitemap Editor.
Display order
(Text input)
Optional
This integer (the smaller - the higher) specifies the display order of this property.
Tab "Functions"
Named function
Optional - Can occur as often as necessary
References a JSP that should be used as dynamic function.
Name
(Text input)
The display name for this function.
Function
(File selection)
The JSP that implements the dynamic function.
Default function page
(File selection)
Optional
Display order
(Text input)
Optional
This integer (the smaller the higher) specifies the display order for this function.