Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

January30 [draft] #399

Draft
wants to merge 13 commits into
base: master
Choose a base branch
from
Draft

January30 [draft] #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b6484ce
Update index.md
AnneSophieDumetz Jan 25, 2024
b54d8a1
Update index.md
AnneSophieDumetz Jan 26, 2024
5f59b1a
Update index.md
AnneSophieDumetz Jan 26, 2024
4fb4c7e
Update index.md
AnneSophieDumetz Jan 26, 2024
80080a3
Update index.md
AnneSophieDumetz Jan 27, 2024
b175a24
Update index.md
AnneSophieDumetz Jan 27, 2024
aaf957f
Update update-history.md
AnneSophieDumetz Jan 27, 2024
8259361
Update index.md
AnneSophieDumetz Jan 30, 2024
5d78151
Merge pull request #402 from canada-ca/master
prycrane Jan 31, 2024
166b776
Update update-history.md
donohuech Jan 31, 2024
f4bc4f8
Update index.md
donohuech Jan 31, 2024
4bd00bb
Update update-history.md
donohuech Jan 31, 2024
8495108
Update update-history.md
donohuech Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 70 additions & 41 deletions style-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
altLangPage: "https://conception.canada.ca/guide-redaction"
date: 2017-10-05
dateModified: 2024-01-23
dateModified: 2024-01-31
description: "The Canada.ca Content Style Guide provides the rules to create web content that can be easily found, understood and used."
title: "Canada.ca Content Style Guide"
---
Expand Down Expand Up @@ -46,7 +46,8 @@ title: "Canada.ca Content Style Guide"
<h2>Purpose</h2>
<p>This guide establishes the rules you must use to develop and edit English web content that will be published on a Government of Canada website. The rules are different from practices adapted to print to support principles related to accessibility, readability and usability.</p>
<p>The purpose of these rules is to make web content easy to find, easy to understand and easy to use for everyone, including people who have physical or cognitive disabilities.</p>
<p>The techniques described in this guide complement the rules set out in <cite><a href="https://www.btb.termiumplus.gc.ca/tpv2guides/guides/tcdnstyl/index-eng.html?lang=eng">The Canadian Style</a></cite>. If there are conflicts between this guide and <cite>The Canadian Style</cite> or any other resource, this guide takes priority for content published online.</p>
<p>The techniques described in this guide complement the rules set out in <cite><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/index-eng">Writing Tips Plus</a></cite>, a searchable tool that deals with difficult points of English grammar and punctuation, as well as other English writing conventions.
If there are conflicts between this guide, </cite>Writing Tips Plus</cite> or any other resource, this guide takes priority for content published online.</p>
<p>As web and language trends evolve, we'll update this guide to meet the changing needs of our audiences.</p>
</section>
<section id="toc3">
Expand Down Expand Up @@ -875,13 +876,13 @@ title: "Canada.ca Content Style Guide"
<li>for long passages of text, such as quotations</li>
<li>in page titles</li>
</ul>
<p>Follow <cite><a href="https://www.btb.termiumplus.gc.ca/tcdnstyl-chap?lang=eng&amp;lettr=chap_catlog&amp;info0=6#zz6">The Canadian Style</a></cite>'s rules for applying italics for the following:</p>
<p>Follow <cite><a href="[https://www.btb.termiumplus.gc.ca/tcdnstyl-chap?lang=eng&amp;lettr=chap_catlog&amp;info0=6#zz6](https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/index-eng)">Writing Tips Plus</a></cite>rules for applying italics for the following:</p>
<ul>
<li>French and foreign words (article 6.03)</li>
<li>Latin terms and abbreviations (article 6.04)</li>
<li>titles of publications (including acts and legislation) and works of art (article 6.05)</li>
<li>legal references (article 6.06)</li>
<li>mathematical, statistical and scientific material (article 6.11)</li>
<li><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/italics-french-and-foreign-words.html">italics: French and foreign words</a></li>
<li><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/italics-legal-references.html">italics: legal references</a></li>
<li><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/italics-mathematical-and-scientific-material.html">italics: mathematical and scientific material</a></li>
<li><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/italics-titles-of-works">italics: titles of works</a></li>
<li><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/latin-terms-and-abbreviations">Latin terms and abbreviations</a></li>
</ul>
<h4>See how the rule for bold, italics and underlining applies in French</h4>
<ul>
Expand Down Expand Up @@ -2144,7 +2145,7 @@ title: "Canada.ca Content Style Guide"
</div>
</section>
<section id="toc11">
<h2>7.0 Links</h2>
<h2>7.0 Links</h2>
<div class="row mrgn-tp-lg">
<div class="col-md-8">
<div class="panel panel-default">
Expand All @@ -2159,6 +2160,7 @@ title: "Canada.ca Content Style Guide"
<li><a href="#wp7-2">7.2 Write descriptive links</a>
<ul>
<li><a href="#wp7-2-1">Focus on the task</a></li>
<li><a href="wp7-2-2">Use parentheses to include contextual information</li>
</ul>
</li>
<li><a href="#wp7-3">7.3 Make sure that links work</a></li>
Expand Down Expand Up @@ -2246,6 +2248,53 @@ title: "Canada.ca Content Style Guide"
<div class="wb-share btn btn-default" data-wb-share='{"custType": " the rule for writing descriptive links", "title": "7.2 Write descriptive links", "url": "https://design.canada.ca/style-guide/#wp7-2", "filter": ["email", "facebook", "linkedin", "twitter"], "pnlId": "wp7-2"}'></div>
</div>
</section>
<section id="wp7-2-2">
<div>
<h4>Use parentheses for contextual information</h4>
<p>Use parentheses inside a link to add information that provides context about the linked content. Only provide necessary, contextual information to help users decide whether to proceed.</p>
<p>This guidance applies in the following situations:</p>
<ul>
<li><strong>Link is to a downloadable document.</strong> Make sure to include <strong>the file type</strong> and <strong>size</strong> in the parentheses:</li>
<ul>
<li><strong>Example: </strong><a href="https://www.asc-csa.gc.ca/pdf/eng/publications/2021-2022-state-canadian-space-sector-facts-figures-2020-2021-v2.pdf">State of the Canadian Space Sector Report (PDF, 4.35 MB)</a></li>
</ul>
</ul>
<ul>
<li><strong>Link to external content is in a different language.</strong></li>
<p>Some non-government web content isn't available in both official languages. If you're linking to external web content that isn't available in the language of the current page, say in which language(s) it is available after the link.</p>
<ul>
<li>Add parentheses inside the link and specify the language of the linked content, formatted as (Language X only).</li>
<li>Do not translate the title of the linked content.</li>
<li>Ensure its language is indicated in the link’s code.</li>
</ul>
<p>On an English page, write:</p>
<ul>
<li><a href="#">Link text (French only)</a></li>
<li><a href="#">Link text (Inuktitut only)</a></li>
<li><a href="#">Link text (Spanish and Portuguese only)</a></li>
<p><strong>Example: </strong>To renew your French passport while abroad in Canada, follow the steps described in <span lang="fr"><a href="https://passeport.ants.gouv.fr/Vos-demarches/Renouvellement-perte-ou-vol">Effectuer le renouvellement de votre passeport (French only)</a></span>.</p>
<p>Follow the same structure on French-language pages linking to English content:</p>
</ul>
<ul>
<li><span lang="fr">L’article 508 révisé, la norme EN 301 549 ou les </span><span lang="en"><a href="https://accessibility.18f.gov/">Web Content Accessibility Guidelines (WCAG) (en anglais seulement)</a></span></li>
</ul>
</ul>
<li><strong>Link opens video or audio content.</strong> Specify the length of the content inside the parentheses. </li>
</ul>
<ul><li>Example:<a href="https://www.youtube.com/watch?v=GbDT6FxQ6mk">Using Magnifier in Windows: At a Glance - YouTube (2:07 minutes)</a></li></ul>
<li><strong>When more than one situation applies</strong>, include all applicable information in parentheses.</li>
<ul>
<li><strong>Example: </strong><a href="https://www.rhone.gouv.fr/contenu/telechargement/47282/261770/file/Psp_urgent_formulaire_26_7_21.pdf">Complete your application&nbsp&#8212&nbsp<span lang="fr">Demande de passeport temporaire (French only, PDF 0.46 MB)</span></a></li>
</ul>
</ul>
<h4>See how the rule for writing descriptive links applies in French</h4>
<ul>
<li><span lang="fr"><a href="{{ site.urlconception }}/guide-redaction/#wp7-2">7.2 Rédiger des liens descriptifs</a></span></li>
</ul>
<div class="mrgn-tp-lg">
<div class="wb-share btn btn-default" data-wb-share='{"custType": " the rule for writing descriptive links", "title": "7.2 Write descriptive links", "url": "https://design.canada.ca/style-guide/#wp7-2", "filter": ["email", "facebook", "linkedin", "twitter"], "pnlId": "wp7-2"}'></div>
</div>
</section>
<section id="wp7-3">
<h3>7.3 Make sure that links work</h3>
<p>Make sure that your links work. Check that they take people to the correct page, which contains up-to-date information, in the appropriate official language. Links that don't work frustrate people and hurt the credibility of your content.</p>
Expand All @@ -2258,37 +2307,17 @@ title: "Canada.ca Content Style Guide"
</div>
</section>
<section id="wp7-4">
<h3>7.4 Linking to non-government content</h3>
<p>Some non-government web content isn't available in both official languages. If you're linking to external web content that isn't available in the language of the current page, say in which language(s) it is available after the link.</p>
<p>On English pages, write the following after a link that leads to content that isn't available in English: "(XXXX only)".</p>
<p>If the link leads to content only available in:</p>
<ul>
<li>French, write "(French only)"</li>
<li>Inuktitut, write "(Inuktitut only)"</li>
<li>Spanish and Portuguese, write "(Spanish and Portuguese only)"</li>
</ul>
<h4>Example of a link that leads to content only available in French</h4>
<p><strong>Write</strong>: Find out how to <a href="https://passeport.ants.gouv.fr/Vos-demarches/Renouvellement-perte-ou-vol">renew your French passport while abroad in Canada</a> (French only).</p>
<h4>See how the rule for non-government content applies in French</h4>
<ul>
<li><span lang="fr"><a href="{{ site.urlconception }}/guide-redaction/#wp7-4">7.4 Créer des liens vers du contenu externe</a></span></li>
</ul>
<div class="mrgn-tp-lg">
<div class="wb-share btn btn-default" data-wb-share='{"custType": " the rule for non-government content", "title": "7.4 Linking to non-government content", "url": "https://design.canada.ca/style-guide/#wp7-4", "filter": ["email", "facebook", "linkedin", "twitter"], "pnlId": "wp7-4"}'></div>
</div>
</section>
<section id="wp7-5">
<h3>7.5 Linking to internal-to-government content</h3>
<p>In most cases, public-facing content should not link to content that is accessible only through internal government networks. Occasionally, the audience for content that is accessible to the public may be primarily internal.</p>
<p>When a link leads to content available only on internal government networks, write "(accessible only on the Government of Canada network)."</p>
<h4>See how the rule for internal-to-government content applies in French</h4>
<ul>
<li><span lang="fr"><a href="{{ site.urlconception }}/guide-redaction/#wp7-5">7.5 Créer des liens vers du contenu interne</a></span></li>
</ul>
<div class="mrgn-tp-lg">
<div class="wb-share btn btn-default" data-wb-share='{"custType": " the rule for internal-to-government content", "title": "7.5 Linking to internal-to-government content", "url": "https://design.canada.ca/style-guide/#wp7-5", "filter": ["email", "facebook", "linkedin", "twitter"], "pnlId": "wp7-5"}'></div>
</div>
</section>
<h3>7.4 Linking to internal-to-government content</h3>
<p>In most cases, public-facing content should not link to content that is accessible only through internal government networks. Occasionally, the audience for content that is accessible to the public may be primarily internal.</p>
<p>When a link leads to content available only on internal government networks, write "(accessible only on the Government of Canada network)."</p>
<h4>See how the rule for internal-to-government content applies in French</h4>
<ul>
<li><span lang="fr"><a href="https://conception.canada.ca/guide-redaction/#wp7-4">7.4 Créer des liens vers du contenu interne</a></span></li>
</ul>
<div class="mrgn-tp-lg">
<div class="wb-share btn btn-default" data-wb-share="{&quot;custType&quot;: &quot; the rule for internal-to-government content&quot;, &quot;title&quot;: &quot;7.4 Linking to internal-to-government content&quot;, &quot;url&quot;: &quot;https://design.canada.ca/style-guide/#wp7-4&quot;, &quot;filter&quot;: [&quot;email&quot;, &quot;facebook&quot;, &quot;linkedin&quot;, &quot;twitter&quot;], &quot;pnlId&quot;: &quot;wp7-4&quot;}"></div>
</div>
</section>
<section id="toc12">
<h2>Web content makeovers</h2>
<h3>Case study A: improve plain language and content structure</h3>
Expand Down Expand Up @@ -3095,13 +3124,13 @@ title: "Canada.ca Content Style Guide"
<li><a href="https://www.statcan.gc.ca/daily-quotidien/160518/dq160518b-eng.htm">Study: Literacy and numeracy among off-reserve First Nations people and Métis</a>, 2012, Statistics Canada</li>
<li><a href="https://www.statcan.gc.ca/daily-quotidien/141104/dq141104b-eng.htm">Study: University graduates with lower levels of literacy and numeracy skills</a>, 2012, Statistics Canada</li>
<li><a href="https://www.btb.termiumplus.gc.ca/tpv2alpha/alpha-fra.html?lang=fra&amp;index=frt">TERMIUM Plus</a>®, Translation Bureau</li>
<li><a href="https://www.btb.termiumplus.gc.ca/tpv2guides/guides/tcdnstyl/index-eng.html?lang=eng">The Canadian Style</a>, Translation Bureau</li>
<li><a href="https://www.musanim.com/miller1956/">The Magical Number Seven, Plus or Minus Two: Some Limits on Our Capacity for Processing</a>, George A. Miller</li>
<li><a href="https://gathercontent.com/blog/use-pair-writing-to-collaborate-with-subject-matter-experts">Use pair writing to collaborate with subject matter experts</a>, Jonathan Kahn, GatherContent</li>
<li><a href="https://www.searchenginepeople.com/blog/watch-your-punctuation-online.html">Watch Your Punctuation Online</a>, Search Engine People</li>
<li><a href="https://www.w3.org/TR/WCAG/">Web Content Accessibility Guidelines (WCAG) 2.0</a>, World Wide Web Consortium (W3C)</li>
<li><a href="https://www.deque.com/blog/dont-screen-readers-read-whats-screen-part-1-punctuation-typographic-symbols/">Why Don't Screen Readers Always Read What's on the Screen?</a>, The Deque Blog</li>
<li><a href="https://www.nngroup.com/topic/writing-web/">Writing for the web</a>, Nielsen Norman Group</li>
<li>Writing for the Web: Principles and Guidelines, University of Ottawa</li>
<li><cite><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/index-eng">Writing Tips Plus</cite>, Resource of the Language Portal of Canada, Government of Canada</a></li>
</ul>
</section>
23 changes: 22 additions & 1 deletion style-guide/update-history.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,32 @@
---
altLangPage: "https://conception.canada.ca/guide-redaction/historique-modifications.html"
date: 2023-12-21
dateModified: 2023-12-21
dateModified: 2024-01-31
description: "Update history for the Canada.ca Content Style Guide"
title: "Update history for the Canada.ca Content Style Guide"
---
<p>This list contains all changes made to the Canada.ca Content Style Guide since May 25, 2023.</p>

<h2>January 29, 2024</h2>
<ul class="mrgn-tp-lg">
<li>As of January 2024, <cite>The Canadian Style</cite> and <cite>Le guide du rédacteur</cite> were archived, with their content integrated into <cite><a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/index-eng">Writing Tips Plus</a></cite> and the <cite><span lang="fr"><a href="https://www.noslangues-ourlanguages.gc.ca/fr/cles-de-la-redaction/index-fra">Clés de la rédaction</a></span></cite>. We’ve updated references and links in the following sections:
<ul>
<li>Purpose section:</li>
<ul>
<li>Removed references to The Canadian Style and replaced with <cite>Writing Tips Plus</cite></li>
</ul>
<li>Section 4.2 Underlining, bold and italics</li>
<ul><li>Replaced links to archived content with links to current articles</li></ul>
<li>Resources section updated</li>
</ul>
<li>Added a subsection, Accessibility considerations, under 7.2 Write descriptive links to clarify how and when to add additional information inside hyperlinks. This new section integrates the content from section 7.4 Linking to non-government content.</li>
<li>Added quick reference links to help users find information related to abbreviations. This includes:
<ul>
<li>how to abbreviate, punctuate and format titles, degrees and distinctions with personal names (eg. PhD, Ph.D. Dr.)</li>
<li>styles of address and honorific titles</li>
</ul>
</li>
<li>Updated 4.4 Abbreviations and acronyms to specify that abbreviations should be accompanied by their long form the first time they’re used on a page.</li>
<h2>December 12, 2023</h2>
<ul class="mrgn-tp-lg">
<li>added a separate page for the update history for the Canada.ca Content Style Guide</li>
Expand Down