Search Context

When a URL contains a search request, the templates is rendered in the search context

search.vm — all search request are handled by this template is used. The search template should also handle empty search results, and invalid search queries.

Methods

Name	Type	Description
`attributionLine`	HtmlSafeString	A HTML snippet containing the attribution line that must be included in Scroll Viewport themes.
`baseUrl`	String	The base URL for the current prefix, not including the viewport path prefix. May be different from the base URL of Confluence if the viewport is configured for a specific domain.
`blog`	Blog	An object for accessing information about blog posts. This is an alias for: `$repository.blog`.
`comments`	Comments	A helper that provides access to the comment API.
`contextPath`	String	The web application context path of Confluence, for example: `/confluence`.
`dateTime`	org.joda.time.DateTime	The current DateTime. See Joda DateTime API for more information. The current user locale can be obtained using `$user.locale` for the purpose of dateTime formatting.
`find`	Find	A placeholder to find spaces and pages.
`hasBlogPosts`	boolean	`True` if blog posts are enabled in the current viewport, otherwise `false`.
`hasPages`	boolean	`True` if pages are enabled in the current viewport, otherwise `false`.
`htmlUtils`	HtmlUtils	A placeholder for HTML operations.
`i18n`	I18n	An object for retrieving I18n resources.
`include`	Include	A helper for including templates from the viewport theme and pages and blog posts from the Confluence system.
`isBlogOverview`	boolean	`True` if the current page displays a blog overview, otherwise `false`.
`isError`	boolean	`True` if the current page displays an error, otherwise `false`.
`isPage`	boolean	`True` if the current page displays a page or a blog post, otherwise `false`.
`isSearch`	boolean	`True` if the current page displays search results, otherwise `false`.
`languages`	Languages	The language properties or null if languages are not enabled. This is an alias for: `$repository.languages`.
`link`	Link	A helper that can be used to construct links to content in Confluence, such as pages, blog posts and spaces.
`math`	Class<java.lang.Math>	A helper object for mathematical operations. See java.lang.Math for more information.
`page`	Page	The page or blog post to be rendered.
`page`	Page	The page or blog post to be rendered.
`pager`	Pager	The Pager for the search results.
`pages`	Pages	An object for accessing information about the pages. This is an alias for: `$repository.pages`.
`readOnlyMode`	ReadOnlyMode	A placeholder for the Confluence read-only mode.
`redirect`	Redirect	A placeholder for redirect.
`repository`	Repository	The content repository of the current viewport.
`searchRequest`	SearchRequest	The search request.
`searchResults`	SearchResults	The search results.
`sort`	Sort	A Placeholder for sorting lists and maps.
`space`	Space	The space for which the viewport is configured.
`statusCode`	String	The 3-digit status code of the current HTTP response. Will typically be 200 if no error occurred.
`statusText`	String	The reason phrase of the HTTP status response. Will usually be Ok if no error occurred.
`stringEscapeUtils`	StringEscapeUtils	A helper object for escaping strings in the template. See StringEscapeUtils for more information.
`stringUtils`	org.apache.commons.lang.StringUtils	A helper object for modifying strings in the template. See StringUtils for more information.
`theme`	Theme	The current theme. Use to reference resources like CSS, JavaScript and image files from the theme, for example: `$theme.baseUrl/css/theme.css`.
`tree`	Tree	A helper object for rendering the page tree of the current viewport. Caution: The tree rendered by this helper contains all pages in the space and can potentially be very large.
`upp`	Upp	A placeholder for accessing extended user properties provided the "User Profile Plugin". For example:`$upp.getProperty($user, "Department")`. Note that the User Profile Plugin has to be installed for this to work.
`url`	Url	The current URL.
`urlEscaper`	UrlEscaper	Helper object for escaping strings for URLs.
`user`	User	The currently logged in user.
`userQuery`	String	The query string as provided by the user, as specified by the HTTP search request. HTTP parameter name: `q`.
`variants`	Variants	The variant properties or null if variants are not enabled. This is an alias for: `$repository.variants`.
`versions`	Versions	The version properties or null if versions are not enabled. This is an alias for: `$repository.versions`.
`viewport`	Viewport	The current viewport.
`webPanels`	WebPanels	A Placeholder for accessing Confluence. web panel modules.
`xsrfToken`	XsrfToken	A placeholder for generating an XSRF token to be included into follow-up form submissions or AJAX requests.