Skip to main content
Skip table of contents

Page Context

When a request is mapped to a Confluence page or blogpost, the template is rendered in the page context.

All templates that are not rendered in another context are rendered in the page context.

The Page context renders two different templates, based the following rules:

  • page.vm — Used for all pages.

  • home.vm — It is optional, and - if existing - will be used to output the home page of a space.

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.

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.

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.

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.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.