11.3.9 Breadcrumb Templates

Breadcrumb templates control the display of breadcrumb entries.

See also:

Using Themes

• About Breadcrumb Style Navigation
  Breadcrumbs provide users with hierarchical navigation and can be displayed as a list of links or as a breadcrumb path.
• Breadcrumb Template Attributes
  This section describes common breadcrumb template attributes.

11.3.9.1 About Breadcrumb Style Navigation

Breadcrumbs provide users with hierarchical navigation and can be displayed as a list of links or as a breadcrumb path.

You select a breadcrumb template when you create a region. Breadcrumbs usually indicate where the current page is relative to other pages in the application. Users can click a specific page to instantly view it. The following is an example of breadcrumb navigation in Sample Reporting Sample App.

Description of the illustration bc_menu.png

See Also:

Creating Breadcrumbs

11.3.9.2 Breadcrumb Template Attributes

This section describes common breadcrumb template attributes.

• Name
  
• Definition
  
• Substitution Strings
  

11.3.9.2.1 Name

Name identifies the name of the template. Use the Translatable checkbox to indicate that the template contains text strings that require translation. Theme indicates the theme to which the template is a member. Template Class identifies a specific use for the template. When you switch to a theme, all templates in one theme are mapped to corresponding templates in another theme. App Builder accomplishes this template mapping through the assignment of a template class.

11.3.9.2.2 Definition

Definition attributes control how a breadcrumb displays Table 11-8 describes Definition attributes.

Table 11-8 Definition attributes

Attribute	Description
Before First	Defines text that displays before the first breadcrumb entry. Use the substitution string #COMPONENT_CSS_CLASSES# to apply a CSS class to your breadcrumb template. You edit component CSS classes by editing the region attributes. See Also: Editing Region Attributes
Current Page Breadcrumb Entry	Defines the look of a breadcrumb entry that corresponds to the current page.
Non Current Page Breadcrumb Entry	Defines the look of a breadcrumb entry that does not correspond to the current page.
After Last	Defines text that displays after the last breadcrumb entry.
Between Level	Defines text that displays between levels of breadcrumb entries.
Maximum Levels	Specifies the number of levels that appear when displaying breadcrumbs in a breadcrumb style.

11.3.9.2.3 Substitution Strings

Substitution strings are used within templates to reference component values. To view the most current list supported substitution strings for a given template, view the template and find the Substitution Strings report.

Tip:

All template substitution strings must be in uppercase letters and begin and end with a number sign (#).

Table 11-9 Breadcrumb Template Substitution Strings

Referenced From	Substitution String	Description
Before First	#COMPONENT_CSS_CLASSES#	Component CSS classes. The #COMPONENT_CSS_CLASSES# string must be included in the before-first attribute for templates that have template options defined. The #COMPONENT_CSS_CLASSES# string is where the corresponding template option classes are injected at runtime.
Current Entry	#LINK#	URL Link.
Current Entry	#LONG_NAME#	Breadcrumb Long Name.
Current Entry	#NAME#	Breadcrumb Label.
Current Entry	#NAME_ESC_SC#	Breadcrumb Label (escaping HTML characters).
Non Current Entry	#LINK#	URL Link.
Non Current Entry	#LONG_NAME#	Breadcrumb Long Name.
Non Current Entry	#NAME#	Breadcrumb Label.
Non Current Entry	#NAME_ESC_SC#	Breadcrumb Label (escaping HTML characters).