Using a consistent look throughout the Government of Canada web presence is crucial to building a trustworthy experience for people. People need to know they'll find information they can trust.
-
-
Use the mandatory elements of the Canada.ca design system to implement this trusted brand.
-
-
The mandatory elements you need to follow are:
-
-
-
Canada.ca domain
-
mandatory styles (typography, colours and layouts)
-
standard header and footer
-
a handful of high-level mandatory templates to establish a consistent institutional presence and the Canada.ca topic tree
-
-
-
Once you've applied this uniform brand, you can still use creativity within the body of the page to come up with the best design to help people complete their tasks.
People can’t succeed at a task if they can’t find where to initiate it.
-
To improve findability, you can work on:
-
-
navigation
-
internal and external search
-
-
-
Navigation
-
-
Some people will navigate to their task on the Canada.ca site. To support this, making a clear path for people's tasks is crucial. That means planning your navigation structure and taking time to understand what labels will work best for your audience.
Once people find the page they need, they have to be able to understand what they read. The way we write and the words we use make an enormous difference.
Use patterns and layouts that will make it easy for people to complete their tasks. This could be simple text, a filterable table, a button, an interactive checklist or other patterns.
-
-
If you can't find an existing pattern or template in the library that does everything you need, you can get creative as long as you respect the mandatory elements of the design system. If your solution works well, we may add it to the Canada.ca design system for others to use when they have similar needs.
-
-
Do usability testing to make sure your design really does help people complete their tasks.
Due to the coronavirus (COVID-19) outbreak, you may experience longer than normal wait times on our phone lines. The automated phone lines are available. If possible, use the online self-service options.
-
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Et a adipisci nostrum optio dolorum sint ipsa facilis nisi quisquam laboriosam.
-
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Praesentium odio adipisci ad neque distinctio quod molestias, molestiae accusamus quo aspernatur expedita blanditiis quam! Esse cum modi atque, beatae aliquam, dolor.
-
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Voluptatem aliquid hic numquam obcaecati ea, laborum accusamus culpa atque voluptate distinctio et omnis! Alias, beatae, tenetur.
-
-
[Sub heading]
-
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Corrupti cupiditate voluptatem praesentium, facilis corporis magni esse reiciendis distinctio. Vitae totam iste porro, esse facere obcaecati? Laborum earum minus harum enim.
-
-
-
[Sub heading]
-
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ipsa hic minima magni nesciunt nam. Facilis perferendis, adipisci voluptates, enim illo perspiciatis molestias itaque iste qui distinctio asperiores quidem voluptatum sunt.
Due to the coronavirus (COVID-19) outbreak, you may experience longer than normal wait times on our phone lines.
- The automated phone lines are available. If possible, use the online self-service options.
-
The Canadian Food Inspection Agency is dedicated to safeguarding food, animals and plants, which enhances the
- health and well-being of Canada's people, environment and economy.
Due to the coronavirus (COVID-19) outbreak, some of our offices may be closed and you may experience longer than normal wait times on our phone lines. If it is possible, use the online self-service options.
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
- Sub-section heading
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
- Sub-section heading
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
-
- Tab label 2
-
-
- Section heading for second tab
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
- Sub-section heading
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
- Sub-section heading
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
-
- Tab label 3
-
-
- Section heading for third tab
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
- Sub-section heading
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
- Sub-section heading
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Section 1
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Sub-section heading
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Section 2
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
-
-
- Section 3
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turp is egestas maecenas pharetra convallis posuere morbi leo urna.
-
- Use the legal title if the applied title is not available.
-
-
- Do not use acronyms or abbreviations.
-
-
- Image
-
-
-
- Optional
-
-
-
- The 1200x726 space behind the H1 can be used for a banner or image. The image does not have to take up the whole space and can be customised as needed.
-
-
- The image and H1 should be visually distinct from the
-
- Canada.ca homepage
-
- to prevent confusion between institutional landing pages and Canada.ca.
-
-
- If you don't use an image, the background should be white.
-
-
-
- Variation:
-
- The class
-
- bg-hide-sm
-
- hides the image on tablet,
-
- bg-hide-xs
-
- hides the image on mobile and
-
- bg-right
-
- positions the image on the right.
-
-
- Super task button
-
-
-
- Optional
-
-
-
- Only include a super task button if there is a specific task that has at least a third of the clickthrough on the institution's home page. This is intended mainly for signing into an account.
-
- The featured link is a short, descriptive link that your institution needs to feature prominently. It should be used to bring attention to warnings or notices.
-
-
- Don't include images in this section.
-
-
- The "Featured" heading in this section should have the
-
- wb-inv
-
- class, so it is not visible, but still present for the semantic outline and screen readers.
-
- This component provides shortcuts to the institution's top tasks. However, if all of the institution's top tasks are already included as direct links under Services and information, do not duplicate them here. In that case, you can choose not to include this component.
-
-
-
- Variations:
-
- Replace the
-
- colcount-md-2
-
- class with
-
- colcount-md-1
-
- to make it 1 column instead of 2.
-
- Use action verbs, or simply list keywords to summarize the information or tasks that can be accomplished on the page it links to.
-
-
-
-
-
-
-
-
-
-
-
- Guidance:
-
- Services and information
-
-
-
-
-
- Mandatory
-
-
-
- Lists the institution-specific topics or top tasks.
-
-
- The "Services and information" heading in this section should have the
-
- wb-inv
-
- class, so it is not visible, but is still present for the semantic outline and for screen readers.
-
- The first 2 links are mandatory: Mandate and Transparency.
-
-
- Other links in this section can include:
-
-
-
- Programs
-
-
- Consultations
-
-
- Organizational structure
-
-
- Reports
-
-
- Job opportunities
-
-
- any other link that goes to content that falls under Corporate information or Program and policy development
-
-
-
- Minister or Institutional head
-
-
-
- Mandatory
-
-
-
- Links to an institution’s minister(s), including associate minister(s), or its institutional head.
-
-
- Text is linked to the appropriate ministerial profile page (see
-
- Ministerial profile pages
-
- ). The hyperlink text is the minister or institutional head’s honorific (“The Honourable”) and first and last name.
-
-
- Text under the link is the minister or institutional head’s official title.
-
- List the official role(s) of the minister, with links to lead institutional profile, riding
- information, mandate letter, briefing book, and ministerial appointments where applicable
-
-
- Hyperlink the name of the riding to the appropriate riding page from
-
- www.parl.gc.ca
-
-
- Lists the official role(s) of the parliamentary secretary, with link(s) to related ministerial
- profile.
-
-
-
- Follow mandatory text format: Parliamentary Secretary to the Minister of [insert
- portfolio name]
-
-
- Hyperlink the supported minister to the appropriate ministerial profile page
-
-
-
-
-
-
-
-
-
-
- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Tempore amet ducimus nihil, voluptate quibusdam?
- Excepturi in aspernatur rem ipsam aperiam voluptates fugit officiis culpa, ratione, et maxime impedit.
-
-
- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Similique ex commodi autem laudantium aliquam id,
- voluptate possimus quod illo velit vero, at dolorum sequi ipsam culpa fugit, molestias quaerat vitae.
-
- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Tempore amet ducimus nihil, voluptate quibusdam?
- Excepturi in aspernatur rem ipsam aperiam voluptates fugit officiis culpa, ratione, et maxime impedit.
-
-
- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Similique ex commodi autem laudantium aliquam id,
- voluptate possimus quod illo velit vero, at dolorum sequi ipsam culpa fugit, molestias quaerat vitae.
-
- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Tempore amet ducimus nihil, voluptate quibusdam?
- Excepturi in aspernatur rem ipsam aperiam voluptates fugit officiis culpa, ratione, et maxime impedit.
-
-
- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Similique ex commodi autem laudantium aliquam id,
- voluptate possimus quod illo velit vero, at dolorum sequi ipsam culpa fugit, molestias quaerat vitae.
-
- This component provides shortcuts to the theme or topic top tasks. However, if all of the topic's top tasks are already included as direct links under Services and information, do not duplicate them here. In that case, you can choose not to include this component.
-
-
-
- Variations:
-
- Replace the
-
- colcount-md-2
-
- class with
-
- colcount-md-1
-
- if you only have 2-3 most requested items.
-
- Use action verbs, or simply list keywords to summarize the information or tasks that can be accomplished on the page it links to
-
-
-
-
-
-
-
-
- Guidance:
-
- Services and information
-
-
-
-
-
- Mandatory
-
-
-
- Lists the sub-topics and destination content related to the current theme or topic.
-
-
- The "Services and information" heading in this section should have the
-
- wb-inv
-
- class, so it is not visible, but is still present for the semantic outline and for screen readers.
-
- Proactive disclosure of information, made public so that Canadians and Parliament are better able to hold the Government and public sector officials to account.
-
-
-
-
-
-
- Guidance:
-
- Page title and introduction
-
-
-
-
-
Use the Canada.ca domain for all public-facing Government of Canada web pages, to ensure consistency and enhance trust. This includes websites or services that are intended for people outside government but require a login to access.
Responsive carousels are in-page components used to display multiple different items within the same content space.
-
-
-
When to use this pattern
-
Use this component for situations such as image or video galleries.
-
-
-
-
-
What to avoid
-
Don't use this component:
-
-
to promote activities and initiatives
-
when a person’s flow must not be interrupted, as in a transactional process
-
when it would duplicate content from other components on the page
-
-
-
-
How to use this pattern
-
-
Responsive carousels are a set of 2 to 4 rotating slides that refresh on page load, with user-controls to rotate through the slides and to toggle to auto-rotation
-
The default controls for stepping through the slides are thumbnails for large screens and forward/back buttons, including an “Item X of X” message for small screens
-
When auto-play is activated, the default slide for the start of auto-rotation is slide one
-
The default timing for auto-rotation is 9 seconds per slide
-
The default style for transitioning between slides is horizontal sliding transition, starting from the right edge
-
Carousels may be implemented at various sizes, ranging from a single column to the full width of the screen
-
Each slide is made up of a combination of text and imagery, with the option to add a button link
-
Both text and imagery must be linked, but all links in the carousel slide must point to the same destination
-
Any call to action must be described in the hyperlink text or button link
-
A maximum of 65 characters is allowed for all of the text on a carousel slide (including link label)
-
Textual elements must be coded as HTML text—do not embed text into imagery
-
Use the defined presentation classes included in the Canada.ca WET theme
Don't use checkboxes or radio buttons to present options that are not easily comparable. In these cases, use the Services and information (doormat) pattern:
For a stand alone question with few options and a manageable amount of content per option that does not require separate pages, use expand/collapse or tabs instead:
When to use: Large checkboxes are the recommended checkbox pattern. In particular, large checkboxes should be used when one or more selections can be made to answer a question.
-
What to avoid: Don't use the large checkboxes when building a checklist with items that break across multiple lines or when only a single item can be checked. For these situations, use tickboxes instead.
Add the gc-chckbxrdio class to the fieldset or the container element surrounding the checkbox/radio-button inputs.
-
-
-
Tickboxes
-
Small checkboxes when there is a single item that can be checked, such as for confirmations.
-
The class gc-chckbxrdio and the class checkbox have to be enabled on the container element surrounding the targeted checkbox.
-
-
-
Disabled state
-
Disabled inputs will not be clickable. Visual indications include greying out the control and adding a "stop" cursor icon on hover.
-
To toggle a disabled state, add a disabled attribute to the input field
-
-
-
Inline format
-
Inline radio buttons or checkboxes will display side by side on larger screens and wrap to new lines, rather than vertically.
-
Add the form-inline class to surrounding container of the checkboxes or radio buttons. Also add the label-inline class to each checkbox or radio button container.
-
-
-
-
-
Research and blog posts
-
We successfully tested the use of interactive checklists during an optimization project with the Canada Revenue Agency and to create checklists for travel restrictions due to COVID-19.
The expand/collapse pattern (also known as accordion) allows content to be hidden until requested. The pattern consists of a trigger link that shows or hides the content.
-
-
Example:
-
- You must click on this area to expand and collapse the content
-
The expand/collapse pattern can be used in 2 situations:
-
-
1. Presenting a choice between mutually exclusive answers
-
Use this pattern when people need to get different answers depending on their situation and when these answers are mutually exclusive.
-
This reduces the risk of having people wrongly think they got the answer that applies to their situation.
-
2. Presenting secondary information
-
Use this pattern to prevent secondary content from interfering with the main task.
-
This can be content that applies to most people, but that only a few people may need to use (for example, a privacy statement or additional details not needed to accomplish the main task).
-
It can also be content that applies only to a minority of people (such as when there is specific information for a specific audience).
-
-
-
What to avoid
-
-
Don't use this pattern if:
-
-
the majority of people need the content to accomplish the main task (unless the answers are mutually exclusive)
-
people need to answer several questions to get the answer that applies to them (use interactive questions instead)
-
one of the mutually exclusive answers has multiple sub-tasks or more than one page of supporting content (use interactive questions instead)
-
-
-
-
-
-
How to implement
-
Presenting a choice between mutually exclusive answers
-
-
Determine if you are in a shared custody situation
-
Does the child spend their time:
-
-
-
- about equally between both parents
-
If the child shares their time about equally between the parents, then both parents are considered to have shared custody of that child...
-
-
-
-
- mostly with you
-
If the child lives with you most of the time, you are considered to have primary custody for the purposes of the Canada child benefit...
-
-
-
-
- mostly with the other parent
-
If the child lives with the other parent most of the time, the other parent is considered to have primary custody for the purposes of the Canada child benefit...
-
-
-
-
-
-
-Code
-
<h3>Determine if you are in a shared custody situation</h3>
-<p>Does the child spend their time:</p>
-<ul class="list-unstyled">
- <li>
- <details>
- <summary>about equally between both parents</summary>
- <p>If the child shares their time about equally between the parents, then both parents are considered to have <strong>shared custody</strong> of that child...</p>
- </details>
- </li>
- <li>
- <details>
- <summary>mostly with you</summary>
- <p>If the child lives with you most of the time, you are considered to have <strong>primary custody</strong> for the purposes of the Canada child benefit...</p>
- </details>
- </li>
- <li>
- <details>
- <summary>mostly with the other parent</summary>
- <p>If the child lives with the other parent most of the time, the other parent is considered to have <strong>primary custody</strong> for the purposes of the Canada child benefit...</p>
- </details>
- </li>
-</ul>
-
-
-
Presenting secondary information
-
-
Estimate your payments
-
Use the estimator to help you plan your budget.
-
For example, you can estimate what amount you would get if:
-
-
you have a new child
-
your income changes
-
you start or end shared custody
-
-
- See the math behind Canada child benefit payments
-
How are payments calculated
-
Every month, Canada child benefit payments are adjusted based on:
-
-
the number of children in your care
-
the age of your children
-
your marital status
-
your family net income from the previous year
-
-
...
-
-
-
-
- Code
-
<h3>Estimate your payments</h3>
-<p>Use the estimator to help you plan your budget.</p>
-<p>For example, you can estimate what amount you would get if:</p>
-<ul>
- <li>you have a new child</li>
- <li>your income changes</li>
- <li>if you start or end shared custody</li>
-</ul>
-<details>
- <summary>See the math behind Canada child benefit payments</summary>
- <h3>How are payments calculated</h3>
- <p>Every month, Canada child benefit payments are adjusted based on:</p>
- <ul>
- <li>the number of children in your care</li>
- <li>the age of your children</li>
- <li>your marital status</li>
- <li>your family net income from the previous year</li>
- </ul>
- <p>...</p>
-</details>
-
-
-
-
-
Research and blog posts
-
We successfully tested the use of the expand/collapse pattern to encourage people to choose between mutually exclusive options during 2 optimization projects with the Canada Revenue Agency.
There are 2 patterns for presenting contact information on Canada.ca pages. The contact information pattern is a standardized block that presents the street or mailing address, email address and telephone numbers, while the contact links pattern presents links to contact pages.
-
-
When to use this pattern
-
-
Present contact information consistently in a variety of contexts
-
Provide access to multiple contact options.
-
-
-
-
How to use this pattern
-
-
The heading is “Contact us”
-
Do not add borders to this block
-
-
the aim is to reduce visual noise and avoid “banner blindness” (where people automatically interpret content in boxes as ads)
-
-
-
For the contact address pattern:
-
-
when street or mailing address information is available, place it first, followed by other contact channels
Alerts are short, prominent notices meant to draw attention to an important message or change. They are often time-sensitive. The label, colour, and icon indicate the type of message and its urgency.
When to use: Use the danger alert to draw attention to a situation that could place someone in danger, such as a do not travel warning. You can also use it to alert a person of a technical issue that could cause them to be unable to complete their task, such as an invalid submission of data in a form.
-
-
-
If pregnant or considering pregnancy - Notice regarding both partners
-
Avoid travel to Costa Rica if you are pregnant or planning to conceive a child in the next 3 months.
-
-
-
- Code
-
<section class="alert alert-danger">
- <h3>If pregnant or considering pregnancy - Notice regarding both partners</h3>
- <p>Avoid travel to Costa Rica if you are pregnant or planning to conceive a child in the next 3 months.</p>
-</section>
-
-
-
-
2. Warning alert
-
When to use: Use the warning alert to draw attention to:
-
-
a possible consequence of an action or inaction, such as legal penalty that could apply
-
the date of an upcoming change to a policy or process that will affect a significant number of people, such as a change to travel requirements
-
-
-
-
Changes to impaired driving and cannabis-related crime laws
-
New penalties for impaired driving and cannabis-related crimes may affect your immigration status in Canada. If you commit one of these crimes, you may not be able to come to or stay in Canada.
<section class="alert alert-warning">
- <h3>Changes to impaired driving and cannabis-related crime laws</h3>
- <p>New penalties for impaired driving and cannabis-related crimes may affect your immigration status in Canada. If you commit one of these crimes, you may not be able to come to or stay in Canada.</p>
- <p><a href="https://www.canada.ca/en/immigration-refugees-citizenship/news/notices/impaired-driving-cannabis-penalties-affect-immigration-status.html">New penalties and how you could be afected</a></p>
-</section>
-
-
-
-
-
Starting April 1, 2022, pre-entry tests will no longer be required for fully vaccinated travellers entering Canada by land, air, or water. Until then, follow the pre-entry test requirements.
<section class="alert alert-warning">
-
-<p><strong>Starting April 1, 2022,</strong> pre-entry tests will no longer be required for fully vaccinated travellers entering Canada by land, air, or water. Until then, follow the pre-entry test requirements.</p>
-<p><a href="https://www.canada.ca/en/public-health/news/2022/03/government-of-canada-will-remove-pre-entry-test-requirement-for-fully-vaccinated-travellers-on-april-1.html">News release</a></p>
-</section>
-
-
-
-
3. Info alert
-
When to use: Use the info alert to draw attention to a clarification of surrounding content or helpful advice, such as the number of weeks it will take to receive a refund when an application is sent by mail vs by phone.
-
-
-
Current status of the call for applications: Closed
-
Thank you for your interest in Canada Summer Jobs. Applications are now closed.
-
-
-
- Code
-
<section class="alert alert-info">
- <h3>Current status of the call for applications: Closed</h3>
- <p>Thank you for your interest in Canada Summer Jobs. Applications are now closed.</p>
-</section>
-
-
-
-
4. Success alert
-
When to use: Use success alert to draw attention to a successful action, such as to confirm a submission or the completion of a task.
-
-
-
Your request for publicly available data from the list of charities has been successful
-
The turnaround time to process your request may take up to four (4) weeks. We will contact you if we need more information.
-
-
-
- Code
-
<section class="alert alert-success">
- <h3>Your request for publicly available data from the List of charities has been successful</h3>
- <p>The turnaround time to process your request may take up to four (4) weeks. We will contact you if we need more information.</p>
-</section>
-
-
-
Research and blog posts
-
This style of alert was used successfully during a project to improve content on travel advisories:
Added an additional warning alert example that includes a date.
-
- Added link to a blog post on alert fatigue.
-
- Adjusted definition and implementation advice.
-
-
-
-
-
-
Promoted the beta alert pattern to the stable alert pattern.
Links to institutions or organizations that support the content on the page.
-
-
-
How to use this pattern
-
-
Lists supporting institutions and provides links to their respective institutional profiles (or organization profiles or Partnering and collaborative arrangement profiles, as applicable)
The date modified component indicates how recently the content of a web page has been updated.
-
-
-
-
Objectives
-
Use the date modified component to provide a person with the date that the content was last updated.
-
-
-
When to use the Date modified pattern
-
The Date modified pattern is mandatory on all pages. In applications, it can be replaced by a version number. For
- more information, go to the Mandatory
- elements of the design system.
-
-
-
When to update the Date modified
-
This component:
-
-
should generally only be updated when significant content changes occur
-
should generally not be updated for corrections to typographical errors or changes to the underlying HTML code
-
-
can be updated manually to signify that the content has been fully reviewed and is still valid as of that date
-
-
-
For applications, the component can be replaced by a “Version number” if desired.
-
-
-
How to implement the Date modified
-
-
This component always starts with the words “Date modified:” followed by a date.
-
The date appears using the common numeric method, for example: 2016-10-04.
-
Placement: left-aligned, below the main content area. If used in conjunction with the Report a problem pattern,
- this
- component appears after the button to report a problem with the page.
The disclaimer overlay pattern ensures that terms of use, privacy statements and similar forms of disclaimer are available where required, but do not obstruct access to the main content of the page. It consists of a trigger link that activates a dismissible overlay where the disclaimer text appears.
-
-
When to use this pattern
-
-
Use where disclaimers (privacy statements, terms of use, etc.) are required, to avoid linking away from the current page
-
Never use for content that is essential to completing the primary task of the page
-
-
-
-
How to use this pattern
-
-
Label the trigger link with “Terms and conditions,” “Privacy statement,” or similar
-
When triggered, the overlay displays the disclaimer content in a secondary window (modal dialogue)
-
Disclaimer overlays must only include one action, which is to close them – this action is enabled by a clickable “X” in the upper right corner and a button labeled “Close” at the bottom of the overlay
-
Closing the overlay returns a person to the page containing the link that was used to activate it
-
Until the overlay is dismissed, the window under the disclaimer overlay is inert; people cannot interact with content outside of the overlay window (to avoid issues with assistive technology interpreting what is displayed)
Promotional feature banners are in-page components used to promote government-wide and institution-specific activities, initiatives, programs, and services.
-
-
When to use this pattern
-
-
Use this component to promote timely, current activities and initiatives
-
Only use this component on navigation or landing pages; do not use with destination content
-
Do not use this component when a person’s flow must not be interrupted, as in a transactional process
-
Do not duplicate content from other promotional components on the page
-
-
-
-
How to use this pattern
-
-
Promotional feature banners are full-width, narrow-height components that comprise text, imagery, and links
-
A maximum of 65 characters is allowed for all text (including link label)
-
Both text and imagery must be linked, but all links in the feature banner must point to the same destination; alternatively, the entire container must operate as a single linked area
-
Textual elements must be coded as HTML text—do not embed text into imagery
-
To ensure responsiveness at varying screen sizes, do not use a single static image for this component
-
Use the defined presentation classes included in the Canada.ca WET theme
Context-specific features are in-page components used to promote government activities, initiatives, programs and services.
-
-
When to use this pattern
-
-
Use this component to promote government activities, initiatives, programs and services that are relevant to the page on which they appear
-
Do not use this component to promote activities and initiatives that are not relevant to their context
-
Do not use this component when a person's flow must not be interrupted, as in a transactional process
-
Do not duplicate content or links from other components on the page
-
-
-
-
How to use this pattern
-
-
Context-specific features always comprise a link and an image, with optional header and description text
-
On navigation templates (such as theme or topic pages), use 2 or 3 features side-by-side, with each link placed above the image and the description placed underneath the image
-
On destination templates (such as generic pages), limit use to a single feature with the image placed to the left of the link and description
-
On navigation pages, always use a header. The default wording for this block is “Features.” Use more specific headings where possible to provide stronger context for a person
-
On destination pages, use of a header is optional. When using a header, always use a specific wording to provide context
-
Position context-specific features after the main content of the page, but before the footer section
-
Use a maximum of 40 characters for the hyperlink text
-
When applying images in contextual features, follow specifications in the images pattern
-
Keep the description text short and concise
-
-
1 or 2 lines is ideal
-
do not exceed 3 lines of text (which works out to approximately 145 characters with spaces)
-
-
-
The description link text and header must be different
-
-
do not repeat multi-word phrases in any of the header, link or description text
-
-
-
Use the defined presentation classes included in the Canada.ca WET theme
The global header is at the top of each Government of Canada web page.
-
The header consists of the following elements:
-
-
Background colour (white)
-
Government of Canada signature
-
Link to canada.ca landing page from Government of Canada signature
-
Language toggle
-
Site search box
-
Sign in button
-
Theme and topic menu
-
Key line
-
Breadcrumb trail
-
-
-
-
How to implement
-
Elements can be configured for the type of asset you’re creating.
-
-
-
Standard web page: Pages where people can navigate away without losing data, triggering errors or terminating their
- session.
-
Transactional page: Pages with an interaction task where people might lose data, trigger errors, or terminate their
- session if they navigate away from the page.
-
Campaigns: Landing pages for external marketing or advertising campaigns. The flexibility in layout allows institutions
- to match elements of their external campaign with the landing page.
-
Web application: Government of Canada Web applications that require authentication.
-
-
When to use
-
The global header should be on all pages from the Goverment of Canada. Some elements are optional in these situations:
-
-
Transactional scenarios: Pages where people are engaged in a transactional process such that mistakenly following other links would result in errors, loss of data or accidental termination of the session.
-
Campaigns: Landing pages for external marketing or advertising campaigns. The flexibility in layout allows institutions to match elements of their external campaign with the landing page.
Transactional web applications must be developed so that people can toggle between official languages on any given page or screen. Some legacy web applications may not have been designed this way. Such applications should be updated to allow this functionality. Until they are replaced or updated, the language toggle can be omitted if its use would result in a loss of data.
The in-page table of contents pattern is a list of links that lead to subsections of the same page. This pattern is intended for long documents that exist as a single page.
-
-
Objective
-
Use the in-page table of contents pattern to:
-
-
provide an outline for the content of a single page that has multiple subsections
-
provide an alternative method to jump to specific content on the page, without using the scroll bar
-
-
Use this pattern when:
-
-
excessive scrolling is required to view all of the content on the page
-
the page is divided into subsections, each with its own headings
-
-
Do not use this pattern when the document exists across several web pages. Instead, use the multi-page table of contents pattern.
-
-
-
How and when to use an in-page table of contents
-
-
Always position the in-page table of contents pattern at the start of the page, before the substantive content of the page begins
-
Label the pattern “On this page” to distinguish it from other page content and to provide consistency throughout the site
-
Present links using list elements—bullets for an unordered list, numbers for an ordered list
-
Use standard linking styles to ensure that the links present as clickable elements
-
Present the in-page table of contents aligned to the left, as a vertical list, as opposed to using a column layout
The institutional byline provides people with a link to the institution or institutions responsible for the content.
-
The institutional byline is not a mandatory pattern for pages on canada.ca
-
-
When to use this pattern
-
-
Use only on destination pages such as service initiation or generic pages; do not use on navigation pages like themes, topic pages, institutional/organizational profiles
-
Use only once on the page to provide a link to the institution, organization or similar entity responsible for the content
-
-
-
-
How to use this pattern
-
-
The link to the institution or organization is introduced by the word “From:”
-
Only links pointing to institutional profile pages, organizational profile pages, or partnering/collaborative arrangement profile pages are permitted
-
Only one institution or organization should appear in the institutional byline
-
The link label must be the same as the name that appears on the institutional or organizational profile page being linked to
-
Position the institutional byline directly underneath the page title, aligned to the left
-
Use standard paragraph and link styles
-
Do not place this block in line with other text blocks or layout elements; it stands alone
The interactive questions pattern is used to present people with a sequence of simple questions that leads to the specific answer they need to continue with or complete their task. The interactive questions pattern can be used to help people understand eligibility criteria, applicability of rules, or compliance requirements that depend on specific situations or conditions.
-
-
When to use this pattern
-
-
Use to guide people to an appropriate answer by asking them a series of questions
-
-
-
-
How to use this pattern
-
-
Use defined presentation classes for the field flow interface included in WET
-
-
-
Introducing interactive questions
-
-
The heading for this pattern must express the goal of the set of interactive questions
-
-
for example, “Find out if you can renew your passport online”
-
-
-
Optionally provide an overview of the results people can expect from completing the interactive questionnaire
-
Optionally provide brief instructions above the questions
-
-
-
-
Presenting questions
-
-
Keep the number of questions to a minimum (no more than 7 per sequence)
-
Each question must be written to a person reading it (use “you” and “your”)
-
Present choices or options immediately after each question, ensuring they are written as possible answers to the question above
-
When presenting choices, use standard form controls like radio buttons, checkboxes, and drop-down menus; ensure you cover off all possible choices
-
Where possible, pre-select the most common or optimal choice
-
-
-
-
Grouping questions
-
-
Present questions one at a time to keep focus on the current question; keep each subsequent question on the same page in the same place as the previous question
-
Always place questions in context (for example, on the eligibility page within the Service Initiation template)
-
-
-
-
Moving through the sequence of questions
-
-
Always use buttons for navigating though the sequence of questions (buttons labeled “continue” or “next” to trigger the next question or the answer)
-
Ensure people are able to go back to undo or change an earlier selection, via buttons or links (such as a link labeled “change your selection”)
-
Any buttons used for navigating through the questions must be labeled appropriately for the context (for example, “Continue” might make sense in one situation, but a clearer choice in another might be, “Find out if you’re eligible”)
-
When interactive questions are combined with the multi-page navigation pattern (such as in a service initiation template), avoid using “next” to avoid confusion between the 2 types of buttons
-
-
-
-
Presenting answers
-
-
Always summarize the choices people have made and ensure they can go back to undo or change an earlier selection
-
Explain the answer clearly and simply
-
Provide links to the next action that people should take based on the answer they are given
We tested the use of labels successfully during the transition period between the Canada Economic Response Benefit and the new benefits that replaced it. Adding labels to the different programs on the topic page made it easier for people to understand what was available to them.
For example, on a topic page or organizational profile it will list the top tasks related to that topic or organization, based on metrics and user-research
-
-
-
-
How to use this pattern
-
-
It lists top tasks specific to the page it is on based on page-view metrics and user research
-
Ideally, keep it to a maximum of 3 links, as people generally don't click on links beyond the first 3
-
A maximum of 7 links is allowed
-
Items can only link to destination content, or related topic links that do not already appear on the page
-
Link titles may not consist of program or publication names, unless these are meaningful to their target audience
The video and audio player components of the Web Experience Toolkit have been developed and tested to meet Canada.ca coding and accessibility standards. No other multimedia players are permitted on Canada.ca.
-
-
-
2: Transcript
-
Mandatory
-
All video and audio posted to Canada.ca must include a written transcript immediately following the WET player.
-
Shorter transcripts should be placed on the same page following the player, while longer transcripts can be hidden inside a details/summary element or placed on a separate page. When placing the transcript on a separate page, a link must appear in this spot which leads to the page containing the transcript.
-
-
-
3: Captions or descriptions
-
Optional
-
Captions, descriptions or attributions associated with multimedia content must be placed after the link to the transcript, left-aligned to the edge of the WET player.
is a set of links to a group of several pages intended to be read in a preferred order
-
includes previous/next links to guide a person through the page set in the preferred order
-
-
-
Objective
-
Use the ordered multi-page navigation pattern to provide:
-
-
an outline of content that spans multiple pages and has a default or preferred order (for example, guides, service initiations, sequential instructions)
-
a method of jumping to any page within the sequence, bypassing the default order of the pages
the content exists as a set of multiple pages that does not have a default or preferred order
-
the default order of the content must not be circumvented that is when the preferred order is crucial and people cannot be permitted to move between pages in a different order
-
-
-
-
-
How and when to use ordered multi-page navigation
-
-
Always position the ordered multi-page navigation pattern at the start of the page, before the substantive content of the page begins
-
Ensure that the order and position of the page links are identical on each page of the set
-
Number the step-by-step links to indicate the preferred order. Not all links necessarily need to be numbered, if they represent pages/steps that are not part of the sequence
-
Highlight the link for the current page. Do not highlight with the same colour used on primary action buttons
-
Position previous/next links immediately below the substantive content on the page
-
Accompany the previous/next labels with arrow icons to reinforce the concept
-
Position previous/next links consistently (for example, “previous” on the left, “next” on the right)
-
On the first page of the document, omit the “previous” link; on the last page of the document, omit the “next” link
The disclaimer expand/collapse pattern ensures that terms of use, privacy statements and similar forms of disclaimer are available where required, but do not obstruct access to the main content of the page.
-
-
- Privacy disclaimer
-
The personal information provided is governed in accordance with the Privacy Act. This personal information is being collected as part of the Government of Canada’s...
-
-
[Include the full privacy disclaimer in the expand/collapse, including headings, sub-headings, etc.]
Use where disclaimers (privacy statements, terms of use, etc.) are required
-
Use the pattern on the same page as the content subject to the disclaimer
-
Label the expand/collapse with “Terms and conditions,” “Privacy statement,” or something similar
-
-
-
-
-
What to avoid
-
-
Don't use privacy disclaimers to hide any important details about the page content itself - keep it specifically for legal information
-
Don't create a barrier by forcing users to go through a page with only a disclaimer or privacy statement before they can reach the task content
-
Don't link away from the current page
-
-
-
-
-
-
-
How to implement
-
-
- Privacy disclaimer
-
The personal information provided is governed in accordance with the Privacy Act. This personal information is being collected as part of the Government of Canada’s...
-
-
[Include the full privacy disclaimer in the expand/collapse, including headings, sub-headings, etc.]
While working on the ArriveCAN content, we noticed that a long privacy statement at the top of the page created a barrier for some screen reader users.
-
-
Latest changes
-
-
-
-
Changed the guidance on disclaimers to use an expand/collapse
The Report a problem pattern allows people to provide feedback via a form for any problems they experience with the
- web page they are on.
-
This pattern enables page-level feedback. When people click on the Report a problem button on this page, they are
- presented with common issues to select using checkboxes. If none of these issues are applicable, they may select
- “Other” to provide more details.
Ensure that the feedback you receive is actionable. If you can, avoid implementing a form where people cannot
- give details on the issues they are experiencing.
-
-
-
-
How to implement
-
-
-
Using CDTS to implement the Canada.ca theme
-
Do not implement this pattern through CDTS. To turn off the page footer in CDTS:
-
-
use the CDTS version for GCWeb applications, instead of the one for static HTML pages
-
remove the reference for the 'prefooter'
-
-
You should then set up the report a problem form in its place.
-
-
-
The button, label, placement and privacy statement are mandatory:
placement: positioned directly below the main content area, left-aligned
-
privacy statement: positioned within a dismissible overlay
-
-
The pattern for the contents of the feedback form is recommended. If meaningful data is not being received, a
- mailto link can be used as an alternative.
-
Sending the form: Make sure to replace the "#" placeholder in the form action line with whatever your
- institution uses to collect the data from the form. Consider sending the form to a generic email inbox if you
- don't have a server set up to handle this type of form.
-
-
-
-
-
-
- Report a problem on this page
-
-
-
-
-
-
-
Thank you for your help!
-
You will not receive a reply. For enquiries, please contact us.
-
-
-
-
-
-
-
-
-
-
-
- Code
-
<div class="row">
- <div class="col-sm-6 col-md-5 col-lg-4">
- <details class="brdr-0" open="">
- <summary class="btn btn-default text-center">Report a problem on this page</summary>
- <div class="well row">
- <div class="gc-rprt-prblm">
- <div class="gc-rprt-prblm-tggl" id="wb-auto-7">
- <form action="#">
- <fieldset>
- <legend><span class="field-name">Please select all that apply: </span></legend>
- <div class="checkbox">
- <label for="problem1"><input type="checkbox" data-reveal="#broken" name="problem" value="Something is broken" id="problem1">Something is broken</label>
- </div>
- <div class="form-group hide" id="broken">
- <label for="problem1-detail">Provide more details (optional):</label>
- <input type="text" class="form-control full-width" id="problem1-detail">
- </div>
- <div class="checkbox">
- <label for="problem2"><input type="checkbox" data-reveal="#spelling" name="problem" value="It has spelling or grammar mistakes" id="problem2">It has spelling or grammar mistakes</label>
- </div>
- <div class="form-group hide" id="spelling">
- <label for="problem2-detail">Provide more details (optional):</label>
- <input type="text" class="form-control full-width" id="problem2-detail">
- </div>
- <div class="checkbox">
- <label for="problem3"><input type="checkbox" data-reveal="#wrong" name="problem" value="The information is wrong" id="problem3">The information is wrong</label>
- </div>
- <div class="form-group hide" id="wrong">
- <label for="problem3-detail">Provide more details (optional):</label>
- <input type="text" class="form-control full-width" id="problem3-detail">
- </div>
- <div class="checkbox">
- <label for="problem4"><input type="checkbox" data-reveal="#outdated" name="problem" value="The information is outdated" id="problem4">The information is outdated</label>
- </div>
- <div class="form-group hide" id="outdated">
- <label for="problem4-detail">Provide more details (optional):</label>
- <input type="text" class="form-control full-width" id="problem4-detail">
- </div>
- <div class="checkbox">
- <label for="problem5"><input type="checkbox" data-reveal="#find" name="problem" value="I can’t find what I’m looking for" id="problem5">I can’t find what I’m looking for</label>
- </div>
- <div class="form-group hide" id="find">
- <label for="problem5-detail">Describe what you’re looking for (optional):</label>
- <input type="text" class="form-control full-width" id="problem5-detail">
- </div>
- <div class="checkbox">
- <label for="problem6"><input type="checkbox" data-reveal="#confusing" name="problem" value="Other" id="problem6">Other</label>
- </div>
- <div class="form-group hide" id="confusing">
- <label for="problem6-detail">Provide more details (optional):</label>
- <input type="text" class="form-control full-width" id="problem6-detail">
- </div>
- </fieldset>
- <button type="submit" class="btn btn-primary wb-toggle wb-init wb-toggle-inited" data-toggle="{"stateOff": "hide", "stateOn": "show", "selector": ".gc-rprt-prblm-tggl"}" aria-controls="wb-auto-7 wb-auto-8">Submit</button>
- </form>
- </div>
- <div class="gc-rprt-prblm-thnk gc-rprt-prblm-tggl hide" id="wb-auto-8">
- <h3>Thank you for your help!</h3>
- <p>You will not receive a reply. For enquiries, please <a href="https://www.canada.ca/en/contact.html">contact us</a>.</p>
- </div>
- </div>
- </div>
- </details>
- </div>
- </div>
Services and information is a pattern for presenting sets of links with accompanying descriptions (also known as doormat). Each link with its description provides an accurate and concise description of what a person will find on the destination page. Together, these sets of links and descriptions provide clear and distinct choices for people trying to complete their task.
-
-
When to use this pattern
-
-
Use this pattern to provide links to topics or destination content related to the page it is on
-
Use when the primary purpose of the page is to provide clear choices to navigate to tasks
-
-
-
-
How to use this pattern
-
-
Content requirements
-
-
Content for each link and description pairing is written for a grade 6-8 reading level
-
Keep punctuation simple
-
Use popular keywords that the target audience will likely know and use; base choices on research and evidence
-
Don’t use acronyms or abbreviations unless most people know these better than the long-form equivalent
Link text must make sense within the context of the page
-
-
It does not need to exactly match the destination page title
-
It does not need to be unique across Canada.ca
-
It must be descriptive, unique within the page, and clearly distinguishable from the other links on the page
-
Don’t end linked text with punctuation (for example, “How do you apply for funding?”)
-
The linked text must speak to a person (for example, “Apply for funding”)
-
-
-
The optimal character limit for links is 45 characters (with spaces) for both official languages, but can extend to 75 characters (with spaces)
-
Use only standard link styles as defined in the Web Experience Toolkit (WET)
-
-
-
-
Link descriptions
-
-
The link description complements the link it accompanies to provide greater detail and clarity about the scope of the link itself
-
-
Recommended style is to list keywords or keyword phrases separated by commas; full sentences are not required
-
Don’t use introductory phrases such as “Includes…”, “Information on…” or “Learn more about…”
-
Don’t include links
-
Don’t include promotional messaging
-
-
-
The character limit for link descriptions is 120 characters (with spaces) in both official languages
-
Drop-down menus are permitted in place of a link description in specific circumstances:
-
-
When used to provide access to a large number of items at the same level (for example, lists of countries or species)
-
When the destination page consists primarily of a list of links, and so can be completely replaced by the drop-down menu
-
-
-
Use only standard presentation styles as defined in WET
-
-
-
-
Grouping sets of links with accompanying descriptions
-
The following styles may be used:
-
-
Demand-based
-
-
Prioritization is based on demand (for example, based on web metrics), with higher demand links appearing ahead of lower demand ones
-
-
-
Sequential
-
-
Use sequential, numbered doormats when links must be followed in a step-by-step order (for example, confirming eligibility, registering and then charging for GST/HST)
-
Use to allow people to skip over optional/non-applicable steps or steps they have previously completed
-
-
-
Subheadings
-
-
Use to group links and descriptions that are very similar, in cases where it wouldn’t make sense to move the group into a sub-topic page
-
Use to avoid information overload; ideally no more than 9 links with descriptions per subheading
-
-
-
Combinations of the above, as appropriate; however, limit application to avoid overly complex sets of links and descriptions
-
-
In all cases, priority sequencing is as follows:
-
-
In a single column layout, the priority sequencing is top to bottom
-
In using across multiple columns, the priority sequencing is from left to right, then top to bottom
The component is presented as a button using WET style for
- secondary actions
-
The label reads: “Share this page”, preceded by the sharing icon in the defined icon set included in WET
-
Placement: positioned below the main content area, right-alignwed.
-
When clicked, a dismissible overlay is triggered:
-
-
the overlay is labeled “Share this page” and includes buttons for a selection of sharing platforms and
- delivery services, and the message “No endorsement of any products or services is expressed or implied.”
-
-
on large screens, the buttons appear in 2 columns
-
on small screens, a person is presented with a single column of buttons
-
-
-
Within the overlay, the button for each sharing platform or delivery service uses WET style for secondary actions
-
The label for each button within the overlay includes the name of the sharing platform or delivery service,
- preceded by a relevant logo or icon
-
When clicked, each button within the overlay triggers a link to that platform or service, including
- appropriate parameters, such as the URL or title of the page being shared
-
-
these links open in new browser tabs or windows where feasible
Date modified (mandatory, but can be a version number when used for an application)
-
-
Insert the content footer within the content area block so that its margins are aligned with the main page content.
-
Page feedback tool pilot
-
The Page feedback tool is a pilot product. Add the pattern to the content footer instead of the “Report a problem”
- pattern to actively collect user feedback.
The social media channels block (“follow box”) is an in-page component that allows people to follow official Government of Canada social media accounts from various social media platforms.
-
-
When to use this pattern
-
-
Use the follow box on pages where official GC social media accounts are relevant to the current context
-
Do not use this component when a person’s flow must not be interrupted, as in a transactional process
-
Do not duplicate content from other promotional components on the page
-
-
-
-
How to use this pattern
-
-
The social media channels follow box is made up of the heading “Follow” and icons linking to official GC social media accounts or RSS feeds that are relevant to the page
Display a maximum of 7 icons aligned in a horizontal row, using the standard icon set available in the Canada.ca WET theme
-
Use only one icon per social media platform; if there is more than one account from a single platform
-
-
make them available via a clickable drop-down menu
-
populate the drop-down menu with up to 8 text links, using the names of the accounts as labels
-
if more than 8 links are required, include a “view all” link as the final item in the list; this link must point to the relevant section of the Canada.ca social media gallery, where all relevant accounts will be listed
-
-
-
Position the follow box so that it does not interfere with the primary content of the page
-
Emphasize the box shape of this component by using a background colour that is darker than the surrounding page area’s background colour
-
Use the defined presentation classes included in the Canada.ca WET theme
The social media feeds widget is an in-page component that allows the latest posts from official Government of Canada social media accounts to be embedded on Canada.ca pages
-
-
When to use this pattern
-
-
Use the social media feeds widget on pages where official GC social media accounts are relevant to the current context
-
Do not use this component when a person’s flow must not be interrupted, as in a transactional process
-
Do not duplicate content from other promotional components on the page
-
-
-
-
How to use this pattern
-
-
The social media feeds widget consists of a heading with panels for up to 3 social media accounts, each featuring a feed of recent posts
-
The default heading for this widget is “Stay connected”
-
Each feed panel includes
-
-
a heading that indicates which social media platform the account’s feed is drawn from, for example Facebook or YouTube
-
a feed of the recent posts from that account, arranged in reverse chronological order
-
the 3 most recent posts as the default setting, with a link to the account from which the feed is drawn to allow people to see more
-
-
-
Use the defined presentation classes included in the Canada.ca WET theme
Use to group related task pages together and provide navigation between these pages.
-
Keep the number of pages tied together to a reasonable numner (maximum 6).
-
-
-
What to avoid
-
Don't use numbers when you use this pattern for sequenced steps. Testing has shown that Canadians are less likely to get to the section they need if the elements are numbered.
-
Sub-steps haven't been tested properly yet - avoid using them.
-
-
-
How to implement
-
This pattern is still in beta, and the code is still under review. Use it sparingly, as it may still be subject to changes.
-
You will need to use provisional CSS to use this design pattern.
When to use: use as the landing page for a set of related pages that use the subway naviation.
-
-
[Coded example of variant 1]
-
-
- Code
-
<p>[Coded example of variant 1]</p>
-
-
2. Step page
-
When to use: Use on each page tied by the subway navigation.
-
-
-
-
[Service/step name 3]
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam commodo elementum est, ac ultrices urna convallis vitae. Nulla nec convallis felis. Ut pretium nisl nisi. Nam gravida gravida aliquet. Morbi tincidunt lorem in purus imperdiet, id rutrum mauris sodales. Vivamus nec mattis tellus. Nunc turpis dolor, malesuada non magna nec, scelerisque tristique velit.
-
Sed consectetur eu ligula a molestie. Vivamus convallis libero malesuada pharetra suscipit. In a pulvinar mi, quis aliquet mauris. Duis convallis nunc nunc, in euismod nisi volutpat sit amet. Integer convallis lacus non orci imperdiet, ac convallis massa mollis.
-
-
-
-
-
-
- Code
-
- HTML
-
<nav class="provisional gc-subway">
- <h1>[Service name]</h1>
- <ul class="gc-subway-steps">
- <li><a href="#">[Step / section page name 1]<span class="wb-inv">: [Service name]</span></a></li>
- <li><a href="#">[Step / section page name 1]<span class="wb-inv">: [Service name]</span></a></li>
- <li><a href="#">[Step / section page name 2]<span class="wb-inv">: [Service name]</span></a></li>
- <li class="active"><a aria-current="page">[Step / section page name 3]<span class="wb-inv">: [Service name]</span></a></li>
- <li><a href="#">[Step / section page name 4]<span class="wb-inv">: [Service name]</span></a></li>
- <li><a href="#">[Step / section page name 5]<span class="wb-inv">: [Service name]</span></a></li>
- </ul>
- </nav>
- <h1 property="name" id="wb-cont" class="provisional gc-thickline">[Step / section page name 3]</h1>
- <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam commodo elementum est, ac ultrices urna convallis vitae. Nulla nec convallis felis. Ut pretium nisl nisi. Nam gravida gravida aliquet. Morbi tincidunt lorem in purus imperdiet, id rutrum mauris sodales. Vivamus nec mattis tellus. Nunc turpis dolor, malesuada non magna nec, scelerisque tristique velit.</p>
- <p>Sed consectetur eu ligula a molestie. Vivamus convallis libero malesuada pharetra suscipit. In a pulvinar mi, quis aliquet mauris. Duis convallis nunc nunc, in euismod nisi volutpat sit amet. Integer convallis lacus non orci imperdiet, ac convallis massa mollis.</p>
( function( $, window, wb ) {
- "use strict";
-
- var $document = wb.doc,
- componentName = "gc-subway",
- selector = ".provisional." + componentName,
- initEvent = "wb-init ." + componentName,
- views = {
- xxs: "xxsmallview",
- xs: "xsmallview",
- sm: "smallview",
- md: "mediumview",
- lg: "largeview",
- xl: "xlargeview"
- },
- mainClass = "gc-subway-section",
- toggleClass = "wb-inv",
- desktopInited = false,
- $html = wb.html,
- $h1, $h2, $h1Copy, $menu, $main,
-
- /**
- * @method init
- * @param {jQuery Event} event Event that triggered the function call
- */
- init = function( event ) {
-
- // Start initialization
- // returns DOM object = proceed with init
- // returns undefined = do not proceed with init (e.g., already initialized)
- var elm = wb.init( event, componentName, selector ),
- $elm;
-
- if ( elm ) {
- $elm = $( elm );
-
- // trigger resizing
- onResize( $elm );
-
- // Identify that initialization has completed
- wb.ready( $elm, componentName );
- }
- },
-
- /**
- * Mutate DOM depending on breakpoint
- * @method onResize
- * @param {jQuery DOM element | jQuery Event} $elm Element targeted by this plugin, which is the nav | Resizing event
- */
- onResize = function( $elm ) {
-
- if ( !$elm.length ) {
- $elm = $( selector );
- }
-
- // Desktop view, setup and mutate H1s
- if ( $html.hasClass( views.md ) || $html.hasClass( views.lg ) ||
- $html.hasClass( views.xl ) ) {
-
- // Initiate desktop mode only once
- if ( !desktopInited ) {
- initDesktop( $elm );
- }
- $h1.addClass( toggleClass );
- $h1Copy.prependTo( $main );
- $h2.prependTo( $menu );
- } else if ( ( $html.hasClass( views.sm ) || $html.hasClass( views.xs ) || $html.hasClass( views.xxs ) ) && desktopInited ) {
-
- // Mobile view, mutate back to mobile first if needed
- $h1.removeClass( toggleClass );
- $h1Copy.remove();
- $( "h2:first-child", $menu ).remove();
- }
- },
-
- /**
- * Initiate setup for desktop mode
- * @method initDesktop
- * @param {jQuery DOM element} $elm Element targeted by this plugin, which is the nav
- */
- initDesktop = function( $elm ) {
- $h1 = $( "h1", $elm );
- $h2 = $( "
Sections
" );
- $h1Copy = $( "
" + $h1.text() + "
" );
- $( "ul", $elm ).first().wrap( "" );
- $menu = $( ".gc-subway-menu-nav", $elm );
- $elm.nextUntil( ".pagedetails, .gc-subway-section-end" ).wrapAll( "" );
- $main = $elm.next();
-
- // Prevent on-load blinking on desktop
- $elm.addClass( "no-blink" );
-
- desktopInited = true;
- };
-
- // Listen for resizing and mutate the DOM accordingly
- $document.on( wb.resizeEvents, onResize );
-
- // Bind the init event of the plugin
- $document.on( "timerpoke.wb " + initEvent, selector + ".provisional", init );
-
- // Add the timer poke to initialize the plugin
- wb.add( selector );
-
- } )( jQuery, window, wb );
-
-
-
-
-
-
-
Research and blog posts
-
This pattern was developed with CRA during an optimization project on the Canada Child Benefit. It has shown to work well to show the relationship between related pages and to work well on mobile devices.
- Break up long and complex content into pages that each focus on a step or specific answer people need before moving to the next step or section. Ideal for presenting services and processes.
-
- Use to group related task pages together and provide navigation between these pages.
-
-
- Keep the number of pages tied together to a reasonable number (ideally 6 or less, maximum 8).
-
-
-
-
-
- What to avoid
-
-
- Don't use numbers when you use this pattern for sequenced steps. Testing has shown that Canadians are less likely to get to the section they need if the elements are numbered.
-
-
-
-
-
- How to implement
-
-
- This pattern is still in beta, and the code is still under review. Use it sparingly, as it may still be subject to change.
-
-
- You will need to use provisional CSS to use this design pattern.
-
( function( $, window, wb ) {
-"use strict";
-
-var $document = wb.doc,
- componentName = "gc-subway",
- selector = ".provisional." + componentName,
- initEvent = "wb-init ." + componentName,
- views = {
- xxs: "xxsmallview",
- xs: "xsmallview",
- sm: "smallview",
- md: "mediumview",
- lg: "largeview",
- xl: "xlargeview"
- },
- mainClass = "gc-subway-section",
- toggleClass = "wb-inv",
- desktopInited = false,
- skipLink = false,
- $html = wb.html,
- $h1, $h2, $h1Copy, $menu, $main,
-
- /**
- * @method init
- * @param {jQuery Event} event Event that triggered the function call
- */
- init = function( event ) {
-
- // Start initialization
- // returns DOM object = proceed with init
- // returns undefined = do not proceed with init (e.g., already initialized)
- var elm = wb.init( event, componentName, selector ),
- h1,
- $elm;
-
- if ( elm ) {
- $elm = $( elm );
- $h1 = $( "h1", $elm );
- h1 = $h1.get( 0 );
-
- // Ensure the element have an ID
- if ( !h1.id ) {
- h1.id = wb.getId();
- }
-
- // Add subway H1 to skip links
- if ( !skipLink ) {
- skipLink = wb.addSkipLink( wb.i18n( "skip-prefix" ) + " " + h1.textContent, { href: "#" + h1.id } );
- }
-
- // trigger resizing
- onResize( $elm );
-
- // Identify that initialization has completed
- wb.ready( $elm, componentName );
- }
- },
-
- /**
- * Mutate DOM depending on breakpoint
- * @method onResize
- * @param {jQuery DOM element | jQuery Event} $elm Element targetted by this plugin, which is the nav | Resizing event
- */
- onResize = function( $elm ) {
-
- if ( !$elm.length ) {
- $elm = $( selector );
- }
-
- // Ensure the page contains at least two heading level 1
- if ( $( "main h1" ).length < 2 ) {
- $document.off( wb.resizeEvents, onResize );
- $elm.addClass( "no-blink p-0" );
- return;
- }
-
- // Desktop view, setup and mutate H1s
- if ( $html.hasClass( views.md ) || $html.hasClass( views.lg ) ||
- $html.hasClass( views.xl ) ) {
-
- // Initiate desktop mode only once
- if ( !desktopInited ) {
- initDesktop( $elm );
- }
- $h1.addClass( toggleClass );
- $h1Copy.prependTo( $main );
- $h2.prependTo( $menu );
- } else if ( ( $html.hasClass( views.sm ) || $html.hasClass( views.xs ) || $html.hasClass( views.xxs ) ) && desktopInited ) {
-
- // Mobile view, mutate back to mobile first if needed
- $h1.removeClass( toggleClass );
- $h1Copy.remove();
- $( "h2:first-child", $menu ).remove();
- }
- },
-
- /**
- * Initate setup for desktop mode
- * @method initDesktop
- * @param {jQuery DOM element} $elm Element targetted by this plugin, which is the nav
- */
- initDesktop = function( $elm ) {
- $h2 = $( "<h2 class='h3 hidden-xs visible-md visible-lg mrgn-tp-0'>Sections</h2>" );
- $h1Copy = $( "<div class='gc-subway-h1' aria-hidden='true'>" + $h1.text() + "</div>" );
- $( "ul", $elm ).first().wrap( "<div class='gc-subway-menu-nav'></div>" );
- $menu = $( ".gc-subway-menu-nav", $elm );
- $elm.nextUntil( ".pagedetails, .gc-subway-section-end" ).wrapAll( "<section class='provisional " + mainClass + "'>" );
- $main = $elm.next();
-
- // Prevent on-load blinking on desktop
- $elm.addClass( "no-blink" );
-
- desktopInited = true;
- };
-
-// Listen for resizing and mutate the DOM accordingly
-$document.on( wb.resizeEvents, onResize );
-
-// Bind the init event of the plugin
-$document.on( "timerpoke.wb " + initEvent, selector + ".provisional", init );
-
-// Add the timer poke to initialize the plugin
-wb.add( selector );
-
-} )( jQuery, window, wb );
-
-
-
-
-
-
- Research and blog posts
-
-
-
- This pattern was developed with CRA during an optimization project on the Canada Child Benefit. It works well on mobile devices and is an effective way to show the relationship between related pages.
-
-
-
- Latest changes
-
-
-
-
-
-
-
-
- Updated the Subway pattern to remove 'avoid sub-steps'. This reflects that there may be instances where more complex processes would benefit from the use of sub-steps.
-
-
-
-
-
- Clarified that index page is required
-
-
-
-
-
- Changed 'sections' to 'pages' in introduction
-
-
-
-
-
- Launched the subway navigation pattern in Beta
-
The tabbed interface pattern separates related content into different panes that are viewable one at a time when the respective tab is clicked.
-
-
Objective
-
Use the tabbed interface pattern to group and present different aspects of content that are closely related, such as:
-
-
Geographic places, where the tabs can be used to present content relating to a place’s location, demographics, economy, etc.
-
Product catalogues, where the tabs can be used to present consistent facets of each product in the catalogue, such as specifications, features, etc.
-
-
Do not use the tabbed interface pattern when:
-
-
content must be presented in a specific sequential order (instead, use a step-by-step pattern)
-
content needs to be compared and contrasted, which would lead to repeated switching between tabs (instead, use tables or other patterns that allow all content to be presented at once)
-
content is lengthy or detailed, because of space limitations in the tabbed interface
-
content presentation includes only 2 tabs (for greater efficiency, use subheadings)
-
-
-
-
How and when to use a tabbed interface
-
-
Use defined presentation classes for the tabbed interface included in WET
-
Ensure that tab headers are clear and concise; avoid lengthy labels
-
When repeating the tabbed interface across a set of related pages (for example, on country pages), always ensure the tab headers are presented consistently
-
Make the default active tab first on page load; but another tab may be used as the active tab on page load if required
We tested the use of responsive tables successfully during optimization projects with Health Canada for recalls and safety, with CRA for organizing contact information, and across various COVID-19 content. Responsive tables are easier for users on small screens to use without having to scroll sideways to see all the content.
What we are doing is a pattern that presents links to content that provides background or explanations of GC activities in support of creating or improving public policy.
-
-
When to use this pattern
-
-
Use this pattern to provide relevant links to content that falls within the program and policy development user-need category
-
Use when the primary purpose of the page is to provide navigation choices
-
-
-
-
How to use this pattern
-
-
Content requirements
-
-
Label the heading “What we are doing”
-
Organize links by content type; label subheadings only using content type names (see Content types for Canada.ca)
-
Provide links to only the following content types:
-
-
from the Research, statistics and data category:
-
-
assessments
-
datasets
-
research
-
statistics
-
surveys
-
-
-
from the Consultations and engagement category:
-
-
consultations
-
-
-
from the News, promotions and public awareness category:
-
-
backgrounders
-
news releases
-
speeches
-
statements
-
-
-
from the Corporate information category:
-
-
program results
-
-
-
from the Government-wide reporting category:
-
-
audits
-
-
-
-
-
With the permitted types above, only include links to content that provides a view into the work that the government is doing to evaluate, improve or change programs, policies and services; for example, only a news release that announces a new funding program (whereas a news release that announces funding being awarded under and existing program would not be included here)
-
Only include links that are relevant to the page on which this pattern appears
-
Never provide links to content types that fall under the following content type categories:
-
-
services, like forms or service initiation (instead, place links to this content under services and information or most requested)
-
contact us, such as emergency contact or find an office (instead, place links to this content under the appropriate contact page or pattern, or most requested, if a high-demand task)
-
policy and guidance (instead, place links to this content under services and information, most requested or corporate information)
-
treaties, laws and regulations (instead, place links to this content on the transparency page under corporate information, services and information or most requested, if a high-demand task)
-
navigation and administration like navigation pages, website terms and conditions
-
-
-
-
-
-
Presentation requirements
-
-
When there are more than 3 subheadings, continue on a second row
-
A minimum of 2 links per subheading is required
-
A maximum of 4 links per subheading is allowed
-
When the number of links exceeds 4, provide a link to “All related [content type name]”
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam commodo elementum est, ac ultrices urna convallis vitae. Nulla nec convallis felis. Ut pretium nisl nisi. Nam gravida gravida aliquet. Morbi tincidunt lorem in purus imperdiet, id rutrum mauris sodales. Vivamus nec mattis tellus. Nunc turpis dolor, malesuada non magna nec, scelerisque tristique velit.
-
-
-
- Sed consectetur eu ligula a molestie. Vivamus convallis libero malesuada pharetra suscipit. In a pulvinar mi, quis aliquet mauris. Duis convallis nunc nunc, in euismod nisi volutpat sit amet. Integer convallis lacus non orci imperdiet, ac convallis massa mollis. Aliquam erat volutpat. Ut maximus euismod auctor. Ut ac gravida nunc. Nam non efficitur neque. Pellentesque tincidunt, libero luctus condimentum laoreet, turpis magna maximus nibh, at cursus lectus tellus in augue. Aenean scelerisque eros dui, at tincidunt eros tristique nec.
-
The GC design system needs to be constantly improving. The goal of this framework is to foster continuous improvement of the guidance through experimentation. It creates a space for departments to experiment and innovate, and contribute their findings for the benefit of the whole GC web community.
If the pattern or template you identified for improvement is not in the backlog, you can submit a proposal by opening an issue in GitHub.
-
The proposal must include at least:
-
-
a description of the issue or gap identified
-
a hypothesis on how to fix it
-
-
Suggestions will be reviewed on a case-by-case basis by the community.
-
Design: from prototype to stable
-
Once an idea has been identified, anybody can work on tackling the issue.
-
Initial design and prototype
-
As soon as some form of prototype exists, it can be moved from the "to do" column to the the backlog to the "Design and prototyping" column in the backlog project board.
-
Update the corresponding issue in GitHub to share the prototype with the community.
-
Alpha
-
To go from early prototype to Alpha, the prototype needs to be accompanied with documentation that includes at the minimum:
-
-
a hypothesis of how to solve the issue
-
a mock-up or a coded prototype
-
-
-
The Alpha phase is used to test the hypothesis, conduct research, deal with accessibility considerations, and code a working example for testing.
-
Beta
-
To go from Alpha to Beta, you need the following:
-
-
a fully working coded example
-
any CSS/JS overrides needed to implement in the latest WET theme for Canada.ca
-
assessment of accessibility
-
rationale for design choices - this can be results from research or a strong rationale
-
some guidance on "When to use" this component, pattern or template
-
documentation in both official languages
-
-
Use the Beta phase to scale up the experiment and fix any issues you encounter.
-
Beta updates are available through the main design system library, and departments can use them, as long as they consider it an experiment and are willing to report back on findings.
-
-
Stable
-
To go from Beta to Stable, the following must be done:
-
-
integrated to core framework (WET)
-
completely valid code
-
no accessibility issues left unresolved
-
comments from the community have been resolved
-
-
Iterate: back to the drawing board
-
Once a new or updated pattern has moved to stable, it becomes the new baseline guidance.
-
But it doesn't mean that it's now perfect. If this improvement hasn’t solved all the issues, or if new issues arise, the component, pattern or template can be added back to the backlog and be the subject of another design round.
Follow these principles when you contribute to the Canada.ca design system. These principles are heavily inspired by the GOV.UK design system community principles.
-
1. Start with what already exists
-
Start with the current library. There already may be something you can use, or something you can improve upon.
-
The existing components, patterns and layouts are evidence-based, and they are a great starting point. Know what's there to identify gaps and possible improvements.
-
Look at the community backlog to see if your idea has already been identified.
-
Reach out to community to find what others already have done.
-
2. Share your learnings with the community
-
As you do research, share your findings with the whole community.
-
Try to contribute back design components and patterns that are scalable, reusable and can evolve over time.
-
If you find something that doesn't work (a gap, an error, a contradiction, a flawed design), speak up. Let the community know.
-
When working on a contribution, gather evidence, and share it.
-
3. Work in the open, and be open
-
To avoid duplication of effort, when you are working on something, let the community know.
-
Share your work as early as possible, so others can contribute too.
-
Be honest and humble: share what works, what doesn't, and the research you did to understand that.
-
Be kind and respectful, and be open to feedback and changes to your work.
-
Be inclusive from the get go, and value what others can bring.
-
-
-
How to contribute
-
Anyone can contribute to the Canada.ca design system.
-
A contribution could be:
-
-
suggesting an improvement to a component
-
working on a new pattern or page layout
-
clarifying guidance
-
correcting an error
-
anything that makes the design system better for the community
Canada.ca is the Government of Canada primary service delivery channel.
-
-
People visit Canada.ca to do things like:
-
-
learn about health risks
-
apply for passports
-
pay their taxes
-
receive benefits
-
find jobs
-
learn about product recalls
-
better understand current international trade negotiations
-
-
-
People come to Canada.ca to complete tasks that let them fulfill their goals or objectives. For example, the tasks might be to check eligibility requirements and apply for a benefit. The goal is to receive the benefit payment.
-
-
Improving services on Canada.ca means ensuring that people are able to complete their tasks as efficiently and easily as possible.
-
-
-
Top tasks
-
Use a people-centred and data-driven way to focus and prioritize improvement efforts on the web by focusing on top tasks.
-
-
Determining what the top tasks are for your organization is crucial to focusing on what matters.
-
-
The GC Task Success Survey offers you a people-centred and data-driven way to prioritize your improvement efforts:
Analyzing direct feedback from people using your information through exit surveys, page feedback, and previous usability testing can help you narrow in on specific problems.
Are you getting more calls, or more complaints from your users about specific services? Is your front-line staff describing areas of struggle? Is there a sudden flurry of posts related to your services on social media? These are clear indicators of areas you may need to focus on.
There are different methods and scorecards you can use to help prioritize problems that users are experiencing. These resources can help you learn more about prioritization methods:
People need to know they'll find information they can trust.
-
-
A consistent brand
-
-
Using a consistent look throughout the Government of Canada web presence is crucial to building a trustworthy experience for people. People need to know they'll find information they can trust.
-
-
-
-
Use the mandatory elements of the Canada.ca design system to implement this trusted brand.
-
-
The mandatory elements you need to follow are:
-
-
-
Canada.ca domain
-
mandatory styles (typography, colours and layouts)
-
standard header and footer
-
a handful of high-level mandatory templates to establish a consistent institutional presence and the Canada.ca topic tree
-
-
-
Once you've applied this uniform brand, you can still use creativity within the body of the page to come up with the best design to help people complete their tasks.
The best way to foster trust is to provide people the answers they are looking for.
-
When someone can confidently take action based on the information you provided, you know you’ve built a trustworthy product.
-
Make sure you understand what people are trying to get from your content. Use evidence from research and data to make it easy for people to find, use and understand these answers.
-
-
-
-
Make content findable
-
People can’t succeed at a task if they can’t find where to initiate it.
-
To improve findability, you can work on:
-
-
navigation
-
internal and external search
-
-
-
Navigation
-
-
Some people will navigate to their task on the Canada.ca site. To support this, making a clear path for people's tasks is crucial. That means planning your navigation structure and taking time to understand what labels will work best for your audience.
Some people will search on Canada.ca or external search engines.
-
Using the right keywords, organizing your content properly and adding good metadata can help improve search results. Adding structured data can also be a useful technique.
Once people find the page they need, they have to be able to understand what they read. The way we write and the words we use make an enormous difference.
-
-
Use the words people actually use, not your internal jargon.
-
Stick to the essentials, and provide just enough information for people.
-
Write simple sentences and short paragraphs. Make good use of headings to help people scan the page and focus on the parts they’re looking for.
Use patterns and layouts that make it easy for people to use the content to complete their tasks. This could be simple text, a filterable table, a button, an interactive checklist or other patterns.
-
-
If you can't find an existing pattern or template in the library that does everything you need, you can get creative as long as you respect the mandatory elements of the design system. If your solution works well, we may add it to the Canada.ca design system for others to use when they have similar needs.
-
-
Do usability testing to make sure your design really does help people complete their tasks.
Monitor and measure content after it goes live. Continuous improvements throughout the content’s life cycle avoids high-effort optimization projects down the road.
-
-
Establish performance indicators
-
-
For continuous improvement to work well, you need to establish performance indicators and identify data sources that help you evaluate how your content or service is performing.
-
-
We can use data to make sure that:
-
-
-
people can complete their task
-
content is easy to find and understand
-
information is up to date and accurate
-
-
-
-
GC Task Success Survey
-
-
As part of reporting requirements for the Government of Canada, Treasury Board of Canada Secretariat has adopted the task success survey method as a primary means of measuring the performance of web content and services.
-
-
All departments and agencies subject to the Directive on the Management of Communications are required to implement the GC Task Success Survey on their web properties.
Use the data you’ve been monitoring (such as user feedback, analytics, and user research) to find ways to improve your content. Evaluate proposed improvements with usability testing.
-
-
Over time, programs and policies change and your content will need to change accordingly. With each change comes a new opportunity to research, prototype, and test out solutions before going live.
-
-
-
-
-
-
-
-
-
-
-
Thank you for your feedback
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Date modified:
-
-
-
-
- {% include footer-en.html %}
-
-
-
-
-
-
-
-
-
-
diff --git a/continuous-improvement/_research.html b/continuous-improvement/_research.html
deleted file mode 100644
index a372a63351..0000000000
--- a/continuous-improvement/_research.html
+++ /dev/null
@@ -1,636 +0,0 @@
----
----
-
-
-
-
-
- Research and prototyping - Continuous improvement of the Government of Canada web content - Canada.ca
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
There is no single method for continuous optimization, but most approaches will follow a similar process. You identify a problem, research the issue, gather a baseline, prototype and test (as many times as needed), go live, and finally measure the impact of your work.
-
-
The method described here is how the Digital Transformation Office approaches content optimization projects.
-
-
-
-
- DTO optimization process
-
Step 1: Initiation. Project start-up, define the problem.
Step 3: Baseline study. Test the current service with users.
-
Step 4: Design and prototype. Develop prototype, test and iterate.
-
Step 5: Comparison study. Test prototype with users, iterate to improve.
-
Step 6: Transition. Prototype hand-off and transition to live.
-
-
-
Initiation
-
-
You need to identify all of the stakeholders - particularly those who will have an impact on whether what you’re doing goes live. If the right people aren’t involved early on, you may experience significant delays. In the worst case scenario, your work may never see the light of day.
-
-
Agree on what you’re trying to accomplish and make sure to have a good understanding of the barriers that may prevent implementation.
-
-
-
At the DTO we use a project tracking sheet where we can link to all of the important study artifacts:
The purpose of the discovery phase is to conduct user research that will:
-
-
-
tell you about the people using your content
-
identify the tasks they are trying to complete
-
pinpoint the challenges people are facing
-
help you form hypotheses for a usability testing plan
-
help define or refine the specific goals for your project
-
-
-
Avoid making assumptions or thinking about solutions before discovery research is complete. It’s important to understand the problems that people are having first. You will tackle potential solutions through prototypes in the next phase.
-
-
Common research methods in the discovery phase
-
-
-
Asking your own questions and knowing how to find the answers is a critical part of being a designer
-
Source: Erika Hall, Just Enough Research
-
-
-
-
To create research questions, you need to understand gaps and weaknesses with the current situation. Use all or some of these methods to analyze your current situation.
Usability studies: first click tests, card sorting, tree jacks
-
Surveys or other behavioral insights reports
-
Social listening: web forums, social media
-
-
-
Quantitative research
-
-
-
Content inventories and maps
-
Call centre reports
-
Web analytics
-
GC Task Success Survey results
-
-
-
Learn about people using your content
-
By understanding the people who use your content, you will know more about who they are and their behaviours. This will help you narrow down who you need to recruit for usability testing.
-
-
Record your findings and the challenges people are facing
-
Some ways to summarize these findings include:
-
-
-
kanban board
-
spreadsheets with analytics
-
concept maps
-
interview transcripts
-
journey maps
-
-
-
Identify the specific tasks people are doing
-
-
Decide which specific tasks you will address as part of the optimization work.
-
-
You will build the solutions you prototype around these tasks.
-
-
Some examples of specific tasks from the Canada Child Benefit program:
-
-
How much will the payment be?
-
When will the payment be sent / deposited?
-
Check if you are eligible to receive the Canada Child Benefit
-
How to update your address
-
-
-
Sharing the discovery research
-
-
Summarizing and sharing what you’ve learned is an important milestone. This is a living document that you add to as you learn more through your research. You’ll refer back to these artifacts often.
-
-
Baseline measurement phase
-
-
A baseline measurement gives you a direct comparison of how a task performed before you optimize it.
-
-
If having a direct comparison is important to demonstrate the impact and value of your solutions, this is an important step to include. Make sure to use the same measurement method before and after optimization if you want comparable results.
-
-
-
If your project is completely new you may not have anything to baseline test.
-
-
Additionally, if your proposed solution is small or you have another metric (like call centre data or GC Task Success Survey data) that you will use to evaluate effectiveness, you could skip running a baseline study.
-
-
Why run a baseline usability study
-
-
Watching real people use your content is one of the most effective ways to gather evidence about the problems you’re looking to solve.
-
Perform moderated or unmoderated baseline studies with people trying scenarios on existing web content.
-
-
When to use moderated and unmoderated testing
-
-
-
-
Moderated is best for:
-
Unmoderated is best for:
-
-
-
-
-
a complicated process or concept
-
when you want to ask follow-up questions if a participant is stuck or confused
-
working with a specialized group of participants
-
-
-
quick results
-
studying a few very specific tasks
-
if you only need to select participants using basic demographics (age or income)
-
-
-
-
-
-
-
-
-
-
At the DTO, we include 16-18 participants in moderated baseline studies when we want to generate percentage task success scores that have reproducible results.
-
You can run smaller studies with fewer participants to gain insights about specific parts of your site. In our work at the DTO, we often run qualitative usability tests with 6-8 participants, but you can run studies with as few as 3-5 participants and still get useful results.
-
In small studies, do not report success or failure as percentages since the results are not reproducible.
-
-
-
-
Correct
-
2 / 8 participants were able to complete the task successfully
-
-
-
-
-
Incorrect
-
25% of participants were able to complete the task successfully
-
-
-
-
-
-
Recruiting participants
-
Recruit people for your usability tests that are representative of the audience for your content or service. You can work with a company to help recruit participants or use screening criteria in unmoderated tools to help find the right people to reduce variability in your results.
-
Plan to over-recruit - expect that there will be no-shows or that some unmoderated tests may not work out as expected.
-
-
Whoever is recruiting participants and conducting research is responsible for protecting the privacy of participants and ensuring they have informed consent before starting the study.
-
-
-
- Collecting personal information
-
-
Before collecting participants’ personal information, check in with your privacy group.
-
The Privacy Act governs how the federal government handles personal information.
-
-
Section 3: Definitions
-
Section 4: Authority to Collect
-
Section 8 (2): Appropriate Disclosure of Information
Chapter 3 provides guidelines for collecting informed consent.
-
-
-
-
The Directive on Privacy Practices provides direction on how to implement effective privacy practices including collecting and notifying participants how their information will be used.
-
-
Section 6: Requirements
-
Section 6.2.9: Privacy Notice
-
-
-
When using unmoderated usability testing tools, we include a screening question that tells participants how we may use the recordings. At this point, they are given the choice to opt out.
-
-
Example privacy screener text
-
“We sometimes use recordings in public blog posts, with any personally identifying information hidden and voices altered. Please only accept this test if you consent to us using your recording in this way.”
-
-
-
-
Write task scenarios
-
Research questions
-
Using your discovery research, you now have a prioritized list of challenges that you're facing and potential tasks to test.
-
Develop research questions based on these tasks. (What do you want to find out? To prove?) Research questions help narrow the scope of your study to the behaviours you want evidence on - make sure everyone agrees on them!
-
-
-
-
With your list of research questions in hand, draft tasks that will help you gather evidence and provide insights about ideas to prototype.
-
-
Tasks
-
These must be real things people are trying to accomplish.
-
-
Hypothesize about what you think may happen during the test.
-
-
We find that we can test 8-10 small tasks in an hour-long moderated session or 5-6 tasks in an unmoderated 30-minute session.
-
-
Scenarios
-
Scenarios are realistic narratives for a task that the team creates together.
-
-
Using the job story formula, identify a situation a user may find themselves in and the strategies they use to arrive at a desired outcome.
-
-
A job story follows this format:
-
“When I (situation), I want to (motivation), so I can (expected outcome)”
-
-
This is a valuable approach to reinforce your understanding of how and why a service is used.
-
-
-
Example task Change direct deposit bank account details.
-
-
Job story When I move my mortgage to a new bank, I want the CRA to put my tax refund into the new account, so I can pay my mortgage on time.
-
-
Scenario You renewed your mortgage, and you moved all your bank accounts to a new bank. What number would you call to get your personal tax refund into your new bank account? (answer: 1-800-959-8281)
-
-
-
Fine-tune these tasks so they tell you as much as possible, are accurate, and feasible for your participants to complete. Make sure each task has a clear answer. Answers may be yes/no, or else something specific such as a number or percentage, a date, a telephone number, etc.
-
-
Before you run your first official test, make sure you pilot your task scenarios. For example, you can ask a friend or colleague to try doing the task to get a sense of whether participants will understand what you’re asking them to do.
You can use an outside firm to run a moderated study for you or set it up yourself. If setting up a moderated study yourself, you will need to select a screen and audio sharing tool. Pay attention to any special installation requirements. If possible, let participants know in advance which tool you will be using so they can prepare their computer or device ahead of time.
-
-
You can choose from a range of third party services that provide moderated and unmoderated study tools. An unmoderated study can be run outside of work hours and is generally less expensive to run.
-
-
In both scenarios, you want to have video recordings at the end of each session that you can use to complete a detailed analysis.
-
-
-
Additional resources on moderated and unmoderated testing:
Involve everyone on the team in the analysis process, at least as an observer.
-
-
Reviewing transcripts and summary reports is helpful but there is no replacement for first-hand observations with real users. Ensure the whole team can participate by watching videos or live sessions.
-
-
Take notes of key behaviours during the sessions
-
-
-
clicks - note all links clicked, and every click on anything, whether it’s clickable or not
-
direct quotations of feedback about an issue
-
scrolling the page
-
reading headings aloud
-
skimming text - missing links in skimmed text
-
observations about issues encountered
-
the point where they arrived on the page with the answer
-
if they found the correct answer
-
-
-
-
Share any shorthand you use in your notes
-
-
-
use identifiers for clicks on navigation like breadcrumb BC, back button B, menu link M
-
note search, filter and find attempts with keywords used S keyword, F keyword
-
-
-
When analyzing the data you’ve collected, read through the notes carefully looking for patterns and be sure to add a description of each of the problems. Look for trends and keep a count of problems that occurred across participants.
-
-
Share your findings
-
Summarize the test results in a usability test report with your findings and recommendations. An effective report will include visuals such as screen shots and short video clips to illustrate specific problems.
-
-
-
We recommend presenting the findings in person. This is an effective way to make sure that stakeholders and approvers understand the issues that you are trying to fix. These sessions are a great way to build empathy for users with members of the team that did not observe or participate in analysis of the usability tests.
-
-
An emailed report is an ignored report!
-
-
-
Outcome of the baseline testing phase
-
-
You have a baseline score for each task scenario
-
You have videos of people attempting tasks
-
Project team members and stakeholders have watched all videos for at least 1 task
-
You know exactly how many people did what in each case
-
You have a list of issues that need to be addressed
-
All project stakeholders understand the issues and want to get them fixed
-
-
-
-
-
-
Prototype ideas to improve success
-
-
-
There are different approaches to prototyping, from basic wireframing to fully working HTML pages.
-
Basic designs help in the early stages of ideating for teams to discuss and visualize. Fully working HTML prototypes can make testing easier since they behave exactly, or almost exactly, like the real live content would.
-
Make sure prototypes aren’t behind firewalls or in staging/development servers that are not publicly accessible if you’re testing with members of the public.
-
-
Our preferred way of prototyping at the DTO is HTML, using GitHub pages, but there are other options for creating high-fidelity interactive prototypes including:
-
-
-
Figma
-
InVision
-
Axure
-
Adobe XD
-
-
-
-
-
Prototypes are a great change management tool. Doing demonstrations using prototypes can bring together diverse perspectives (for instance from communications and policy, or across branch or departmental lines).
-
A prototype that can be easily updated during workshops can be very effective. A live editing session can turn ideas from participants into something concrete in real time. It also demystifies content design and coding, which helps create buy-in for an iterative approach.
-
Prototyping is a risk-reduction strategy. It lets stakeholders see the proposed approach and comment on it or correct it before it goes live.
Once your prototypes are ready, you need to test them to see whether your ideas and solutions work with users. When possible, use the same test questions and testing approach as you did for the baseline study so that you can make direct comparisons and verify whether you met objectives.
-
-
As testing progresses, you may find it necessary to continue fine-tuning or adjusting your prototypes, if participants continue to struggle. The participants will help you understand what helped, and why.
-
-
No matter how smart or experienced you are, you will be surprised by what you see people do.
-
-
Follow up testing with analysis and reporting. The testing report or presentation should communicate improvements or areas that require further work. Include a plan to complete those additional changes.
-
-
This report will be a critical tool for building the case for change among decision makers during the following implementation phase.
Web content improvement projects usually require the participation of many people. Different roles are needed to ensure coordination, research, design and delivery.
-
-
There are different ways you can organize your team, and some people may have more than one role, but the following roles should be covered.
understands and plans mitigation of the barriers that prevent implementation
-
facilitates workshops and meetings to keep everyone working in the same direction
-
-
-
The project coordinator keeps the team organized, maintains spreadsheets, documentation and schedules meetings.
-
-
User research and usability testing
-
-
Research-driven improvement projects require impartial usability research specialists who can recruit participants and run replicable tests with multiple participants.
-
-
Design researchers understand and uncover user behaviours and expectations through various research methods.
-
-
This group of people could be in-house or through a third party.
-
-
-
Design
-
Content designers focus on improvements to language and how content is structured or displayed to help people complete their tasks.
-
-
Interaction designers build prototypes and provide input on interactive approaches that may enhance the user’s experience.
-
-
-
-
Subject matter experts
-
-
Content improvement must be done with the involvement of subject matter experts, who understand the topic and what needs to be conveyed to the audience. These participants may differ, depending on the program area:
-
-
-
program and policy experts, to ensure a thorough understanding of the context and purpose
-
-
-
front-line service agents who can be an invaluable sources of information about customer needs and frustrations
-
-
content developers / contributors
-
web support team and relevant Canada.ca theme lead
-
-
-
Senior management and decision makers
-
-
You need to involve senior management to approve decisions on content, design and interactions. You need someone to champion implementation once research and recommendations are done. Designing web materials for task success may conflict with organizational pressures. It's critical that senior management be engaged early and often, to understand the methods, and to participate in crafting appropriate project goals.
-
-
Some of the greatest risks to project success are:
-
-
-
a lack of organizational experience designing services from the client’s perspective
-
situations where multiple groups in the organization may be impacted by changes to service delivery
-
usability testing or analytics evidence contradicting approaches that support competing priorities (political, organizational, regulatory, etc.)
-
overly long and complex approval processes
-
-
-
Some of the best ways to overcome these risks include:
-
-
-
engaging senior management early and often
-
-
we recommend engaging senior management early in the process, as well as on a frequent basis during the project
-
-
-
keeping senior management up to date on human-centred service design, evidence gathering approaches and usability testing
-
sharing user stories - especially when audiences struggle with current designs
-
identifying likely obstacles in advance and tailoring discussions accordingly
Improving content for people often means significant change for organizations. To lead a successful improvement project, people working on it need to agree on the purpose, approach and objectives.
-
-
Everyone involved needs to be on board.
-
-
You need:
-
-
-
a high-level agreement on what you want to accomplish with the improvement project
-
buy-in on the people-centred and evidence-based approach for decision-making
-
a project team with the right skills, ready to work together
-
a project lead and well-defined roles and responsibilities
-
a clear understanding of the potential barriers to implementation and how to address them
Effective and intentional governance can help address the barriers that may get in the way of project success.
-
-
These barriers include:
-
-
-
challenging traditional decision-making and chains of command with new, research-based approaches to web content
-
ensuring the right people with the right knowledge are involved
-
understanding the relationships between design and technical implementation
-
-
-
-
-
Effective project governance removes ambiguity about who is accountable for which decisions.
-
-
Tips for good governance
-
-
-
Structure your team to support the project’s objectives by ensuring there is awareness, acceptance and capacity to produce an outcome that supports what people need from you
-
Make sure decision-makers can support approaches that have been tested and proven to work.
-
To meet objectives, you will need people in roles to be accountable for:
-
-
implementing the improved content
-
using evidence to drive decisions
-
engaging with stakeholders effectively
-
understanding and mitigating risk
-
ensuring there is a team-wide understanding of the subject
-
ensuring acceptance of the evidence-based approach among subject matter experts
-
-
-
-
-
Example project governance model
-
-
-
Example project governance model
-
-
-
Role
-
Core task
-
Accountable for
-
-
-
-
-
-
Senior manager
-
Approval and oversight
-
Implementation of improvements
-
-
-
-
Project lead
-
Implementation of improvements
-
Key deliverables and timeline
-
-
-
-
Project coordinator
-
Contacts, meeting invitations, notes and records of decision
-
Keeping team consulted and informed
-
-
-
Design researcher
-
User research and usability testing
-
Providing the evidence to drive design decisions
-
-
-
Content designer
-
Evidence-based content improvements
-
Making design decisions based on the evidence
-
-
-
-
Interaction designer
-
Evidence-based designs and prototyping
-
Making design decisions based on the evidence
-
-
-
-
-
Subject matter experts
-
Review content for accuracy
-
Accuracy of content after improvements
-
-
-
-
-
-
-
Plan for efficient approvals
-
-
Approval processes often take time. There are things you can do to make it better.
-
-
Involve approvers from the get go
-
-
Don’t wait until the end of the design process to seek input from people who will approve the content. Involve all stakeholders at the beginning of the process, and identify the approvers early on.
-
-
Make sure everyone who needs to know is aware of the objectives and timelines of the improvement project.
-
-
-
Design and prototype collaboratively
-
-
Don’t design and prototype all by yourself. Lead content design workshops that involve everyone that has a stake in the content: subject matter experts, policy people, communications, web advisors, etc.
-
-
-
Use demos to show the design to approvers
-
-
Instead of simply passing around a Word document asking for input, do regular presentations to people who will approve the content. Show the process, the research and the actual prototype, and demonstrate how this is an improvement.
-
-
The more carefully you prepare content before approvals, the less approvers will need to tweak it. Do the hard work to make it easy for them to give the ok to go live.
-
-
It’s up to the project team to:
-
-
-
review text in both languages carefully
-
verify code validity and accessibility
-
review (QA) coded content for broken links, missing text, etc.
-
prepare analytics tagging and performance reporting
Alerts are meant to draw attention to changes in regular content in 2 ways:
-
-
a change to the content of the page on which the alert appears: in this case, place the alert next to the updated content
-
a change that has been made elsewhere, such as new information being published: in this case, link to the new information from within the alert
-
-
-
-
What to include in alerts
-
Alert content should:
-
-
be short and simple
-
describe the impact on the user
-
be tailored to the page on which it appears
-
include the dates (if known) when the disruption will take place
-
use the appropriate verb tense to reflect when the change is taking place
-
-
use links sparingly - if a link is needed, only include one
-
-
-
Limit use of alerts
-
Be aware that alert fatigue reduces the effectiveness of the alert over time. The more people see alerts and warning messages the less receptive they are to them. To avoid this, follow these guidelines:
-
-
only use alerts on a temporary basis (for the time it takes to integrate the information or resolve the situation)
-
limit the number of alerts on each page
-
limit the number of alerts used across pages:
-
-
use at impacted points of service or information delivery, such as service initiation pages, contact pages, etc.
-
avoid beyond service or information delivery points - on theme and topic pages, consider using a new doormat instead
-
-
-
save alerts for significant situations that impact most users:
-
-
on the Canada.ca home page, only use when more than 50% of the population is affected
-
on institutional landing pages, only use when more than 40% of users are impacted
-
-
-
avoid using alerts just for styling regular content (for emphasis or highlighting)
-
-
-
-
Which alert to use
-
-
Danger alert (red)
-
Use only if the service is cancelled or if there's a risk to health or safety to Canadians in completing an activity.
-
Warning alert (yellow)
-
Use for delays, closures at certain locations, and other types of service disruptions.
-
Info alert (blue)
-
Use for the length of time an application method takes, changes in wait times on a phone line, messages that there is no service disruption for a particular service if that is generating inquiries.
-
Success alert (green)
-
Use when a service disruption is resolved.
-
-
-
Examples and code
-
-
-
Limited service availability
-
This service is affected by the outbreak of coronavirus (COVID-19).
<section class="alert alert-warning">
- <h3>Limited service availability</h3>
- <p>This service is affected by the outbreak of coronavirus (COVID-19).</p>
- <a href="#">Check service status updates</a></p>
-</section>
-
Change the "alert-warning" class to "alert-info", "alert-danger" or "alert-success" based on the type of alert needed.
- I grant Her majesty the Queen in right of Canada, as represented by the President of Treasury Board of Canada Secretariat (TBS), the right to take, modify, adapt, exhibit, publish, transmit, reproduce, create derivative work from, distribute and otherwise use my name, photograph, video and/or audio recording, likeness, artwork, profile and/or testimonial in any material developed by or on behalf of TBS, including but not limited to current and future publications, Web sites, videos and/or audio recordings for purposes that promotes and supports the mission of the TBS, whether for internal use or public dissemination.
-I forever release TBS from any liability from direct, indirect, special, incidental or consequential damages of any kind arising from the use of my name, photograph, video and/or audio recording, likeness, artwork, profile and/or testimonial.
-I have read and fully understood the terms and legal effects of this agreement.
-
-
-Notice:
-Our registration tool uses Surveygizmo, a third-party application. Sign-up is voluntary and subject to the Terms of Use for the Surveygizmo platform. When you sign up, your email address and language preference (English or French) is collected. No other personal information is collected.
-The collection and use of your personal information is authorized by the Financial Administration Act. Collection and use of your personal information for this site is in accordance with the federal Privacy Act. Your personal information may be used to respond to your inquiries, if applicable, and to help evaluate the effectiveness of Treasury Board of Canada Secretariat (TBS) programs in responding to client needs. In exceptional circumstances (e.g., individuals who make inappropriate remarks or threats), personal information may be disclosed without your consent pursuant to subsection 8(2) of the Privacy Act.
-Any personal information that may be collected is described in the Standard Personal Information Bank entitled Outreach Activities, PSU 938, which can be found in the TBS webpage Information about programs and information holdings.
-Any questions, comments, concerns or complaints you may have regarding this Statement, your privacy rights and the Privacy Act may be directed to the TBS Access to Information and Privacy Coordinator by email at ATIP.AIPRP@tbs-sct.gc.ca or by telephone at 1-866-312-1511. You may also wish to contact the Office of the Privacy Commissioner of Canada by email at info@priv.gc.ca or by telephone at 1-800-282-1376. You have the right to complain to the Office of the Privacy Commissioner of Canada about the handling of your personal information by TBS.
-
Structured data is a way to tag content in a “machine-readable” way.
-
It helps search engines make sense of the page by allowing you to add information that clarifies the meaning of the content.
It should help deliver:
-
-
-
better and more informative search results (often in Google and Bing)
-
better voice search results (for services like Alexa and Google Home)
-
-
-
Search engines control how search results appear and what gets featured in snippets. Adding structured data may or may not change search results.
-
-
Example of a rich snippet
-
-
-Example of a rich snippet: searching for "covid benefits"
-
When searching for "covid benefits" on Google, you may get a rich result that shows different sections that can be expanded to provide specific links. Expanding "For individuals" reveals 5 links:
-
-
Employment Insurance (EI) program
-
Canada Recovery Benefit (CRB)
-
Canada Recovery Sickness Benefit (CRSB)
-
Canada Recovery Caregiving Benefit (CRCB)
-
All support for individuals
-
-
-
-
-
-
-
Structured data needs to be a “true representation” of the page. You can’t add structured data about content that isn't covered in the page.
-
-
Adding structured data is just one of the techniques you can use to optimize your content for search. Improving the actual content of the page should always be the first step you take.
While structured data can be written in RDFa, we suggest using JSON-LD instead. JSON-LD is becoming the preferred structured data language of search engines. It also allows a bit more flexibility, like allowing you to inject HTML in the rich snippets of search results.
-
-
JSON-LD exists separate from the actual content. If you update the content, remember to adjust the JSON-LD code accordingly.
-
-
Because some elements may already be coded in RDFa in your templates, make sure there is no collision between the two.
-
-
Use a validator, such as JSONLint, to make sure your JSON-LD code is valid.
-
-
Adding JSON-LD in Adobe Experience Manager (AEM)
-
If your page is published in AEM, you can add structured data in JSON-LD by using the structured data component in the page properties.
You can copy code snippets or full URLs to test your code in the Rich results test.
-
-
It shows which rich result types (supported by Google) were found on the page, as well as any errors or suggestions for your structured data
-
-
By pasting the URL or the code of the page, you can see if it’s valid, and if the values assigned to different fields are the correct ones.
-
-
Step 4: Validate HTML code and check accessibility
-
Before you publish the page with structured data, make sure that the HTML is valid and the page is accessible. You can use online validators to help you with this:
Once your structured data is published, Google and Bing should reindex the page within a few days.
-
-
Check the status of your code in the Canada.ca Google Search Console.
-
-
How to measure the impact of structured data
-
You can measure the impact of structured data by looking at the Google Search console. You can get statistics on how the rich snippet is performing, such as:
-
-
-
the proportion of the clicks to a page generated from a rich snippet
-
the search queries that generate rich snippets
-
whether the click-through rate is different with a rich snippet
-
-
-
Adding tracking (UTM) codes to hyperlinks in the rich data can also help you understand when people are clicking the links in the rich snippet.
The SpecialAnnouncement schema is a new experimental schema developed for announcements related to COVID-19. It's mainly for health related information (symptoms, quarantine, testing, etc.), but also for closures, reopenings, and special government benefits.
Add id attribute to the JSON-LD HTML script element named “wb-script”.
-
Use the same JSON-LD root id anchor as the one for the main content of the page. Both will use “#wb-main” to specify semantically they are describing the same subject.
-
-
-
<script id="wb-script"
-type="application/ld+json">
- {
- "@context":"http://schema.org",
- "@type":"SpecialAnnouncement",
- "@id": "#wb-main",
- "mainEntityOfPage":{
- "@type":"WebPage",
- "@id":"https://www.canada.ca/en/public-health/services/diseases/coronavirus-disease-covid-19.html"
- },
- "name":"Coronavirus disease (COVID-19): information from the government of Canada",
- "text":"Coronavirus disease (COVID-19) information for Canadians including links to disease updates, travel advice, how to be prepared, symptoms, prevention, risk, Canada's response, current case numbers, answers to questions and links to printable resources.",
- "spatialCoverage": {
- "@type": "Country",
- "name": "Canada"
- },
- "publisher":{
- "@type":"GovernmentOrganization",
- "@id":"#wb-publisher",
- "name":"Government of Canada",
- "url":"https://www.canada.ca/en.html"
- },
- "category":"https://www.wikidata.org/wiki/Q81068910",
- "datePosted":"2020-05-09",
- "diseasePreventionInfo":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/prevention-risks.html",
- "diseaseSpreadStatistics":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection.html",
- "newsUpdatesAndGuidelines":"https://www.canada.ca/en/public-health/services/diseases/coronavirus-disease-covid-19.html",
- "quarantineGuidelines":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/prevention-risks.html",
- "travelBans":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/latest-travel-health-advice.html",
- "governmentBenefitsInfo": {
- "@type": "GovernmentService",
- "name": "Canada's COVID-19 Economic Response Plan",
- "url": "https://www.canada.ca/en/department-finance/economic-response-plan.html",
- "provider": {
- "@id": "#wb-publisher"
- },
- "serviceType": "Emergency relief",
- "audience": {
- "@type": "Audience",
- "name": "Canadians affected by COVID-19"
- }
- }
- }
-</script>
-<body vocab="http://schema.org/" typeof="WebPage">
- <div typeof="Organisation" resource="#wb-publisher">
- <img src="/link/to/a/logo" alt="Publisher name" property="logo" />
- <meta property="name" content="Publisher name" />
- </div>
- <main property="mainContentOfPage" typeof="WebPageElement" resource="#wb-main">
- </main>
-</body>
-
-
- AEM
-
Add the code in the Structured data component in the page properties.
-
-
{
- "@context":"http://schema.org",
- "@type":"SpecialAnnouncement",
- "@id": "#wb-main",
- "mainEntityOfPage":{
- "@type":"WebPage",
- "@id":"https://www.canada.ca/en/public-health/services/diseases/coronavirus-disease-covid-19.html"
- },
- "name":"Coronavirus disease (COVID-19): information from the government of Canada",
- "text":"Coronavirus disease (COVID-19) information for Canadians including links to disease updates, travel advice, how to be prepared, symptoms, prevention, risk, Canada's response, current case numbers, answers to questions and links to printable resources.",
- "spatialCoverage": {
- "@type": "Country",
- "name": "Canada"
- },
- "publisher":{
- "@type":"GovernmentOrganization",
- "@id":"#wb-publisher",
- "name":"Government of Canada",
- "url":"https://www.canada.ca/en.html"
- },
- "category":"https://www.wikidata.org/wiki/Q81068910",
- "datePosted":"2020-05-09",
- "diseasePreventionInfo":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/prevention-risks.html",
- "diseaseSpreadStatistics":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection.html",
- "newsUpdatesAndGuidelines":"https://www.canada.ca/en/public-health/services/diseases/coronavirus-disease-covid-19.html",
- "quarantineGuidelines":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/prevention-risks.html",
- "travelBans":"https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/latest-travel-health-advice.html",
- "governmentBenefitsInfo": {
- "@type": "GovernmentService",
- "name": "Canada's COVID-19 Economic Response Plan",
- "url": "https://www.canada.ca/en/department-finance/economic-response-plan.html",
- "provider": {
- "@id": "#wb-publisher"
- },
- "serviceType": "Emergency relief",
- "audience": {
- "@type": "Audience",
- "name": "Canadians affected by COVID-19"
- }
- }
- }
-
-
-
-
-
-
-
-
FAQPage
-
When to use
-
Use to add a set of headings and their respective content that provide answers for the key tasks associated with a page.
-
-
Use on:
-
-
service initiation pages
-
guidance documents
-
actual FAQs
-
-
FAQ pages are strongly discouraged on Canada.ca in most cases.
Add id attribute to the JSON-LD HTML script element named “wb-script”.
-
Use the same JSON-LD root id anchor as the one for the main content of the page. Both will use “#wb-main” to specify semantically they are describing the same subject.
-
-
<script id="wb-script"
-type="application/ld+json">
- {
- "@context":"http://schema.org",
- "@id": "#wb-main",
- "@type": "FAQPage",
- "publisher":{
- "@type":"GovernmentOrganization",
- "@id":"#wb-publisher",
- "name":"Government of Canada",
- "url":"https://www.canada.ca/en.html"
- },
- "headline": "How much you can get",
- "description":"Calculate your payments, shared custody and your payments, payments are recalculated in July, Related provincial and territorial benefits, children with a disability, repaying an overpayment",
- "mainEntity": [{
- "@type": "Question",
- "name": "Calculate your payments",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "acceptedAnswer": {
- "@type": "Answer",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "text": "<p>Use the child and family benefits calculator to help plan your budget.</p>
- <p><a href='https://www.canada.ca/en/revenue-agency/services/child-family-benefits/child-family-benefits-calculator.html?utm_source=google&utm_medium=organic&utm_campaign=faq-data&utm_content=ccbhowmuch-en-q1-001'> Calculate how much you can get</a></p>
-
- <p><a href='https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html?utm_source=google&utm_medium=organic&utm_campaign=faq-data&utm_content=ccbhowmuch-en-q1-002#math'>See the math behind CCB payments</a></p>"
- }
- },
- {
- "@type": "Question",
- "name": "Shared custody and your payments",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "acceptedAnswer": {
- "@type": "Answer",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "text": "
- <p>Each parent with shared custody will get 50% of what they would have gotten if they had full custody of the child, calculated based on their own adjusted family net income.</li>
- <p>The CRA will not split the amount using other percentages, or give the full amount to one of the parents if CRA considers you to have shared custody.</li>
- <p>If a child only lives with you <strong>part time</strong>, go to <a href='https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-before-you-apply.html?utm_source=google&utm_medium=organic&utm_campaign=faq-data&utm_content=ccbhowmuch-en-q2-001#shared'>Custody arrangements and your benefits</a> to find out if you are considered to have shared custody.</p>"
- }
- }]
- }
-</script>
-<body vocab="http://schema.org/" typeof="WebPage">
- <div typeof="Organisation" resource="#wb-publisher">
- <img src="/link/to/a/logo" alt="Publisher name" property="logo" />
- <meta property="name" content="Publisher name" />
- </div>
- <main property="mainContentOfPage" typeof="WebPageElement" resource="#wb-main">
- </main>
-</body>
-
-
- AEM
-
-
Add the code in the Structured data component in the page properties.
-
-
{
- "@context":"http://schema.org",
- "@id": "#wb-main",
- "@type": "FAQPage",
- "publisher":{
- "@type":"GovernmentOrganization",
- "@id":"#wb-publisher",
- "name":"Government of Canada",
- "url":"https://www.canada.ca/en.html"
- },
- "headline": "How much you can get",
- "description":"Calculate your payments, shared custody and your payments, payments are recalculated in July, Related provincial and territorial benefits, children with a disability, repaying an overpayment",
- "mainEntity": [{
- "@type": "Question",
- "name": "Calculate your payments",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "acceptedAnswer": {
- "@type": "Answer",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "text": "<p>Use the child and family benefits calculator to help plan your budget.</p><p><a href='https://www.canada.ca/en/revenue-agency/services/child-family-benefits/child-family-benefits-calculator.html?utm_source=google&utm_medium=organic&utm_campaign=faq-data&utm_content=ccbhowmuch-en-q1-001'> Calculate how much you can get</a></p><p><a href='https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html?utm_source=google&utm_medium=organic&utm_campaign=faq-data&utm_content=ccbhowmuch-en-q1-002#math'>See the math behind CCB payments</a></p>"
- }
- },
- {
- "@type": "Question",
- "name": "Shared custody and your payments",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "acceptedAnswer": {
- "@type": "Answer",
- "url": "https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html",
- "text": "<p>Each parent with shared custody will get 50% of what they would have gotten if they had full custody of the child, calculated based on their own adjusted family net income.</li><p>The CRA will not split the amount using other percentages, or give the full amount to one of the parents if CRA considers you to have shared custody.</li><p>If a child only lives with you <strong>part time</strong>, go to <a href='https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-before-you-apply.html?utm_source=google&utm_medium=organic&utm_campaign=faq-data&utm_content=ccbhowmuch-en-q2-001#shared'>Custody arrangements and your benefits</a> to find out if you are considered to have shared custody.</p>"
- }
- }]
- }
-
-
-
-
-
-
-
-
-
-
HowTo
-
When to use
-
Use for tasks that require a very clear step-by-step approach.
Add id attribute to the JSON-LD HTML script element named “wb-script”.
-
Use the same JSON-LD root id anchor as the one for the main content of the page. Both will use “#wb-main” to specify semantically they are describing the same subject.
-
-
<script id="wb-script"
-type="application/ld+json">
- {
- "@context":"http://schema.org",
- "@id": "#wb-main",
- "@type":"HowTo",
- "publisher":{
- "@type":"GovernmentOrganization",
- "@id":"#wb-publisher",
- "name":"Government of Canada",
- "url":"https://www.canada.ca/en.html"
- },
- "description":"The Canada child benefit (CCB) is a tax-free monthly payment made to eligible families to help with the cost of raising children under 18 years of age. ",
- "name":"Canada child benefit",
- "step":[{
- "@type":"HowToStep",
- "image":"http://test.canada.ca/covid-19-guidance/proto/structured_data/step_1.svg",
- "name":"Who can apply",
- "url":"https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-before-you-apply.html",
- "Position":1,
- "text":"Who can get the Canada child benefit, who is primarily responsible for the care and upbringing of the child, and impact of shared custody on your benefits"
- },
- {"@type":"HowToStep",
- "image":"http://test.canada.ca/covid-19-guidance/proto/structured_data/step_2.svg",
- "name":"Apply",
- "url":"http://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-apply.html",
- "position":2,
- "text":"When and how to apply, and when you need to provide additional documents"
- }
- ]}
-</script>
-<body vocab="http://schema.org/" typeof="WebPage">
- <div typeof="Organisation" resource="#wb-publisher">
- <img src="/link/to/a/logo" alt="Publisher name" property="logo" />
- <meta property="name" content="Publisher name" />
- </div>
- <main property="mainContentOfPage" typeof="WebPageElement" resource="#wb-main">
- </main>
-</body>
-
-
- AEM
-
Add the code in the Structured data component in the page properties.
-
{
- "@context":"http://schema.org",
- "@id": "#wb-main",
- "@type":"HowTo",
- "publisher":{
- "@type":"GovernmentOrganization",
- "@id":"#wb-publisher",
- "name":"Government of Canada",
- "url":"https://www.canada.ca/en.html"
- },
- "description":"The Canada child benefit (CCB) is a tax-free monthly payment made to eligible families to help with the cost of raising children under 18 years of age. ",
- "name":"Canada child benefit",
- "step":[{
- "@type":"HowToStep",
- "image":"http://test.canada.ca/covid-19-guidance/proto/structured_data/step_1.svg",
- "name":"Who can apply",
- "url":"https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-before-you-apply.html",
- "Position":1,
- "text":"Who can get the Canada child benefit, who is primarily responsible for the care and upbringing of the child, and impact of shared custody on your benefits"
- },
- {"@type":"HowToStep",
- "image":"http://test.canada.ca/covid-19-guidance/proto/structured_data/step_2.svg",
- "name":"Apply",
- "url":"http://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-apply.html",
- "position":2,
- "text":"When and how to apply, and when you need to provide additional documents"
- }
- ]}
-
-
-
-
-
-
-
-
-
-
Speakable
-
When to use
-
Use to identify any section of content that would be best suitable for text-to-speech: the part of the page that encapsulates the most important content people are looking for on that page.
Add id attribute to the JSON-LD HTML script element named “wb-script”.
-
Use the same JSON-LD root id anchor as the one for the main content of the page. Both will use “#wb-main” to specify semantically they are describing the same subject.
-
-
<script id="wb-script"
-type="application/ld+json">
- {
- "@context":"http://schema.org",
- "@id": "#wb-main",
- "@type": "WebPage",
- "name": "How much Canada Child Benefit you could get",
- "speakable":{
- "@type": "SpeakableSpecification","cssSelector": [".speakable1"]
- },
- "url":"https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html"}
-</script>
-<body vocab="http://schema.org/" typeof="WebPage">
- <div typeof="Organisation" resource="#wb-publisher">
- <img src="/link/to/a/logo" alt="Publisher name" property="logo" />
- <meta property="name" content="Publisher name" />
- </div>
- <main property="mainContentOfPage" typeof="WebPageElement" resource="#wb-main">
- <p class="speakable1 ">The maximum Canada child benefit you could get is $6,639 per year for children under 6, and $5,602 per year for children aged 6 to 17.</p>
- </main>
-</body>
-
-
- AEM
-
Add the code in the Structured data component in the page properties.
-
{
- "@context":"http://schema.org",
- "@id": "#wb-main",
- "@type": "WebPage",
- "name": "How much Canada Child Benefit you could get",
- "speakable":{
- "@type": "SpeakableSpecification","cssSelector": [".speakable1"]
- },
- "url":"https://www.canada.ca/en/revenue-agency/services/child-family-benefits/canada-child-benefit-overview/canada-child-benefit-we-calculate-your-ccb.html"}
Add id attribute to the JSON-LD HTML script element named “wb-script”.
-
Use the same JSON-LD root id anchor as the one for the main content of the page. Both will use “#wb-main” to specify semantically they are describing the same subject.
Every day, over a million visitors come to Canada.ca to get information and access government services. Use the data from these tools to see how people are interacting with the Government of Canada online.
-
-
-
-
-
Web analytics
-
Quantitative data tells us what people are doing on the site
55.1% of respondents said it was “easy” or “very easy” to do what they needed to do online
-
-
-
-
-
-
-
-
-
Satisfaction
-
-
-
-
44.1% of respondents were “satisfied” or “very satisfied” with their experience on the website
-
-
-
-
-
-
-
-
-
Margin of error
-
-
-
-
The margin of error for these results is 15%. Note that the margin of error displayed is the average of the margins of error for the three scores (task completion, ease and satisfaction) for ease of understanding.
-
-
-
-
-
-
-
-
-
Data reliability
-
-
-
-
The margin of error is considered to be very high (above 10%). There is insufficient data to draw conclusions.
-
-
-
-
-
-
-
-
-
-
-
Rest of the page content here....
-
-
-
Automated analysis of latest quarterly comments
-
-
Experimental
-
-
This experiment uses machine learning to automatically group similar comments - giving you a glimpse into potential issues.
-
-
- Group 1 | 25% of comments | account, logging in, status
-
-
-
This group includes 450 comments (25% of all feedback) for this task.
-
-
-
-
-
-
-
-
- Comment examples
-
-
-
-
-
-
-
-
-
-
- Error 403 kept showing whenever i try to login
-
-
-
-
-
-
-
-
-
-
-
-
- Error 403 keeps happening when I tried to log into my account. After 4-5 times keeping trying again, I finally logged in but when I was linking an application, the error happened one more time. It's really frustrating.
-
-
-
-
-
-
-
-
-
-
-
-
- Group 2 | 20% of comments | GCKey, logging in, redirect
-
-
-
This group includes 400 comments (20% of all feedback) for this task.
-
-
-
-
-
-
-
-
-
- Comment examples
-
-
-
-
-
-
-
-
-
-
- Error 403 kept showing whenever i try to login
-
-
-
-
-
-
-
-
-
-
-
-
- Error 403 keeps happening when I tried to log into my account. After 4-5 times keeping trying again, I finally logged in but when I was linking an application, the error happened one more time. It's really frustrating.
-
-
-
-
-
-
-
-
-
-
-
-
- Group 3 | 10% of comments | error 403, logging in, expired
-
-
-
This group includes 350 comments (10% of all feedback) for this task.
-
-
-
-
-
-
-
-
-
- Comment examples
-
-
-
-
-
-
-
-
-
-
- Error 403 kept showing whenever i try to login
-
-
-
-
-
-
-
-
-
-
-
-
- Error 403 keeps happening when I tried to log into my account. After 4-5 times keeping trying again, I finally logged in but when I was linking an application, the error happened one more time. It's really frustrating.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Automated comment analysis
-
-
-
-
This experiment uses machine learning to automatically group similar comments - giving you a glimpse into potential issues.
-
- Error 403 kept showing whenever i try to login
-
-
-
-
-
-
-
-
-
-
-
-
- Error 403 keeps happening when I tried to log into my account. After 4-5 times keeping trying again, I finally logged in but when I was linking an application, the error happened one more time. It's really frustrating.
-
-
If you find the automated analysis is not accurate or you would prefer to do your own analysis, you can download raw survey data using the Feedback Viewer.