×

You're using an outdated browser

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

Manual

Using Page Properties in Templates for SEO

Thomas Walker

Thomas Walker Last update: Oct 17, 2017

You can use the built-in page properties macro to define SEO data and output it in a template.

Add Page Properties for a Page

Edit the page and create a page properties macro and create the SEO properties within a table (see the official documentation for more info how to create properties).

For example:

Left we have the keys you can access, and on the right there is the value to the page property. This way, you can store images, lists, links or just plain text. This information can be accessed within your Viewport.

Displaying the Content Properties

In your template, access the page properties with the $!page.properties placeholder. $!page.properties is used in this case because we don't want to output the variable name if it is not defined.

page.vm

<head>
  <title>$!page.properties.metaPageTitle</title>
  <meta name="Description" content="$!page.properties.metaDescription">
</head>

Info

Note that your page properties can also contain HTML – you can display them as text or as another resource form using HTML fragments.

Hiding Page Properties

By default page properties will be visible to everyone – usually, this should be avoided.

There are two ways of hiding them:

  1. Hide the properties by checking the Hidden setting for the page properties macro. The drawback of this approach is that you can only see the properties in the Confluence editor.
  2. Use a macro override to only hide the page properties in the Viewport. To do so, create a velocity file in your theme: overrides/details.vm like this:

    overrides/details.vm

    ## override output of page properties macro to not show page properties


    This will do the following:

    • 'details' is the internal name for the page properties report. Viewport will pick up that file automatically to render all page property macros.
    • The template only contains a comment, so Viewport will not render anything.
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