OpenCms documentation
OpenCms documentation

Editor field description for Sitemap configuration

Defines the resource types, template pages, detail pages and property configurations that can be used in a sitemap.
Back

Tab "Content elements"

Master configuration
(File selection)
Optional - Can occur as often as necessary
Disable all
(Check box)
Optional
Disables all inherited configurations for content elements.
Local content elements
(Check box)
Optional
Check to store all newly created content elements within the given sub-site's '.content'-folder.
Prefer local detail pages
(Check box)
Optional
If this is set, detail pages from this sitemap will be preferred when linking to contents that are stored locally in this sitemap.
Disallow detail contents from other (sub)sitemap
(Check box)
Optional
Prevents detail contents in other subsites from being displayable on detail pages from this subsite.
Show in site selector
(Check box)
Optional
Makes the subsite available in the site selector.
Sort content elements according to number from 'Display order'
(Check box)
Optional
'Add content' menu
(Select box)
Optional
Controls how elements are displayed in the 'Add content' menu of the page editor in case no suitable container for an element is found on the page.
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?
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 "Formatters"

Use formatter keys
(Check box)
Optional
Stores the formatter mappings indirectly by using the configured formatter keys. If set, container pages in this subsite are stored in format version 2.
Element setting overrides
(File selection)
Optional
A configuration file containing overrides for element settings. These will replace the settings with the same (include) name in the configured formatters.
Remove all element setting overrides
(Check box)
Optional
Remove all formatters
(Check box)
Optional
Check to remove all formatters that are otherwise available in the sub-sitemap due to inherited configurations.
Formatters to be removed
Optional
The formatters which should be disabled for this sub-sitemap.
Formatter
(File selection)
Optional - Can occur as often as necessary
The representation of this field in the documentation does not correspond exactly to the appearance in the editor.
Formatters to be added
Optional
The formatters which should be made available for this sub-sitemmap.
Formatter
(File selection)
Optional - Can occur as often as necessary
The representation of this field in the documentation does not correspond exactly to the appearance in the editor.

Tab "Dynamic functions"

'Add content' menu
(Select box)
Optional
Controls how dynamic functions are displayed in the 'Add content' menu of the page editor in case no suitable container for an element is found on the page.
Remove all functions
(Check box)
Optional
Hides all functions that are not explicitly added in this configuration.
Dynamic functions to be removed
Optional
Hides specific dynamic functions
Function
(File selection)
Optional - Can occur as often as necessary
Dynamic function to be added
(File selection)
Optional - Can occur as often as necessary
Make dynamic functions available that have been removed in this or a parent configuration.
Remove all plugins
(Check box)
Optional
Plugins to be removed
Optional
Plugin
(File selection)
Optional - Can occur as often as necessary
Plugins to be added
Optional
Plugin
(File selection)
Optional - Can occur as often as necessary

Tab "Property configuration"

Disable all
(Select box)
Optional
Disables all inherited property configurations.
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.
Disabled
(Check box)
Disables the property in this (sub-)sitemap.
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 for this property.
Widget configuration
(Text input)
Optional
The widget configuration parameter(s).
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.

Tab "Templates"

Disable all
(Check box)
Optional
Disables all inherited templates.
Template
Optional - Can occur as often as necessary
Defines a template that can be used in the sitemap editor.
Page
(File selection)
The resource to copy when creating a new page.
Disabled
(Check box)
Disables the given template page.
Use as default
(Check box)
Check to use this template as the default template page.

Tab "Detail pages"

Detail page
Optional - Can occur as often as necessary
Define a detail page that should be used for a content element below this sitemap.
Type
(Select/combo box)
The content element type to use this detail page for.
This can not be empty.
Folder
(File selection)
Optional - Can occur as often as necessary
Page
(File selection)
The path to the detail page.
This can not be empty.

Tab "Attributes"

Attribute
Optional - Can occur as often as necessary
A key-value pair used to store additional information about the sitemap.
Key
(Text input)
Value
(Text area)