Posted on

Template Regions Guide

The goal of the template/regions feature is to allow the separation of template results from content results that change page by page. When setup, this allows users who can only change content on a website to only see accessibility issues that are part of the content area(s).

Note: Templates must be turned on for you to see this, if you don’t and would like to see it please contact support. This is still a beta feature implemented for customers who want to provide feedback.

Creating a template

On any website view there is now a new tab called, “Templates”.

This lists all templates created for the website you are viewing. To create a new template activate the “New” button. You can create multiple templates for a single website. For example a website might have a home template, a template with a right sidebar and one without as well as a calendar template. Each template is then matched to the pages or patterns you want added to that template

To create a template you need to provide a name for the template such as, “Blog Pages” or “Content” and then define the content areas that should be applied to the template along with the page matchers.

Content Area(s)

A Content Area is an html container on your website that wraps the content that changes from page to page. It can be defined by the the html class or id attribute.

The Pope Tech Blog for example has a div with the id of, “main” that surrounds all content. Outside of the div are the header and the footer. In the screenshot above you can see for our blog we named the template, “Content” and set up a content area with the id of, “main”.

Some websites might have a main content area and a footer content area, you could have 2 content areas defined. Keep in mind that if the html outside of the content areas varies significantly from page to page you will have more versions of the template. A possible solution is creating multiple templates for the website for different pages.

Note: if your website doesn’t have a defined wrapper(s) for your content the template feature won’t work.

Page Matcher(s)

Page Matcher(s) define what pages or directories the template is applied to. A calendar template for example might only be applied to /calendar.

In the example above for the Pope Tech blog we choose pattern as the type of Page Matcher and used the path of, “/”. This will apply all pages to this template. Any new pages added that match the path will automatically be added to this template.

If you only wanted to add the home page to a template you would choose the Exact type and then the Page Matcher would be “/” for the home page.

If the “Add existing pages that match?” checkbox is checked then any page added before the template was created that match will also be added.

Once you have your Content Areas and Page Matchers set up Save the form and you can see which pages were added on the pages tab.

View or change which pages are matched to a template

On our website we now have a defined template of “content”. If we go back to the Pages tab we can see which pages are applied to the template.

By Default the pages are filtered to all templates, but can be changed to Content or to view pages that are not in any template. Once pages are selected there is a button in the toolbar to add them to a different template.

Now that you have set up your template(s) and content area(s) and verified the right pages are matched to the template all new scans will apply the template to the scan.

Template and Content Results

Templates let you filter the dashboard, scan details or exportable reports to View all results as if templates weren’t set up, just view results that are inside of the defined content ares or view template results that are outside of the content areas.

Filtering to view template only results

For example, in our example of the Pope Tech Blog we have 449 Alerts, 4 contrast errors and 1.73k structure items as seen on the scan details view.


When Filtered to template results we only have 1 alert, – contrast errors and 6 structure items that are across the template. This means that there is 1 alert that is on all the pages of this template.

On the scan details view you can drill into a template to see the specific results

When you view the code inside of a template it is showing you one of the page examples of that code.

Template Versions

You will notice a version filter in the top right when drilled into a specific template.

The default version shown both on this view and in the results is the version that has the most pages. Templates have versions to account for the nature of websites, html is rarely the exact same on every page even outside of the content area. If the template was setup leaving areas that change significantly across pages outside of a content area you might many versions.

In our example we have 4 versions. You can see these below the results in the, “Versions and Pages not Included” widget.

Version 1 has 73 pages with the exact same template results. If you want to see the pages included in a version you can filter the top filter to a version and see a list of pages in the pages tab of the results.

In our example, version 2 has 1 extra alert because this page has pagination unlike the other pages, the pagination is outside of the content area, and the pagination has an alert.

Pages not included

In our example, there are not pages not included. The Pages not included would be any pages that matched the page matcher but when it scanned didn’t have a single content area on the page.

You can view these in the Versions and Pages not included on the “Pages Not Included” tab.

Permissions

With regions turned on, there are now permissions you can assign to any role for which region a user can see.

  • All = Users can filter to template, content or all.
  • Content Only = Users can only see content results. If a website doesn’t have templates set up they can’t see that websites results
  • Template Only = Users can only see template results. If a website doesn’t have templates set up they can’t see that websites results.
  • None = Users see the results as if templates wasn’t turned on, there are no filters, just the standard results

Reporting

With regions turned on there is an extra filter for reports called, “Region” Reports can be set to the following options:

  • All = The report will show both content and template result summary
  • Content = The report will only show content results
  • Template = The report will only show template results
  • None = The report will behave as it currently does without any content or template summaries

Note: a user with Content Only permissions would only be able to set up a report with content only. An admin could still send them any report options.