Branding Help

This page provides information to assist developers and vendors with branding up their systems & products to be in sync with the council's main design including ensuring any dynamic data is reflected in the remote system.

It is important that you do not just take a static copy of the branded page but regularly retrieve it to ensure the latest HTML is applied, caching a local copy for a set period of time.

The branded pages by default have all of the main features of the website pages, however you can control which features appear and how they work by using a set of query string parameters.

If there is no option but to take a static copy of the page assets then you can download the latest copies here:

Layouts

The branded pages currently offer 3 layouts:

  1. /branding/full-width - Full width with single central content column.
  2. /branding/left-column - 2 column layout with left aside column with right content column.
  3. /branding/right-column - 2 column layout with right aside column with left content column.

Options

You can control various features of the page through supplying querystring parameters on the branding url of your choice. Apply as main as you need to override to generate the template to suit your requirements.

ContentAreaMarker

The area where you can insert your main content is marked with a comment within the HTML. You can control the text within the comment using this parameter.

e.g. /branding/full-width?ContentAreaMarker=INSERT%20HERE

Default: CONTENT AREA

LeftColumnMarker

The area where you can insert your left column content is marked with a comment within the HTML. You can control the text within the comment using this parameter.

e.g. /branding/left-column?LeftColumnMarker=INSERT%20ASIDE%20HERE

Default: LEFT COLUMN

RightColumnMarker

The area where you can insert your right column content is marked with a comment within the HTML. You can control the text within the comment using this parameter.

e.g. /branding/right-column?RightColumnMarker=INSERT%20ASIDE%20HERE

Default: RIGHT COLUMN

Breadcrumb

You can add some text to the breadcrumb to indicate the page being viewed using this parameter.

e.g. /branding/full-width?Breadcrumb=My%20Page

Default: empty (does not show anything)

ShowBreadcrumb

You can control whether the breadcrumb feature appears using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?ShowBreadcrumb=0

Default: 1 (true)

ShowDisplayOptions

You can control whether the accesibility display options appear using this parameter. A value of '1' is assumed as true, all other values are taken as false.

Because the website uses cookies to determine this it is not always possible for a 3rd party to be able to support this using the website's built-in feature.

e.g. /branding/full-width?ShowDisplayOptions=1

Default: 0 (false)

ShowRateThisPage

You can control whether the rate this page feature appears using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?ShowRateThisPage=0

Default: 1 (true)

ShowSocialButtons

You can control whether the social buttons/links appear using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?ShowSocialButtons=0

Default: 1 (true)

ShowSearch

You can control whether the site search feature appears using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?ShowSearch=0

Default: 1 (true)

ShowAllServices

You can control whether the All Services button appears using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?ShowAllServices=0

Default: 1 (true)

ShowLocationSearch

You can control whether the location search feature appears using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?ShowLocationSearch=0

Default: 1 (true)

ShowLogin

You can control whether the login feature appears using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?ShowLogin=1

Default: 0 (false)

SearchAction

You can control the form action that is used in the site search feature using this parameter. Typically changed when you need the search to operate on your system and not the website search.

e.g. /branding/full-column?SearchAction=/mysearch

Default: Searches on the main council website

SearchMethod

You can control the form method that is used in the site search feature using this parameter. Typically changed when overriding the search action.

e.g. /branding/full-width?SearchMethod=POST

Default: GET

SearchKeywordsInputName

You can control the name for the keywords input text box that is used in the site search feature using this parameter. Typically changed when overriding the search action.

e.g. /branding/full-width?SearchKeywordsInputName=query

Default: k

ArticleId

Allows you to specify the value of the id attribute of the content area article tag.

e.g. /branding/full-width?ArticleId=MyArticleId

Default: (nothing)

PageTitle

Allows you to specific the value in the title tag. Please note a default suffix will always be applied to the title.

e.g. /branding/full-width?PageTitle=My%20Page%20Title

Default: (nothing)

JQueryInHead

You can control whether the jQuery script is loaded in the head or at the bottom of the page using this parameter. A value of '1' is assumed as true, all other values are taken as false.

e.g. /branding/full-width?JQueryInHead=1

Default: 0 (false)