Posted on

Region/Templates Scanning Guide

Regions inside of Pope Tech allow you to separate the template region results from content region results. This allows users who can only change content on a website to only see accessibility issues that are part of the content region(s) of your website.

Note: If you don’t find the region options your account owner needs to give you this permission or if you are the account owner you need to contact the support team to turn this on for your account.

Setting up your template(s) and content regions

When editing a website if you have access to the templates feature there is tab called, “Templates”.

Under this tab you can view or edit all of the templates for the website you are editing or create a new template.

You can create multiple templates for a single website. In this example I have a College template for all pages on the website except for the calendar pages which have a Calendar template setup. This is because the template or wrapper around the content is different on these pages than the main college template.

Creating a template

A template consists of a name, content area(s) and page matcher(s). In this example I selected the “New” button and named my template College template.

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.

In this example the website has a class of ContentDiv that is wraps all of the content.

Note: if your website doesn’t have a defined wrapper(s) for your content, the Region 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.

The Page Matcher could be a pattern or a specific page. In this example I chose pattern and set it to “/” so all pages will match this template.

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

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

Regions 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 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, 0 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.

That is it your regions are set up, you can go back and add a new template to this website for calendar or if you only have one template you are all set up and can add users to only view content results.

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.

Debugging Regions

Below are some questions that are helpful in debugging regions if you think things aren’t working as you expected.

What are 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. If things are set up correctly you can ignore versions, but they let you debug your setup and see how things are calculated.

What are pages not included?

In our example, all pages are 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.