Skip to content

Commit

Permalink
Tip sheets - third try (#629)
Browse files Browse the repository at this point in the history
* Made the tip sheet pages in en and fr for creating accessible documents

* Added the 'updatesMain' tag in the front matter of the changed pages

* made the landing page for tipsheets in FR and EN

* Changed the tag"updatesMain" to "msTips" for the tip sheets

* Rectify some errors in tag

* Made some changes in tag and subjects

* Initial commit

* Tip sheet - Accessible Word document

* Tip sheet - Accessible Outlook Email

* Brought page down for the time being as Excel document is not ready

* Tip sheet - Accessible Powerpoint Presentation

* Added additional content on Email Signatures to Outlook tip sheet

* Removed Excel tip sheets

* Redundant table instructions removed in PPT tip sheet

* Capitalised the Ms in Microsoft

* Refactored common frontmatter data to folder-level JSON

- Moved common frontmatter data (tags and subject fields) from individual Markdown files to ms-office-tip-sheets.json.
- Added "msTips" to the tags array.
- Added "howTos" and "createDocument" to the subject array.

* Update descriptions to pages

---------

Co-authored-by: DESKTOP-5O5JLC2\Dhruv Patel <[email protected]>
Co-authored-by: Oceane Leung <[email protected]>
  • Loading branch information
3 people authored Aug 30, 2024
1 parent 51f7e5b commit 360056b
Show file tree
Hide file tree
Showing 13 changed files with 828 additions and 2 deletions.
2 changes: 2 additions & 0 deletions src/_data/tagList.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ module.exports = {
contactUs: "Contactez-nous",
accessibilityInYourRole: "L'accessibilité dans votre rôle",
mainAbout: "Section à propos de nous sur la page d'accueil",
msTips : "Fiches de conseils pour Microsoft Office",
office2016:
"Comment créer des documents accessibles dans Office 2016",
microsoft365:
Expand All @@ -46,6 +47,7 @@ module.exports = {
accessibilityInYourRole: "Accessibility in your role",
mainAbout: "About us section on homepage",
office2016: "How to create accessible documents in Office 2016",
msTips: "Tip sheets for Microsoft Office",
microsoft365: "How to create accessible documents in Microsoft 365",
},
},
Expand Down
32 changes: 32 additions & 0 deletions src/main/en/how-tos/ms-office-tip-sheets.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Tip sheets for Microsoft office
description: Learn to identify and correct common accessibility issues in the Microsoft office suite of software.
toggle: fiches-de-conseils-pour-microsoft-office
tags:
- createDocument
- updatesMain
---

{% if collections.msTips === undefined %}

{% include "partials/alert-landingpages.njk" %}

{% else %}

<div class="row wb-eqht mrgn-tp-lg gc-drmt">
{% for item in collections.msTips | sort(false, false, 'data.title') | localeMatch(locale) %}
{% if item.data.tags[1] != "msTips" %}
<div class="col-md-6">
<h3><a href="{{ item.url }}">{{ item.data.title | safe }}</a></h3>
<p>
{% if item.data.description %}
{{ item.data.description | safe }}
{% else %}
{{ landingPage[locale].descriptionNoneText }}
{% endif %}
</p>
</div>
{% endif %}
{% endfor %}
</div>
{% endif %}
32 changes: 32 additions & 0 deletions src/main/fr/comment-faire/fiches-conseils-ms-office.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Fiches de conseils pour Microsoft Office
description: Apprendre à identifier et à corriger les problèmes d’accessibilité courants dans la suite logicielle Microsoft Office.
toggle: tip-sheets-for-microsoft-office
tags:
- createDocument
- updatesMain
---

{% if collections.msTips === undefined %}

{% include "partials/alert-landingpages.njk" %}

{% else %}

<div class="row wb-eqht mrgn-tp-lg gc-drmt">
{% for item in collections.msTips | sort(false, false, 'data.title') | localeMatch(locale) %}
{% if item.data.tags[1] != "msTips" %}
<div class="col-md-6">
<h3><a href="{{ item.url }}">{{ item.data.title | safe }}</a></h3>
<p>
{% if item.data.description %}
{{ item.data.description | safe }}
{% else %}
{{ landingPage[locale].descriptionNoneText }}
{% endif %}
</p>
</div>
{% endif %}
{% endfor %}
</div>
{% endif %}
2 changes: 1 addition & 1 deletion src/pages/en/microsoft-document-compliance-checklist.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Microsoft Document Compliance Checklist
title: Microsoft document compliance checklist
description: Here you can find different questions to help you to know if your Word document is accessible or not.
toggle: liste-de-verification-de-la-conformite-des-documents-microsoft
subject:
Expand Down
9 changes: 9 additions & 0 deletions src/pages/en/ms-office-tip-sheets/ms-office-tip-sheets.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"tags": [
"msTips"
],
"subject": [
"howTos",
"createDocument"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
title: Tip sheet for Microsoft PowerPoint Presentation
description: Easily reference accessible best practices for PowerPoint creation.
toggle: feuille-de-conseils-pour-la-presentation-microsoft-powerpoint
---
# Create accessible presentations in PowerPoint
Version 1.3 | March 2024

## Slide Master
As much as possible, format your slides using the **Slide Master** tab. To open this tab, select:
1. **View tab**
2. **Master Views** group (if necessary)
3. **Slide Master**.

When existing slide layouts do not meet your needs, add a new layout. Select the **Insert Layout**, then add **Content** placeholders as needed with the **Insert Placeholder**.

**Avoid** adding content from the **Insert** tab.

## Pasting text
When pasting content from another source:
1. place cursor in desired location
2. press <kbd>Shift</kbd> + <kbd>F10</kbd> (or right-click)
3. press <kbd>T</kbd> (or under **Paste options**, select **Keep Text Only**).

To insert a layout from the **Slide Master** tab, select:
1. **Edit Master** group (if necessary)
2. **Insert Layout**.

To add a placeholder from the **Slide Master** tab, select:
1. **Master Layout** group (if necessary)
2. **Insert Placeholder** menu
3. Specify your placeholder type.

**Warning**: Every slide layout must include a Title placeholder and content placeholder. Do not use the slide number placeholders. To add slide numbers, select **Slide Master** tab, then a **Slide layout**. Select Insert tab > **Text** Box. Type "Slide ". Select **Insert** tab > **Text** group > **Slide Number**. Type "of" and then the total number of slides. Copy this text box to the slide layouts in your presentation. It's best to add the slide numbers after finalizing your presentation.

## Slide titles
Every slide must have a **unique** slide title. If content continues onto the next slide, add “(1 of 2)” to the end of the title.

## Fonts and sizing
Use **sans serif** fonts (such as **Arial**) instead of serif fonts (such as **Times New Roman**). Title font size of 24 pt or greater and body font size of 18 pt or greater.

## Formatting text
**Use left alignment** for your text content. Avoid using justified text.

To increase spacing between lines of text use the **Paragraph** dialogue box’s **Before**, **After** and **Line Spacing fields**. **Do not** press the **Enter** key to add extra spacing.

## Links
**Always** use meaningful link text so your reader knows where the link takes them like “<u>Shared Services Canada</u>”; instead of “Click here”.
Printed PowerPoint presentations must also display the URL.

## Images
All images require descriptive alternative text (Alt Text). It must convey the meaning of the image. If an image is decorative, type “Decorative”.

To access the **Alt Text** panel:
1. select the image
2. press <kbd>Shift</kbd> + <kbd>F10</kbd> (or right-click)
3. select **View Alt Text**.

Complex images (like graphs and charts) require an alternative text and a long description containing all the image information, such as data and trends.

**Things to avoid :**:
- images of text;
- SmartArt;
- grouped objects.

## Tables
- Use tables for data only.
- Define all tables. Select **Table Design** tab > **Table Style Options** group (if necessary) > **Check** all relevant options. **Header Row** is mandatory.

**Things to avoid :**
- the **Draw Table** tool
- screenshots or an image of a table
- merged or split cells
- nested tables
- empty cells
- non-text objects into cells.

## Media
For **audio** content:
1. transcriptions are mandatory
2. subtitles are optional
3. audio descriptions are optional.

For **video** content:
1. subtitles are mandatory
2. audio descriptions are mandatory if some of the information is visual only
3. transcriptions are mandatory if videos include interactive elements.

**Avoid** using interactive elements, animations and other visual effects.

## Colour and contrast
When adding colours to a presentation, stick to the **Automatic** colour and **Theme Accent** colours. Users can easily reduce barriers by applying custom colours that meet their needs (using **Design** tab > **Variants** group).

Make sure there is sufficient contrast between the text and the background.
Information must be conveyed using more than colour alone. For example, add a border or a different shape.

**Things to avoid :**
- background images
- placing text on top of an image.

## Reading order
Reading order is the natural order your eyes would follow when looking at a slide. Make sure the reading order of each slide is correct by clicking just outside the slide, then using the **Tab** key to cycle through the content. This shows what the current order your content is in.

Correct reading order issues in the **Reading Order** pane or in the **Selection** pane (for Office versions older than 365).

## Languages
Specify the proofing language for each slide. Select:
1. all slide objects (press <kbd>Ctrl</kbd> + <kbd>A</kbd>)
2. **Review** tab
3. **Language** group (if necessary)
4. **Language** menu
5. **Set proofing language**.

Avoid creating bilingual documents, as this reduces their accessibility.

## Accessibility check
To run the accessibility checker, select:
1. **Review** tab
2. **Accessibility** group
3. **Check accessibility**.
4. Check the **Keep accessibility checker running while I work** option.

The accessibility checker is a great start, but it won’t catch every single issue.

## Presenting
When presenting, describe any important visual elements shown on each slide.

## PowerPoint to PDF
**Note**: Most PDF files are not accessible. When possible, share the PowerPoint presentation. If you must create a PDF version of your presentation:
1. Press <kbd>Alt</kbd>, <kbd>F</kbd>, <kbd>E</kbd>, <kbd>A</kbd> or select **File** tab > **Export** menu > **Create PDF/XPS Document** submenu > **Create PDF/XPS**.
2. In the **Publish as PDF or XPS** dialogue box, select **Options** button.
3. In the **Options** dialogue box, **check** all boxes under **Include non-printing information**.
4. Press **OK**.
5. select **Publish**.
123 changes: 123 additions & 0 deletions src/pages/en/ms-office-tip-sheets/tip-sheet-microsoft-word.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
title: Tip sheet for Microsoft Word
description: Quick reference to accessible best practices for Word documents.
toggle: feuille-de-conseils-pour-microsoft-word
---

# Create accessible documents in Word
Version 1.3 | March 2024

## Pasting text
When pasting content from another source:
1. place cursor in desired location
2. press <kbd>Shift</kbd> + <kbd>F10</kbd> (or right-click)
3. press <kbd>T</kbd> (or under **Paste options**, select **Keep Text Only**).

## Writing content
- Write short sentences.
- Use simple and common word; instead of jargon or ‘impressive’ vocabulary.
- Define abbreviations on first use, for example: Shared Services Canada (SSC).
- Use **Sentence case** instead of Title Case or ALL CAPS, even for headings.
- In French, include accents on capitals.
- After specifying proofing languages, use the **Proofing** tools on the **Review** tab.

## Headings
- Organize documents using the **Home** tab > **Style** group > **Heading** styles. For example, **Heading 1, Heading 2, Heading 3** in **ascending order**.
- Each heading must be unique and descriptive.

## Formatting content
- Format content by applying **Styles**; instead of the direct formatting commands in the **Fonts** group, for example:
- apply **Strong** style; instead of **Bold**;
- apply *Emphasis* style; instead of *Italic*.
- Select simple sans-serif fonts, like Arial, from the **Design** tab > **Fonts** menu.
- On the **Home** tab’s **Styles** group, select font type ending with:
- “(Heading)” for **Heading** styles;
- “(Body)” for all **other** styles.
- Format **Styles** to **Align Left**; instead of **Center**, **Right** or **Justify**.
- Align text using paragraph **Indentations** and **Tabs** instead of adding several spaces.
- Format **Styles** with **Before** and **After** paragraph spacing instead of adding empty paragraph returns (Enter key).
- To view extra returns and spaces, press <kbd>Alt</kbd>, <kbd>H</kbd>, **(ZP)**, <kbd>8</kbd>; or select **Home** tab > **Paragraph** group (if necessary) > **Show/Hide** paragraph marks (****).
- To move a paragraph to the following page, insert a page break by pressing <kbd>Ctrl</kbd> + <kbd>Enter</kbd>; instead of adding empty paragraph returns (Enter key).



## Lists
From the **Home** tab use:
- **Bullets** for unordered lists.
1. **Numbering** for ordered lists.

## Links
- **Always** use meaningful link text so your reader knows where the link takes them like “<u>Shared Services Canada</u>”; instead of “Click here” or “learn more.”
- Printed Word documents must also display the URL.
- **Do not add** hyperlinks to images.

## Images
All images must have the **Layout Option** set to **In Line with Text** (unless decorative). Select the image; press <kbd>Shift</kbd> + <kbd>F10</kbd> (or right-click); select **Wrap Text**; then select **In Line with Text.**

All images require descriptive alternative text (Alt Text). It must convey the meaning of the image. If an image is decorative, type “Decorative”.

To access the **Alt Text** panel:
1. select image
2. press <kbd>Shift</kbd> + <kbd>F10</kbd> (or right-click)
3. select **View Alt Text**

**Note:** Alt text should be fewer than 120 characters.

Complex images (like graphs and charts) require **Alt Text** and a **Long description** containing all the image information, such as data and trends.

**Things to avoid** :
- Images of text
- SmartArt
- grouped objects

## Tables
- Use tables for data only.
- Define all tables. Select **Table Design** tab > **Table Style Options** group (if necessary) > **Check** all relevant options. **Header Row** is mandatory.
- Instead of adding alternative text to **Table Properties** dialogue box, insert your title in the line above the table. Select **References** tab > **Insert Caption** > change the label option to “**Table**” > then enter the title after the number.

**Things to avoid** :
- the **Draw Table** tool
- screenshots or images of tables
- merged or split cells
- nested tables
- empty cells
- non-text objects into cells.

## Media
**Avoid** adding audio, video or animations into a Word document.

## Colour and contrast
When adding colours to a document, stick to the **Automatic** colour and **Theme Accent** colours. Users can easily reduce barriers by applying custom colours that meet their needs (using **Design** tab > **Colors** menu).

Make sure there is sufficient contrast between the text and the background.
Information must be conveyed using more than colour alone. For example, add a border or a different shape.

**Things to avoid** :
background images

## Languages
Create separate documents for each language to maximize accessibility. If you must create a multilingual document, use **Word for desktop** to set the proofing language:
1. Select all paragraphs (press <kbd>Ctrl</kbd> + <kbd>A</kbd>);
2. Press <kbd>Alt</kbd>, <kbd>R</kbd>, **(ZL)**, <kbd>U</kbd>, <kbd>L</kbd> or
select **Review** tab > **Language** group (if necessary) > **Language** menu > **Set proofing language**.

Set the language of paragraphs based on their language.

## Accessibility check
To run the accessibility checker, select:
1. **Review** tab
2. **Accessibility** group
3. **Check accessibility**
4. Check the **Keep accessibility checker running while I work** option.

The accessibility checker is a great start, but it won’t catch every issue.

## Word to PDF
**Note:** Most PDF files are not accessible. When possible, share your Word document.

If you must create a PDF version of your document:
1. Press <kbd>Alt</kbd>, <kbd>F</kbd>, <kbd>E</kbd>, <kbd>A</kbd> or select **File** tab > **Export** menu > **Create PDF/XPS Document** submenu > **Create PDF/XPS**
2. From the **Publish as PDF or XPS** dialogue box, select the **Options** button
3. From the **Options** dialogue box, **check** all options in **Includes non-printing information**
4. Press **OK**
5. Select **Publish**.
Loading

0 comments on commit 360056b

Please sign in to comment.