Preparing the site toolbar | HCL Digital Experience

The site toolbar enables content authors to work with content from the website instead of using the authoring portlet. Customize the site toolbars to improve the authoring experience for content authors.

In the authoring environment, content authors use the site toolbar to access and add content and applications to pages. Content authors can also create and manage pages by using the site toolbar.

Site toolbar customization includes the following options:
  • Adding content
  • Adding applications

The HCL Portal 8.5 site toolbar is built with portal pages and portlets. The available toolbar tabs are implemented as portal pages, which are content labels or content pages, that are grouped under the toolbar content root. All content pages and content labels that are children of the toolbar content root show up in the toolbar navigation as toolbar tabs.

By default, the toolbar content root has the unique name ibm.portal.toolbar.ContentRoot and can be found under the hidden pages root unique name ibm.portal.HiddenPages.

The toolbar navigation supports two levels only. Content pages or labels that are appended to an existing toolbar sub tab does not show up in the toolbar navigation.

To extend the site toolbar with custom toolbar tabs, you can perform the following tasks:

  • Create a toolbar first-level tab by appending a content page or content label to the toolbar content root.
  • Create a toolbar sub tab by appending a content page to one of the existing first-level tabs or to a custom first-level tab.
You can influence the order of the toolbar tabs by setting ordinals on the toolbar content nodes. Use the theme that is set on the toolbar content root. To enable intercommunication with the main page, you must set the page parameter ibm.portal.toolbar.isToolbarPage = true for your custom toolbar content pages and content labels.
Note: As this parameter is already set on the Toolbar Content Root parent node, the new page or label inherits it. Therefore, you cannot set it as a new parameter. You need to edit the existing parameter and overwrite the inherited value of true explicitly with the value true. Then, you can view the new page or label on the toolbar side navigation.

To use the XML configuration interface for creating and managing your toolbar tabs, set this parameter as follows:

<parameter name="ibm.portal.toolbar.isToolbarPage" type="string"

For performance reasons, this parameter must be set on every toolbar content node. If it is not set, the toolbar tab does not have access to the context of the main page.

You can now start to add content to your toolbar. Add a portlet to the content page that your toolbar tab represents. For more information, see Implementing portlets for the site toolbar.

The feed that displays all portlets is cached after it is displayed. If you deploy a portlet after you view the portlets on the toolbar, the newly deployed portlet is not visible until the cache expires. The cache expires after one hour. Alternatively, you can look up the portlet in Manage Portlets and then go back to the toolbar.

HTML 5 considerations

All of the drag-and-drop actions are based on the native HTML 5 drag-and-drop capability. The content items that are displayed in the toolbar, for example in the Page Components palette or the Applications palette, are marked as draggable in terms of HTML 5.

The Search controls that are displayed on some toolbar tabs, use the auto-completion capability of HTML 5. Internally it is based on the HTML 5 <datalist> tag. As a consequence, you might see different search result suggestions, depending on the browser that you use. Internet Explorer version 9 does not support the HTML 5 auto completion feature.