Skip to content

Commit

Permalink
Merge pull request #971 from w3c/update-translation-guidance
Browse files Browse the repository at this point in the history
Update Translation Technical Steps
  • Loading branch information
remibetin authored Nov 19, 2024
2 parents 0a78fe8 + 9b3f1f2 commit 23fdd3b
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions pages/about/translating/resources/technical-steps.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "How to Translate a WAI Resource"
nav_title: New translation
nav_title: Technical Steps
lang: en
last_updated: 2024-05-27
last_updated: 2024-11-19
description: Help make the Web accessible to people with disabilities around the world. We appreciate your contributions to translating W3C WAI accessibility resources.

permalink: /about/translating/resources/technical-steps/
Expand Down Expand Up @@ -112,14 +112,12 @@ lang: en
last_updated: 2020-04-28

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

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>
---
Expand All @@ -133,10 +131,6 @@ footer: >
`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.

Expand All @@ -145,18 +139,19 @@ footer: >

`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.
### 2.2. Add translation information

Policy for names and links is introduced in [Translating WAI Resources]({{ "/about/translating" | relative_url }}#links).
After `last_updated` (that corresponds to the date of the English version), add these lines:

{::nomarkdown}
{% include box.html type="start" %}
{:/}
```yaml

translation:
last_updated: 2000-00-00

translators:
- name: "Your Name"
contributors:
Expand All @@ -167,7 +162,13 @@ contributors:
{% include box.html type="end" %}
{:/}
Or, if the lines are there with "`#`" before them to comment them out: delete the # and the space.
`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).

`translators` and `contributors`
- Add information depending on how many translators there are, and if there are contributors. Policy for names and links is introduced in [Translating WAI Resources](/about/translating/#links).\
- If the lines are present and commented out with "`#` " before: delete the # and the space.

{::nomarkdown}
{% include box.html type="start" title="Updated front matter for a translation into French" %}
Expand All @@ -182,7 +183,10 @@ Show example
---
title: Evaluation Tools Overview
lang: fr
last_updated: 2023-09-13
last_updated: 2020-04-28
translation:
last_updated: 2024-11-11
translators:
- name: "Your Name"
Expand All @@ -191,14 +195,12 @@ contributors:
- name: "Other Name"
github:
repository: w3c/wai-eval-tools-overview
path: "content/index.fr.md"
label: wai-evaluation-tools
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>
---
Expand Down

0 comments on commit 23fdd3b

Please sign in to comment.