How to Translate a WAI Resource

Overview

There are 4 main technical steps to create a new WAI resource translation:

Create a new file
Update the “front matter” metadata
Translate the main content
Commit your changes and open a Pull Request

General guidance

Do not change or adapt or add to the meaning of the English version in your translation.
If you have suggestions for changes to the English version, submit them via GitHub or e-mail using the links in the “Help improve this page” box near the bottom of the page.
Before starting, find the language short code “subtag” from Language Subtag Registry . You will use it at multiple times during the translation.
The markdown files are very sensitive to indentation, commas, quotes, and special characters. We recommend that you use a markdown editor or a simple text editor (including GitHub interface) — and not a document editor like Microsoft Word that often changes quotes and indentation.
Some resources have specific Translations notes. If you see a comment such as “Read Translations Notes at” in the “front matter” metadata, follow the link and read the specific guidance.
If you wish to translate the WCAG-EM Report Tool, please read this specific guidance , as different steps have to be followed.

Initial step: Declare your intent

In accordance with the WAI Translations process, please always declare your intent and wait for reply from WAI team before starting a translation.

Step 1: Create a new file

Duplicate the file used by the original version, with the language shortcode added to the middle of the filename, as follows:

Step 2: Update the “front matter” metadata

At the top of WAI website files are some metadata, also known as “front matter”.

Your first step into the file is to update this section.

Example of front matter (this may differ on your file)

---
title: Evaluation Tools Overview
lang: en
last_updated: 2020-04-28

github:
  repository: w3c/wai-eval-tools-overview
  path: "content/index.md"

permalink: /test-evaluate/tools/
ref: /test-evaluate/tools/

footer: >
   <p><strong>Date:</strong> Updated 28 April 2020.</p>
   <p><strong>Editor:</strong> <a href="https://www.w3.org/People/Shawn/">Shawn Lawton Henry</a>.</p>
   <p>Video developed by the Education and Outreach Working Group (<a href="http://www.w3.org/WAI/EO/">EOWG</a>) with support from the <a href="https://www.w3.org/WAI/about/projects/wai-guide/">WAI-Guide</a> project funded by the European Commission (EC) under the Horizon 2020 program (Grant Agreement 822245). <a href="./acknowledgements/">Acknowledgements</a>.</p>
---

General instructions for front matter

2.1. Update the following front matter values:

lang

Replace the original value (en) with the language shortcode of your translation.

last_updated

Change last_updated: 2000-00-00 to the date you finish the translation.
Use the format: YYYY-MM-DD (with month in the middle).

path (below github)

Add the language shortcode at the middle of the filename.

permalink

Add the language shortcode at the end of the permalink, with no / at the end.

footer (not always present)

If this attribute is present, translate its content.
Do not change the dates in this section. Those dates should be the same in your translation as in the English version.

2.2. Add translators & contributors names.

After last_updated, add these lines, depending on how many translators there are and if there are contributors.

Policy for names and links is introduced in Translating WAI Resources.

Or, if the lines are there with “#” before them to comment them out: delete the # and the space.

Updated Example

Updated front matter for a translation into French

Show example

---
title: Evaluation Tools Overview
lang: fr
last_updated: 2023-09-13

translators:
  - name: "Your Name"
contributors:
  - name: "Other Name"
  - name: "Other Name"

github:
  repository: w3c/wai-eval-tools-overview
  path: "content/index.fr.md"

permalink: /test-evaluate/tools/fr
ref: /test-evaluate/tools/

footer: >
  <p><strong>Date :</strong> Mise à jour : 28 avril 2020.</p>
  <p><strong>Rédactrice :</strong> <a href="https://www.w3.org/People/Shawn/">Shawn Lawton Henry</a>.</p>
  <p>Vidéo créée par le groupe de travail Éducation et Promotion (<a href="http://www.w3.org/WAI/EO/">EOWG</a>) avec le soutien du projet <a href="https://www.w3.org/WAI/about/projects/wai-guide/">WAI-Guide</a> financé par la Commission européenne (CE) dans le cadre du programme Horizon 2020 (convention de subvention n°822245) <a href="./acknowledgements/">Remerciements</a>.</p>
---

Follow additional inline instructions

Many resources have inline instructions in the front matter (after the “#” character).

Please follow these instructions. It will help you know what to translate/update and what to not change.

Step 3: Translate main content

Markdown/Code

Please leave the code, HTML, and markdown as is without changing it.

Make sure to:

Translate titles in the markdown, such as “Summary” in:

Translate image alternative text, such as “mouse crossed out” in:
- in Markdown: ![mouse crossed out](https://www.w3.org/WAI/intro/no-mouse.png)
- in HTML: <img src="https://www.w3.org/WAI/intro/no-mouse.png" alt="mouse crossed out" />
Make sure that the quote marks stay as is, and are not converted to “smart quotes” by word processing software.

Specific wording

Check other translations in your language to see how similar words and concepts have been translated. In particular, Authorized Translations have had significant review and input.
Read the General Translation Glossary and see if there is a glossary for your language .
Consider different dialects. Where possible, the translation should use words and phrases that will be best understood across different areas.

Videos & Images

If the page has videos, refer to How to Create Translated Video Subtitles and Descriptions
If the page has images with text, refer to How to Translate Images

Step 4: Commit your changes and open a Pull Request

Commit your changes and follow instructions in Step-by-Step Guide to Translating WAI Resources.

We are here to help

If you have any questions about the translation, please report them in the related GitHub issue so that WAI team and other volunteers can help. Alternatively, send an e-mail to the publicly-archived public-wai-translations@w3.org mailing-list.

We are happy to help you decide on the best translated wording by sharing the considerations and nuances that went into choosing the wording for the English page.