NAVIGATION


A

Macro
AdminUIOnly : Display content for admins only.
Macro AfterSearchOnly : Conditional display, content is evaluated only when there are results.
Macro AuthToken : Generates an authentication token suitable for click tracking redirection, based on the globally configured server_secret.

B

Macro
boldicize : Wraps words into strong tags.

C

Macro
Category : Displays a contextual navigation category or a faceted navigation category.
Macro CategoryCount : Displays the result count for a facet category value.
Macro CategoryName : Displays a link for a facet category value.
Function CategoryUrl : Returns the URL back to the current page with the current category selected.
Macro cfg : Read a configuration parameter.
Macro cgi : Retrieves a cgi parameter value.
Macro CheckBlending : Checks if a query blending occurred and provide a link to cancel it.
Macro CheckSpelling : Displays spelling suggestions.
Macro ClickHistory : DEPRECATED in v13: Display the click history
Macro ClusterLayout : Conditional display against contextual navigation clusters.
Macro ClusterNavLayout : Displays previously followed clusters.
Macro Clusters : Iterates over contextual navigation clusters.
Macro Collapsed : Generates a link to show the results that were collapsed with this specific result.
Macro ContextualNavigation : Root tag for contextual navigation.
Macro ContextualNavigationNav : Iterates overs previously followed clusters.
Macro CurrentDate : Displays the current date and time.
Macro cut : Cut the left part of a string if it matches the given pattern.

D

Macro
Date : Displays the last updated date of the collection being searched.

E

Macro
ErrorMessage : Displays search error message.
Macro ErrorMessageJS : Displays error messages in the JS console.
Macro Explore : Generates an "explore" link for a search result.
Macro ExtraResults : Process results coming from an extra search.
Macro ExtraSearch : Perform an additional search and process results.

F

Macro
Facet : Displays a facet, a list of facets, or all facets.
Function FacetAllUrl
Macro FacetBreadCrumb : Recursively generates the breadcrumbs for a facet.
Macro FacetedSearch : Conditional display against faceted navigation.
Macro FacetLabel : Displays a facet label and a breadcrumb.
Macro FacetScope : Display the facet scope checkbox.
Macro FacetSummary : Displays The facet summary and breadcrumb.
Macro Format : Formats a string according to a Locale.
Macro FormChoice : Provide links to collection search forms.

H

Macro
HasClickHistory : Check if the user click history is empty or not.
Macro HasSearchHistory : Check if the user search history is empty or not.
Macro HtmlDecode : Decodes a String from HTML.

I

Macro
IfDefCGI : Conditional display against CGI parameters (Query string).
Macro IfNotDefCGI : Conditional display against CGI parameters (Query string).
Macro IncludeUrl : Includes content from an an external URL.
Macro InitialFormOnly : Conditional display, content is evaluated only when there is no search.
Macro italicize : Wraps words into emphasis tags.

M

Macro
MoreOrLessCategories : Displays a link to show more or less categories for a facet.
Macro MultiCategories : Multiple facet selection: Categories tag.
Macro MultiCategory : Multiple facet selection: Category tag.
Macro MultiFacet : Multiple facet selection: Facet tag.
Macro MultiValues : Multiple facet selection: Values tag.

N

Macro
Next : Generates a link to the next page of results.
Macro NoClustersFound : Conditional display against the presence of clusters.

O

Macro
OpenSearch : Generates an Open Search link.
Macro Optimise : Generates an "audit SEO" link to the SEO Auditor (From the admin side only)

P

Macro
Page : Generates links to result pages.
Macro PerformanceMetrics : Displays a table with the time taken by each step in the query lifecycle.
Macro Prev : Generates a link to the previous page of results.
Macro PrevNext : Generates previous / next navigation links, and page shortcuts.

Q

Macro
QueryClean : Displays the cleaned query.
Macro Quicklinks : Conditional display against quick links.
Macro QuickRepeat : Iterates over quick links.

R

Function
renderSize : Converts a size to its equivalent in gigabytes, megabytes, or kilobytes as appropriate.
Macro ResultCart : DEPRECATED in v13: Display a link to add a result to the cart
Macro Results : Conditional display against results and results looping.
Macro ResultsCart : DEPRECATED in v13: Display the result cart
Macro rss : Generates a RSS link or button for the current query.

S

Macro
SearchHistory : DEPRECATED in v13: Display the search history
Macro Select : Generates a HTML <select /> tags with options.
Macro ShortFacetLabel : Displays facet title or value of the current category.
Macro ShowFewerClusters : Link to show less clusters.
Macro ShowMoreClusters : Link to show more clusters.

T

Macro
Truncate : Truncate a string on word boundaries.
Macro TruncateHTML : Truncate a string on word boundaries.
Macro TruncateURL : Truncate an URL in a sensible way.

U

Macro
URLEncode : Encodes a String in URL format.

V

Macro
ViewModeBanner : Displays the preview / live banner.