Technical documentation - Toolbar, menu and footer settings

TThis article describes the settings available to configure the toolbar, footer and menu using profile.config.

Hide or show toolbar and footer

Toolbar and footer can be configured to be shown or hidden.

profile.config

<ToolBarsSettings> <ToolBarsLayoutSettings target="Desktop"> <!-- Show or hide header --> <ToolBarSetting id="Header" enabled="false" /> <!-- Show or hide toolbar --> <ToolBarSetting id="ToolBar" enabled="true" /> <!-- Show or hide breadcrumb --> <ToolBarSetting id="BreadCrumb" enabled="true" /> <!-- Show or hide footer --> <ToolBarSetting id="Footer" enabled="false" /> <!-- Not implemented yet --> <ToolBarItemsSettings /> </ToolBarsLayoutSettings> <!-- Not implemented yet --> <ToolBarLayout target="Tablet" /> <!-- Not implemented yet --> <ToolBarLayout target="Phone" /> </ToolBarsSettings>

Custom menus in version 4.4, 4.5 and 5.0

Determines if custom menu items or toolbar items can be added. Items are defined in <MenuProvider>. Default is false. 

profile.config

<CustomMenuEnabled>true</CustomMenuEnabled> <MenuProvider> <Menus> <Menu> <!-- This is a text key that can be added in custom-text.config. --> <MenuTextKey>Hello_World</MenuTextKey> <!-- http:// is important! --> <MenuUrl>http://www.test.com</MenuUrl> <!-- Open in separate tab --> <Target>_blank</Target> <!-- This item will be placed in menu. Options are Menu or Toolbar --> <Placement>Menu</Placement> <!-- Default icon is a wheel. In version 5 and later it is possible to select another icon from the predefined icons. See below for list of available icons. --> <IconName>Table</IconName> <!-- Key text to show at hoover --> <ToolTip>CustomMenuText</ToolTip> <!-- From version 5.0.3 permissions can be added to a menu option --> <Permissions>Permission1,Permission2</Permissions> </Menu> <Menu> <MenuTextKey>Bye_me</MenuTextKey> <!-- This item will be placed in toolbar. --> <Placement>Toolbar</Placement> <MenuUrl>http://www.test2.com</MenuUrl> <!-- Alignment only possible in toolbar. Options are left and right. --> <Alignment>left</Alignment> </Menu> </Menus> <!-- Key text to show at hoover. --> <OrderToolBarToolTip>Key_text</OrderToolBarToolTip> <BulletinToolBarToolTip>Key_text </BulletinToolBarToolTip> <ContactToolBarToolTip>Key_text </ContactToolBarToolTip> <CallCentreToolBarToolTip>Key_text </CallCentreToolBarToolTip> <OrderTypeToolBarToolTip>Key_text </OrderTypeToolBarToolTip> <UserDropdownToolBarToolTip>Key_text </UserDropdownToolBarToolTip> </MenuProvider>

Available icons are listed here:

Custom menus in version 5.1 and later

Determines if custom menu items or toolbar items can be added. Items are defined in <MenuProvider>. Menu provider does not have to be enabled, if it is defined it is used.

The menu may link to a url by using the <Url> tag or to a presentation using the <Presentation> tag.

Tag

Attribute

Values

Usage

Tag

Attribute

Values

Usage

Menu

heading

 

KeyText for the name of the menu.

Menu

permissions

 

Comma separated list of permissions. If user has any of the permissions in the list, user will see menu.

Menu

alignment

left, center, right

Alignment of menu if it is in the toolbar.

Menu

display

toolbar, menu

Placement of the menu, in the toolbar, or in the menu

Menu

class

 

Will add a css class to the menu for styling purposes

Menu

anchor-class

 

Will add a css class to the menu for styling purposes, typically hoover effect

Menu

icon

Icon name, see link below

Name of icon to use

Menu

display-icon

true, false

Show icon or not on menu

Menu

target

_blank

_blank as attribute for target will open URL in a new tab

Presentation

persistent-identity

 

Persistent identity of a presentation. base-type must also be used if this attribute is used.

Presentation

identity

 

Identity of a presentation. base-type must also be used if this attribute is used.

Presentation

label

 

Label of a presentation. base-type must also be used if this attribute is used.

Presentation

base-type

Any base type

Base type of the presentation pointed out by persistent-identity, identity or label

Url

language

market

A language code for URLs specific to a language

A market code for URLs specific to a market

If no language or market specified, function will fallback to general url.

Url which the presentation may point to.

profile.config

<MenuProvider> <Menus> <Menu heading="Documents" permissions="Administration" alignment="right" display="toolbar" class="cssclass" anchor-class="hover-effect" icon="File"> <Presentation persistent-identity="documentation" base-type="Catalogue" /> </Menu> <!-- Open base URL in new tab --> <Menu heading="Title" alignment="center" display-icon="false" display="toolbar" target="_blank" class="cssclass" anchor-class="hover-effect"> <Url>http://signifikant.se</Url> <Url language="en-GB">http://signifikant.se</Url> </Menu> <Menu heading="Title" alignment="center" display-icon="false" display="toolbar" class="cssclass" anchor-class="hover-effect"> <Url>http://signifikant.se</Url> <Url market="EMEA">http://signifikant.se</Url> </Menu> </Menus> </MenuProvider>

Available icons are listed here:

Footer

Custom footer text. Default is “Copyright Signifikant Svenska AB”. Note that “&” cannot be used in the footer directly. In case “&” is needed use “&amp;”. Footer may contain several links and also open in separate tab. Text tag can be the actual text or a key text used as a custom text with translation.

profile.config


Also see for how custom footers may be created.

Showing or hiding the toolbar

Header and toolbar is by default two fields. Set to true if the toolbar shall be visible. Default is true.

profile.config

 

Other settings for toolbar behaviour

With this property set to true, clicking the logotype or start in the breadcrumb will take the user to the start catalogue. With the property set to false, the user will be directed to the portal start page.

profile.config

With this property set to true, clicking the logotype will take the user to a static Url that is defined by value of element CompanySettings\CompanyHomeUrl. With the property set to false, the user will be directed to the portal start page or to the catalogue start page; see LogotypeToStartCatalogue above.

profile.config