OpenCms Documentation

The sitemap editor

 Show GitHub edit links  Hide GitHub edit links
In OpenCms since: 8.0 Documented since: 9.5 Latest revision for: 10.0 Valid for OpenCms: 11.0.2

The sitemap editor allows you to build the site’s navigation structure by creating new container pages and changing the navigation information of the existing pages. The sitemap represents the website’s structure displaying the container page tree. The user can drop new container pages to different levels of the navigation tree, enter further information like title, create new sub sitemaps or change the order of the pages with drag & drop. The sitemap hierarchy describes the navigation structure of the website and is co-responsible for the URLs visible to the public. It approximates the file tree in the Virtual File System (VFS) of OpenCms but does not cover it exactly.

Moreover, the sitemap editor has various other views where you can

  • View and edit all resources in the VFS
  • Edit, add or remove galleries (image and download galleries)
  • Add, edit and remove template models and model group pages
  • Add, edit and remove categories

How to open the sitemap editor

From the quick launch menu  in the toolbar, choose the Sitemap app.

Overview on the sitemap editor

The sitemap editorin the default view "Sitemap" displays the page tree in the order it appears in the navigation. When moving the mouse over a page (sitemap entry) two options are displayed on the right side of the bar: Context menu and Move. The context menu allows to display information about and perform operations on the chosen sitemap entry. Depending on the type of the sitemap entry, the menu can differ.

Figure [Sitemap Editor Options] shows options of the sitemap editor, that are available additionally to the toolbar options.

Fig. [Sitemap Editor Options]: Options of the sitemap editor

Sitemap editor toolbar

Available options

Opens the Publish dialog.


Shows recently modified or deleted pages.

 Add pages

Enables the content manager to create new pages in the sitemap.

 Select view

Switches the View of the sitemap editor. Five views are available: Sitemap (default), Resources (all VFS resources), Galleries (image and download galleries), Templates (template models), categories (all categories available inside the sitemap).

 Context menu

Shows the context menu for the sitemap.

 Quick launch

Switch to another app

 User info

The icons shows a user specific configurable picture. It provides access to user information, preferences and the logout button.

Creating a page

With the Add pages option from the sitemap editor's toolbar you can add a new page via drag & drop. You can create three different kinds of pages: Container pages, Type pages, Function pages.

Fig. [Create new page]: Create a new page

Creating a container page

Depending on the configured template models provided by the template developer, you can select from different pages meeting your requirements. You can drop a new container page to wherever you need it in the sitemap.

Fig. [Create Container Page]: Dropping a container page into the sitemap

A page can be dropped right below another existing page or as a child page of an existing page. If you want to place the page 2 as child page of page 1, hover over the icon of page 1. Then page 2 will become a child page of it - if dragged right below. A child page can also be created via the "Create child page" context menu entry on an existing page.

Creating detail pages

Via the tab Detail pages from the Add pages dialog allows to create a new sitemap entry that is used as detail page for a certain content type or function, e.g., for news articles. Detail pages are used to link from lists of contents to detailed views on these entries or to e.g., search results. Read more about the detail pages here:

Creating a function page

Selecting the Function pages option from the Add pages dialog offers a selection of pages for special purpose.

Fig. [Create function page]: Creating a function page
Function pages available
HTML redirect

A HTML Redirect might be accessible through the page navigation and redirects the browser to another URI within the site or to an external link. It might also be excluded from navigation but necessary if a page / sub-site has moved to another location and to prevent dead links from users' bookmarks.

Navigation level

Navigation level is a special navigation folder, which redirects to the first container page inside this folder. Use this option if you would like to list several sub pages in one navigation level without an overview page. Read more about navigation levels here and see a demo here.

Using the clipboard

When selecting the Clipboard clipboardBigIconActive option from the sitemap toolbar, the clipboard opens in an overlay window. It features two lists of recently edited pages in the sitemap editor.

Tabs of the clipboard

The modified list will be displayed as default and contains pages that have recently been modified in the sitemap editor. When you move the mouse over a list entry, an option appears on the right side of the bar, which shows an option to display the page in the sitemap editor. If clicked, the overlay window is closed and the selected page will show up blinking in the editor.


This list holds all pages that had been deleted from the sitemap without publishing the deletion. Moving the mouse over a list entry will reveal an Undelete option at the right side of the bar, restoring the original state of the resource before it was deleted.

Changing the sitemap editors view

Selecting the Select view sitemapBigIconActive option from the toolbar, you can change the view of the sitemap editor. The following views are available.

The sitemap editors views

The main view that shows the sitemap and allows to add, edit and delete webpages.


Shows the site's folder tree containing all resources in the Virtual File System of OpenCms.


Shows the galleries (image and download galleries) that are stored in the current sitemap. You can add, edit or remove galleries.


Shows the categories available in the current sitemap. Local categories, i.e., categories defined in the current sitemap can be edited. Global categories, i.e., categories defined in some parent sitemap or system wide, can only be viewed.


Shows the template models and model group pages defined in the sitemap. You can add, edit or remove models. Read more about template models here and about model groups here.

Compare locales

A special view to manage locale variants of pages. See here for more information on multilingual websites in OpenCms.

Context menu

The Context menu displays all available options of the current sub sitemap.

Switch site

Switch the current site.

Show parent sitemap

Shows the parent sitemap of the current sitemap. The options appears only in sub-sitemaps.


Refresh the view on the sitemap.

Advanced > Edit aliases

Shows the "Edit aliases dialog" for the sitemap. Read more here.

Advanced > Sitemap configuration

Opens the sitemap's configuration.

Publish queue

Opens the "Publish Queue" workplace app.

You can improve this page

Please contribute your suggestions or comments regarding this topic on our wiki. For support questions, please use the OpenCms mailing list or go for professional support.