Skip to content

Commit

Permalink
Merge pull request #465 from canada-ca/corrections
Browse files Browse the repository at this point in the history
fix topic-theme links
  • Loading branch information
jmealing authored Oct 1, 2024
2 parents e604224 + 4e03acc commit c8793d5
Show file tree
Hide file tree
Showing 15 changed files with 27 additions and 25 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Canada.ca design library - evidence-based patterns & templates

In order to move towards a more flexible design system, the plan is to “decouple” the detailed specs of the templates and patterns from the official "policy documents" - the [Canada.ca Content and Information Architecture Specification](https://design.canada.ca/architecture/canada-content-information-architecture-specification.html) and [Canada.ca Content Style Guide](https://design.canada.ca/style-guide/).
In order to move towards a more flexible design system, the plan is to “decouple” the detailed specs of the templates and patterns from the official "policy documents" - the [Canada.ca Specifications](https://design.canada.ca/architecture/canada-content-information-architecture-specification.html) and [Canada.ca Content Style Guide](https://design.canada.ca/style-guide/).

The vision would then be to gradually improve each pattern and template and make into usable code (rather than pictures) with instructions. We could also have a separate library of "experimental patterns and templates", that we could open up to the whole community. We would need to eventually develop a process involving the community for a pattern to go from “experimental” to "approved".
8 changes: 4 additions & 4 deletions about/latest-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ title: "Latest changes to the Canada.ca design system"
<summary>August 28, 2024</summary>
<p>Launched a new information architecture and new content for design.canada.ca. Changes include:</p>
<ul>
<li>Renamed the Content and Information Architecture Specification to the <a href="{{ site.url }}/specifications.html">Canada.ca Specifications</a>.</li>
<li>Renamed the Content and Information Architecture Specification to the <a href="{{ site.url }}/specifications.html">Canada.ca Specifications</a>.</li>
<li>Updated the Canada.ca Specifications to include the Canada.ca Content Style Guide and guidance on information architecture and findability, as well as a link to the GC design system: <a href="{{ site.url }}/specifications.html">Canada.ca Specifications</a>.</li>
<li>Created guidance on how to write metadata for Canada.ca pages: <a href="{{ site.url }}/specifications/information-findability/metadata.html">Improving titles and metadata for findability</a>.</li>
<li>Consolidated domain and URL guidance into one page: <a href="{{ site.url }}/specifications/mandatory-elements/domains-urls.html">Government of Canada domains and URLs</a>.</li>
Expand Down Expand Up @@ -145,7 +145,7 @@ title: "Latest changes to the Canada.ca design system"
</details>
<details>
<summary>June 30, 2020</summary>
<p>We added a new beta version of the <a href="{{ site.url }}/mandatory-templates/theme-topic.html">Theme and topic template</a>. </p>
<p>We added a new beta version of the <a href="{{ site.url }}/mandatory-templates/theme.html">Theme template</a> and <a href="{{ site.url }}/mandatory-templates/topic.html">topic template</a>. </p>
</details>
<details>
<summary>June 25, 2020</summary>
Expand Down Expand Up @@ -199,7 +199,7 @@ title: "Latest changes to the Canada.ca design system"
<summary>January 31, 2019</summary>
<p>We’ve made major updates to the Canada.ca design system:</p>
<ul>
<li>the <a href="{{ site.url }}/architecture/canada-content-information-architecture-specification.html">Canada.ca Content and Information Architecture Specification</a> now contains only core requirements:</li>
<li>the <a href="{{ site.url }}/architecture/canada-content-information-architecture-specification.html">Canada.ca Specifications</a> now contains only core requirements:</li>
<ul>
<li>who must follow the Canada.ca design system</li>
<li>what elements are mandatory</li>
Expand All @@ -210,7 +210,7 @@ title: "Latest changes to the Canada.ca design system"
<li>the <a href="{{ site.urlcanadaca }}/en/government/about/design-system/pattern-library.html">template and design pattern library</a> contains all detailed information about specific templates and patterns</li>
<li>a new <a href="{{ site.urlcanadaca }}/en/government/about/design-system/pattern-library/find-right-template-design-pattern-web-content.html">interactive pattern selector</a> makes it easier to find the right template or design pattern</li>
<li>the <a href="{{ site.url }}/specifications/information-findability/organizing-content.html">organizing content</a> section simplifies the direction on information architecture, user-need categories and the URL model</li>
<li>the <a href="{{ site.url }}/mandatory-templates/topic-pages.html">topic page template</a> is now only mandatory for the first 2 topic layers, although it can be used at lower levels when appropriate</li>
<li>the <a href="{{ site.url }}/mandatory-templates/topic.html">topic page template</a> is now only mandatory for the first 2 topic layers, although it can be used at lower levels when appropriate</li>
<li>the home page design reflects the recent changes to the live site</li>
</ul>
<p>Overall, this update signals a shift in philosophy. We’ve shortened the list of mandatory elements, and shifted the focus to task success for users. Templates and design patterns will be changed and improved regularly, based on evidence. All changes will be documented on this page.</p>
Expand Down
2 changes: 1 addition & 1 deletion common-design-patterns/global-header.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ title: "Global header"
Blog post explaining the changes that are being made to the Canada.ca design, and how they are being implemented</li>
</ul>
<h3>Policy rationale</h3>
<p>This pattern is a mandatory element of the <cite>Content and Information Architecture Specification.</cite></p>
<p>This pattern is a mandatory element of the <cite>Canada.ca Specifications.</cite></p>
<ul>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the design system</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion common-design-patterns/global-header/breadcrumb-trail.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ title: "Breadcrumb trail"
</ul>
<h3>Policy rationale</h3>
<p>The spacing specifications for the breadcrumb links are designed so that touch targets meet WCAG AAA requirements.</p>
<p>As part of the global header, the breadcrumb is a mandatory element under the <cite>Content and Information Architecture Specification.</cite></p>
<p>As part of the global header, the breadcrumb is a mandatory element under the <cite>Canada.ca Specifications.</cite></p>
<ul>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the design system</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion common-design-patterns/global-header/language-toggle.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ title: "Language toggle"
<h2 id="research">Research and rationale</h2>
<p>Consult policy rationale.</p>
<h3>Policy rationale</h3>
<p>As part of the global header, the language toggle is a mandatory element under the <cite>Content and Information Architecture Specification.</cite></p>
<p>As part of the global header, the language toggle is a mandatory element under the <cite>Canada.ca Specifications.</cite></p>
<ul>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the design system</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion common-design-patterns/global-header/search-box.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ title: "Site search box"
<h2 id="research">Research and rationale</h2>
<p>Placing site search in the top-right corner of a web page is an established web convention.</p>
<h3>Policy rationale</h3>
<p>As part of the global header, the site search box is a mandatory element under the <cite>Content and Information Architecture Specification.</cite></p>
<p>As part of the global header, the site search box is a mandatory element under the <cite>Canada.ca Specifications.</cite></p>
<ul>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the design system</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion common-design-patterns/global-header/signature.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ title: "Government of Canada signature"
<p>For example, people trust the page more when the flag in the Government of Canada signature is red.</p>
<p>If you want to know more about this research, contact the Digital Transformation Office at <a href="mailto:{{ site.emails.dto }}">{{ site.emails.dto }}</a>.</p>
<h3>Policy rationale</h3>
<p>The Government of Canada signature is defined by the Federal Identity Program. As a part of the global header, it is a mandatory element under the <cite>Content and Information Architecture Specification.</cite></p>
<p>The Government of Canada signature is defined by the Federal Identity Program. As a part of the global header, it is a mandatory element under the <cite>Canada.ca Specifications.</cite></p>
<ul>
<li><a href="https://www.canada.ca/en/treasury-board-secretariat/services/government-communications/design-standard/colour-design-standard-fip.html">Design Standard for the Federal Identity Program</a></li>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the design system</a></li>
Expand Down
2 changes: 1 addition & 1 deletion common-design-patterns/global-header/site-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ title: "Theme and topic menu"

<h3>Policy rationale</h3>
<p>The spacing specifications for the breadcrumb links are designed so that touch targets meet WCAG AAA requirements.</p>
<p>As part of the global header, the breadcrumb is a mandatory element under the <cite>Content and Information Architecture Specification.</cite></p>
<p>As part of the global header, the breadcrumb is a mandatory element under the <cite>Canada.ca Specifications.</cite></p>
<ul>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the design system</a></li>
</ul>
Expand Down
3 changes: 2 additions & 1 deletion common-design-patterns/most-requested.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ title: Most requested band
<p>The most requested pattern is required in the following mandatory templates:</p>
<ul>
<li><a href="https://design.canada.ca/mandatory-templates/institutional-profile-pages.html">Institutional landing page</a></li>
<li><a href="https://design.canada.ca/mandatory-templates/theme-topic.html">Theme and topic page template</a></li>
<li><a href="https://design.canada.ca/mandatory-templates/theme.html">Theme page template</a></li>
<li><a href="https://design.canada.ca/mandatory-templates/topic.html">Topic page template</a></li>
</ul>
<h2 id="latest">Latest changes</h2>
<dl class="dl-horizontal">
Expand Down
3 changes: 2 additions & 1 deletion common-design-patterns/services-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,8 @@ title: Services and information
<p>Services and information is an required pattern for the following mandatory templates:</p>
<ul>
<li><a href="https://design.canada.ca/mandatory-templates/institutional-profile-pages.html">Institutional landing page</a></li>
<li><a href="https://design.canada.ca/mandatory-templates/theme-topic.html">Theme and topic page template</a></li>
<li><a href="https://design.canada.ca/mandatory-templates/theme.html">Theme template</a></li>
<li><a href="https://design.canada.ca/mandatory-templates/topic.html">Topic page template</a></li>
</ul>
</section>
<section>
Expand Down
2 changes: 1 addition & 1 deletion mandatory-templates/institutional-profile-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ title: Institutional landing page
access to corporate information about the organization.
</p>
<h3>Policy rationale</h3>
<p>This template is a mandatory element of the Content and Information Architecture Specification.</p>
<p>This template is a mandatory element of the Canada.ca Specifications.</p>
<ul>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the design system</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion research-summaries/wayfinding-on-canada-ca.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ title: "Wayfinding on Canada.ca"
<li><a href="https://blog.canada.ca/2022/12/21/wayfinding-research-project">Wayfinding research project improves our approach to navigation on Canada.ca</a><br>
blog post that describes the rolling out of a new design to navigate on Canada.ca</li>
<li><a href="https://design.canada.ca/specifications/mandatory-elements.html">Mandatory elements of the Canada.ca design system</a><br>
Canada.ca Content and Information Architecture Specification that provides a consistent experience for site visitors</li>
Canada.ca Specifications that provides a consistent experience for site visitors</li>
<li><a href="https://blog.canada.ca/pages/project-overview.html">Improving content on Canada.ca</a><br>
a list of other projects we have done with our partners</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions specifications/mandatory-elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ breadcrumbs: [{
<h2 id="mandatory">Other mandatory templates</h2>
<p>Specific Canada.ca page types use mandatory templates. Consistency in these page types helps people find and accomplish tasks. </p>
<ul>
<li><a href="https://design.canada.ca/mandatory-templates/theme-topic.html">Theme page</a>: top-level page for each Canada.ca theme, to be used only by theme lead institution</li>
<li><a href="https://design.canada.ca/mandatory-templates/theme-topic.html">Topic page</a>: mandatory for the first 2 levels of topics in the Canada.ca topic tree, optional for lower-level topics</li>
<li><a href="https://design.canada.ca/mandatory-templates/theme.html">Theme page</a>: top-level page for each Canada.ca theme, to be used only by theme lead institution</li>
<li><a href="https://design.canada.ca/mandatory-templates/topic.html">Topic page</a>: mandatory for the first 2 levels of topics in the Canada.ca topic tree, optional for lower-level topics</li>
<li><a href="https://design.canada.ca/mandatory-templates/audience-pages.html">Government-wide audience page</a>: to be used only by the institutions managing the government-wide audiences</li>
<li><a href="https://design.canada.ca/mandatory-templates/ministerial-profile-pages.html">Ministerial profile</a>: to be used for ministers and parliamentary secretaries (also used with modification for heads of quasi-judicial arm’s-length institutions)</li>
<li><a href="https://design.canada.ca/mandatory-templates/news-pages.html#product">News products</a>: common layouts for news products such as releases, backgrounders, advisories and speeches</li>
Expand Down
12 changes: 6 additions & 6 deletions style-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "The Canada.ca Content Style Guide provides the rules to create web
title: "Canada.ca Content Style Guide"
---
<section id="intro">
<p>These are the rules to create web content that can be easily found, understood and used. They are based on writing principles and techniques that help make web content clear and adapted to the needs of all people. Use it with the <a href="{{ site.url }}/architecture/canada-content-information-architecture-specification.html">Content and Information Architecture Specification</a> when you're designing and organizing web content.</p>
<p>These are the rules to create web content that can be easily found, understood and used. They are based on writing principles and techniques that help make web content clear and adapted to the needs of all people. Use it with the <a href="{{ site.url }}/architecture/canada-content-information-architecture-specification.html">Canada.ca Specifications</a> when you're designing and organizing web content.</p>
</section>
<section id="toc">
<div class="row mrgn-tp-lg">
Expand Down Expand Up @@ -60,7 +60,7 @@ title: "Canada.ca Content Style Guide"
<h2>Related policies, standards and procedures</h2>
<p>Content must comply with:</p>
<ul>
<li>templates, content components, character limits and other requirements as described in the <cite><a href="{{ site.url }}/architecture/canada-content-information-architecture-specification.html">Canada.ca Content and Information Architecture Specification</a></cite></li>
<li>templates, content components, character limits and other requirements as described in the <cite><a href="{{ site.url }}/architecture/canada-content-information-architecture-specification.html">Canada.ca Specifications</a></cite></li>
<li>requirements set out in the related legislated and policy instruments, including:
<ul>
<li><cite><a href="https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=30683">Policy on Communications and Federal Identity</a></cite></li>
Expand Down Expand Up @@ -465,7 +465,7 @@ title: "Canada.ca Content Style Guide"
<p>People who don't speak English or French might use online tools to translate text. These tools do not always translate words and ideas accurately.</p>
<h4>Examples</h4>
<ul>
<li><strong>Jargon</strong>:
<li><strong>Jargon</strong>:
<ul>
<li>adverse effect (effect)</li>
<li>citizen engagement (meaningful involvement of citizens)</li>
Expand Down Expand Up @@ -2029,7 +2029,7 @@ title: "Canada.ca Content Style Guide"
<li>promotional features on a topic page or home page (Government of Canada activities and initiatives)</li>
</ul>
<p>Don't place meaningful text, such as campaign or program titles, in decorative images.</p>
<p>Get details about the templates above in the <a href="https://www.tbs-sct.gc.ca/hgw-cgf/oversight-surveillance/communications/cia-sca-eng.asp">Canada.ca Content and Information Architecture Specification</a>.</p>
<p>Get details about the templates above in the <a href="https://www.tbs-sct.gc.ca/hgw-cgf/oversight-surveillance/communications/cia-sca-eng.asp">Canada.ca Specifications</a>.</p>
<h5>Example of a decorative image</h5>
<p><img alt="Decorative image in context to create visual interest" class="img-responsive" src="/style-guide/images/shopping-cart-02.png"></p>
<h5>Don’t describe decorative images</h5>
Expand All @@ -2041,7 +2041,7 @@ title: "Canada.ca Content Style Guide"
<h4>Image sizing and placement</h4>
<p>Learn where to place images and videos on Canada.ca and what size they should be:</p>
<ul>
<li>use the templates in the <a href="https://www.tbs-sct.gc.ca/hgw-cgf/oversight-surveillance/communications/cia-sca-eng.asp">Canada.ca Content and Information Architecture Specification</a></li>
<li>use the templates in the <a href="https://www.tbs-sct.gc.ca/hgw-cgf/oversight-surveillance/communications/cia-sca-eng.asp">Canada.ca Specifications</a></li>
<li>see the <a href="https://wet-boew.github.io/themes-dist/GCWeb/index-en.html">Canada.ca page types on GitHub</a></li>
</ul>
</section>
Expand Down Expand Up @@ -2173,7 +2173,7 @@ title: "Canada.ca Content Style Guide"
</tfoot>
</table>
</figure>
<p>Work with your web team to determine the best way to include the long description information. They'll guide you on how to make sure the image is accessible to people using assistive technology. They'll also ensure that your image meets the <cite><a href="https://www.tbs-sct.gc.ca/hgw-cgf/oversight-surveillance/communications/cia-sca-eng.asp">Canada.ca Content and Information Architecture Specification</a></cite>.</p>
<p>Work with your web team to determine the best way to include the long description information. They'll guide you on how to make sure the image is accessible to people using assistive technology. They'll also ensure that your image meets the <cite><a href="https://www.tbs-sct.gc.ca/hgw-cgf/oversight-surveillance/communications/cia-sca-eng.asp">Canada.ca Specifications</a></cite>.</p>
<h4>See how this rule applies in French:</h4>
<ul>
<li><span lang="fr"><a href="{{ site.urlconception }}/guide-redaction/#wp6-3">6.3 Ajouter une description longue pour expliquer les images complexes</a></span></li>
Expand Down
4 changes: 2 additions & 2 deletions survey/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ title: " About Canada.ca"
</li>
<li>
<a href="/en/treasury-board-secretariat/services/government-communications/canada-content-information-architecture-specification.html">
Content and Information Architecture Specification
Canada.ca Specifications
</a>
</li>
<li>
Expand Down Expand Up @@ -73,7 +73,7 @@ title: " About Canada.ca"
</a>
</h3>
<p>
Content and Information Architecture Specification, Content Style Guide, templates and design patterns, topic tree, institutions list, theme lead departments.
Canada.ca Specifications, Content Style Guide, templates and design patterns, topic tree, institutions list, theme lead departments.
</p>
</section>
</div>
Expand Down

0 comments on commit c8793d5

Please sign in to comment.