×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Blog overview context

Steffen Burzlaff

Steffen Burzlaff Last update: Feb 15, 2018


A URL that links to the root, to specific categories, or to the archive of a BlogPost-Mapping, results in the template being rendered in the blog overview context.

The Blog Overview context renders different templates, based the following rules:

  • blogs.vm — the mandatory, default template, that is used if not category is selected, or as fallback, if not category-specific template is available.
  • blogs-<categoryName>.vm — the category-specific template that is used to render the category page for a specific blog category.
 


Methods

Name Type Description
attributionLine HtmlSafeString

an 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

blogPosts List<Page>

The list of blog posts on this overview page.

categoryName String

The name of the current blog post category or null if this is not an overview page for a category.

comments Comments

A helper that provides access to the comment API.

contextPath String

The web application context path of Confluence, for example: /confluence

find Find

a placeholder for find.

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.

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.

pager Pager

A pager to paginate the blog posts.

pages Pages

An object for accessing information about the pages. This is an alias for: $repository.pages

redirect Redirect

a placeholder for redirect.

repository Repository

The content repository of the current viewport.

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

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.

2x2.11
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok