Creating a New Translation

Initial steps

Before starting:

Find the language short code “subtag” from Language Subtag Registry . You will use it at multiple times during the 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 “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

Follow Translation guidance to translate the main content of the page.