Make "WCAG 2 Overview" & "New in WCAG 2.2" ready for translations (#254)

* Make WCAG 2 Overview ready for translations * Make New in WCAG 2.2 ready for translations
w3c · Nov 7, 2023 · ba5e8e3 · ba5e8e3
1 parent 329c214
commit ba5e8e3
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 48 deletions.
diff --git a/content/index.es.md b/content/index.es.md
@@ -1,27 +1,35 @@
 ---
+# Translation instructions are after the "#" character in this first section. They are comments that do not show up in the web page. You do not need to translate the instructions after "#".
+# In this first section, do not translate the words before a colon. For example, do not translate "title:". Do translate the text after "title:".
+
 title: "Introducción a las Pautas de Accesibilidad para el Contenido Web (WCAG)"
 nav_title: "Contenido Web – WCAG"
-
-description: Introduce el estándar internacional de las Pautas de Accesibilidad para el Contenido Web (WCAG), lo cual incluye WCAG 2.0 y WCAG 2.1. Los documentos WCAG explican cómo hacer contenido web más accesible para las personas con discapacidad.
-
 lang: es
-last_updated: 2019-07-05
-permalink: /standards-guidelines/wcag/es
+last_updated: 2019-07-05  # Put the date of this translation YYYY-MM-DD (with month in the middle)
+
 translators: 
 - name: "Carlos Muncharaz"
   link: "http://www.muncharaz.eu/"
 
 github:
   repository: w3c/wai-intro-wcag
-  path: 'content/index.es.md'
+  path: 'content/index.es.md' # Add the language shortcode to the middle of the filename, for example: content/index.fr.md
 
+permalink: /standards-guidelines/wcag/es  # Add the language shortcode to the end, with no slash at end, for example: /link/to/page/fr
+ref: /standards-guidelines/wcag/  # Do not change this
+
+description: Introduce el estándar internacional de las Pautas de Accesibilidad para el Contenido Web (WCAG), lo cual incluye WCAG 2.0 y WCAG 2.1. Los documentos WCAG explican cómo hacer contenido web más accesible para las personas con discapacidad.
+image: /content-images/wai-intro-wcag/wcag-intro-social.jpg
+feedbackmail: wai@w3.org
+
+# In the footer below:
+# Do not change the dates
+# Translate the other words below, including "Date:" and "Editor:"
+# Translate the Working Group name. Leave the Working Group acronym in English.
 footer: >
   <p><strong>Fecha:</strong> Actualizado el 22 de junio del 2018. Primera publicación en julio del 2005.</p>
   <p><strong>Editora:</strong> <a href="http://www.w3.org/People/Shawn/">Shawn Lawton Henry</a>.</p>
   <p>Desarrollado con la colaboración del Grupo de Trabajo de Educación y Difusión (<a href="https://www.w3.org/WAI/about/groups/eowg/">EOWG</a>) y el Grupo de Trabajo de las Pautas de Accesibilidad (<a href="https://www.w3.org/WAI/about/groups/agwg/">AG WG</a>).</p>
-image: /content-images/wai-intro-wcag/wcag-intro-social.jpg
-feedbackmail: wai@w3.org  
-ref: /standards-guidelines/wcag/
 ---
 
 {::nomarkdown}

diff --git a/content/index.fr.md b/content/index.fr.md
@@ -1,27 +1,34 @@
 ---
+# Translation instructions are after the "#" character in this first section. They are comments that do not show up in the web page. You do not need to translate the instructions after "#".
+# In this first section, do not translate the words before a colon. For example, do not translate "title:". Do translate the text after "title:".
+
 title: "Vue d'ensemble des Règles pour l'accessibilité des contenus Web,  (WCAG)"
 nav_title: "Web Content – WCAG"
-
-description: Présente le standard international des Règles pour l'accessibilité des contenus web, (WCAG), y compris 2.0 et WCAG 2.1. Les documents des WCAG expliquent comment rendre les contenus web plus accessibles aux personnes handicapées.
-
 lang: fr
-last_updated: 2021-04-06
-permalink: /standards-guidelines/wcag/fr
-translators: 
-- name: "Sylvie Duchateau"
+last_updated: 2021-04-06  # Put the date of this translation YYYY-MM-DD (with month in the middle)
+
+translators:
+  - name: "Sylvie Duchateau"
 
 github:
   repository: w3c/wai-intro-wcag
-  path: 'content/index.fr.md'
+  path: 'content/index.fr.md' # Add the language shortcode to the middle of the filename, for example: content/index.fr.md
+
+permalink: /standards-guidelines/wcag/fr  # Add the language shortcode to the end, with no slash at end, for example: /link/to/page/fr
+ref: /standards-guidelines/wcag/  # Do not change this
 
+description: Présente le standard international des Règles pour l'accessibilité des contenus web, (WCAG), y compris 2.0 et WCAG 2.1. Les documents des WCAG expliquent comment rendre les contenus web plus accessibles aux personnes handicapées.
+image: /content-images/wai-intro-wcag/wcag-intro-social.jpg
+feedbackmail: wai@w3.org
+
+# In the footer below:
+# Do not change the dates
+# Translate the other words below, including "Date:" and "Editor:"
+# Translate the Working Group name. Leave the Working Group acronym in English.
 footer: >
   <p><strong>Date :</strong> Mis à jour le 3 avril 2021. Première publication en juillet 2005.</p>
   <p><strong>Auteure :</strong> <a href="http://www.w3.org/People/Shawn/">Shawn Lawton Henry</a>.</p>
   <p>Développé avec la contribution du Groupe de travail Éducation et Promotion (<a href="https://www.w3.org/WAI/about/groups/eowg/">EOWG</a>) et le Groupe de travail en charge des règles d'accessibilité (<a href="https://www.w3.org/WAI/about/groups/agwg/">AG WG</a>).</p>
-image: /content-images/wai-intro-wcag/wcag-intro-social.jpg
-feedbackmail: wai@w3.org  
-ref: /standards-guidelines/wcag/
-
 ---
 
 {::nomarkdown}

diff --git a/content/index.md b/content/index.md
@@ -1,27 +1,39 @@
 ---
+# Translation instructions are after the "#" character in this first section. They are comments that do not show up in the web page. You do not need to translate the instructions after "#".
+# In this first section, do not translate the words before a colon. For example, do not translate "title:". Do translate the text after "title:".
+
 title: "WCAG 2 Overview"
 nav_title: "Web Content – WCAG 2"
+lang: en  # Change "en" to the translated-language shortcode
+last_updated: 2023-10-05  # Put the date of this translation YYYY-MM-DD (with month in the middle)
 
-description: Introduces the Web Content Accessibility Guidelines (WCAG) international standard, including WCAG 2.0, WCAG 2.1, and WCAG 2.2. WCAG documents explain how to make web content more accessible to people with disabilities.
-
-
-lang: en
-last_updated: 2023-10-05
-
-permalink: /standards-guidelines/wcag/
+# translators: # remove from the beginning of this line and the lines below: "# " (the hash sign and the space)
+# - name: "Translator Name Here" # Add one -name: line for every translator
+# - name: "Jan Doe"   # Replace Jan Doe with translator name
+# - name: "Jan Doe"   # Replace Jan Doe with name, or delete this line if not multiple translators
+# contributors:
+# - name: "Jan Doe"   # Replace Jan Doe with contributor name, or delete this line if none
+# - name: "Jan Doe"   # Replace Jan Doe with name, or delete this line if not multiple contributors
 
 github:
   repository: w3c/wai-intro-wcag
-  path: 'content/index.md'
+  path: 'content/index.md'  # Add the language shortcode to the middle of the filename, for example: content/index.fr.md
+
+permalink: /standards-guidelines/wcag/  # Add the language shortcode to the end, with no slash at end, for example: /link/to/page/fr
+ref: /standards-guidelines/wcag/  # Do not change this
 
+description: Introduces the Web Content Accessibility Guidelines (WCAG) international standard, including WCAG 2.0, WCAG 2.1, and WCAG 2.2. WCAG documents explain how to make web content more accessible to people with disabilities.
+image: /content-images/wai-intro-wcag/wcag-intro-social.jpg
+feedbackmail: wai@w3.org
+
+# In the footer below:
+# Do not change the dates
+# Translate the other words below, including "Date:" and "Editor:"
+# Translate the Working Group name. Leave the Working Group acronym in English.
 footer: >
   <p><strong>Date:</strong> Updated 5 October 2023. First published July 2005.</p>
   <p><strong>Editor:</strong> <a href="http://www.w3.org/People/Shawn/">Shawn Lawton Henry</a>.</p>
   <p>Developed with input from the Education and Outreach Working Group (<a href="https://www.w3.org/WAI/about/groups/eowg/">EOWG</a>) and the Accessibility Guidelines Working Group (<a href="https://www.w3.org/WAI/about/groups/agwg/">AG WG</a>).</p>
-image: /content-images/wai-intro-wcag/wcag-intro-social.jpg
-feedbackmail: wai@w3.org  
-ref: /standards-guidelines/wcag/
-
 ---
 
 {::nomarkdown}
@@ -30,13 +42,13 @@ ref: /standards-guidelines/wcag/
 
 This page introduces the Web Content Accessibility Guidelines (WCAG) international standard, including WCAG 2.0, WCAG 2.1, and WCAG 2.2. WCAG documents explain how to make web content more accessible to people with disabilities.
 
-A different page [introduces WCAG 3](https://www.w3.org/WAI/standards-guidelines/wcag/wcag3-intro/).
+A different page [introduces WCAG 3](/standards-guidelines/wcag/wcag3-intro/).
 
 WCAG is not an introduction to accessibility. For introductions, see [Accessibility Fundamentals Overview](/fundamentals/).
 
 Quick links to resources:
 * [How to Meet WCAG 2 (Quick Reference)](http://www.w3.org/WAI/WCAG21/quickref/)
-* [WCAG 2.2 Standard](https://www.w3.org/TR/WCAG22/), [What's New in WCAG 2.2](https://www.w3.org/WAI/standards-guidelines/wcag/new-in-22/)
+* [WCAG 2.2 Standard](https://www.w3.org/TR/WCAG22/), [What's New in WCAG 2.2](/standards-guidelines/wcag/new-in-22/)
 * [WCAG 2.1 Standard](http://www.w3.org/TR/WCAG21/)
 
 {::nomarkdown}
@@ -149,4 +161,4 @@ See the [[WCAG 2 FAQ]](/standards-guidelines/wcag/faq/) for more information on:
 -   **Applying WCAG 2 to [documents and software](/standards-guidelines/wcag/faq/#wcag2ict)**
 -   and more...
 
-For information on the early draft of W3C Accessibility Guidelines 3.0 (formerly known as "Sliver"), see the **[WCAG 3 Introduction](https://www.w3.org/WAI/standards-guidelines/wcag/wcag3-intro/)**.
+For information on the early draft of W3C Accessibility Guidelines 3.0 (formerly known as "Sliver"), see the **[WCAG 3 Introduction](/standards-guidelines/wcag/wcag3-intro/)**.
diff --git a/content/new-in-22.md b/content/new-in-22.md
@@ -1,26 +1,44 @@
 ---
+# Translation instructions are after the "#" character in this first section. They are comments that do not show up in the web page. You do not need to translate the instructions after "#".
+# In this first section, do not translate the words before a colon. For example, do not translate "title:". Do translate the text after "title:".
+
 title: "What's New in WCAG 2.2"
 title_html: "What's New in WCAG 2.2"
 nav_title: "New in 2.2"
+lang: en   # Change "en" to the translated-language shortcode
+last_updated: 2023-10-05  # Put the date of this translation YYYY-MM-DD (with month in the middle)
 
-description: This page lists the new success criteria in Web Content Accessibility Guidelines (WCAG) 2.2. It includes quotes from personas to help you understand some aspects of the success criteria.
-
-teaser_text: WCAG 2.2 has 9 additional requirements ("success criteria") that address the needs of people with cognitive or learning disabilities, mobile devices users, and ebook users. The What’s New in WCAG 2.2 page introduces the new success criteria. It includes quotes from personas to help you understand the issues.
-
-lang: en
-last_updated: 0000-00-00 # update if do translations
-permalink: /standards-guidelines/wcag/new-in-22/
+# translators: # remove from the beginning of this line and the lines below: "# " (the hash sign and the space)
+# - name: "Translator Name Here" # Add one -name: line for every translator
+# - name: "Jan Doe"   # Replace Jan Doe with translator name
+# - name: "Jan Doe"   # Replace Jan Doe with name, or delete this line if not multiple translators
+# contributors:
+# - name: "Jan Doe"   # Replace Jan Doe with contributor name, or delete this line if none
+# - name: "Jan Doe"   # Replace Jan Doe with name, or delete this line if not multiple contributors
 
 github:
   repository: w3c/wai-intro-wcag
-  path: 'content/new-in-22.md'
+  path: 'content/new-in-22.md'  # Add the language shortcode to the middle of the filename, for example: content/index.fr.md
+
+permalink: /standards-guidelines/wcag/new-in-22/  # Add the language shortcode to the end, with no slash at end, for example: /link/to/page/fr
+ref: /standards-guidelines/wcag/new-in-22/  # Do not change this
+
+description: This page lists the new success criteria in Web Content Accessibility Guidelines (WCAG) 2.2. It includes quotes from personas to help you understand some aspects of the success criteria.
+
+teaser_text: WCAG 2.2 has 9 additional requirements ("success criteria") that address the needs of people with cognitive or learning disabilities, mobile devices users, and ebook users. The What’s New in WCAG 2.2 page introduces the new success criteria. It includes quotes from personas to help you understand the issues.
 
 feedbackmail: wai@w3.org
 image: /content-images/wai-intro-wcag/general-social.png
+
+# In the footer below:
+# Do not change the dates
+# Translate the other words below, including "Date:" and "Editor:"
+# Translate the Working Group name. Leave the Working Group acronym in English.
 footer: >
   <p><strong>Date:</strong> Updated 5 October 2023.</p>
   <p><strong>Editor:</strong> <a href="https://www.w3.org/People/Shawn/">Shawn Lawton Henry</a>. Contributors: Mike Gower, Shadi Abou-Zahra,  <a href="https://www.w3.org/groups/wg/eowg/participants">EOWG Participants</a>, and <a href="https://www.w3.org/groups/wg/ag/participants">AG WG Participants</a>.</p>
   <p>Developed with input from the Education and Outreach Working Group (<a href="https://www.w3.org/WAI/about/groups/eowg/">EOWG</a>) and the Accessibility Guidelines Working Group (<a href="https://www.w3.org/WAI/about/groups/eowg/">AG WG</a>).</p>
+
 inline_css: |
   blockquote {font-style: normal !important;}
   blockquote p:first-of-type:before, blockquote p:last-of-type:after, blockquote dl:last-of-type:after {content: '' !important;margin-left: 0 !important;}
@@ -59,9 +77,6 @@ inline_css: |
   #markdown-toc ul li {
     margin-bottom: 0;
   }
-
-ref: /standards-guidelines/wcag/new-in-22/
-
 ---
 
 {::nomarkdown}
@@ -99,7 +114,7 @@ For an introduction to Web Content Accessibility Guidelines (WCAG) and more abou
 
 **WCAG 2.2 provides 9 additional success criteria since WCAG 2.1. They are introduced on this page.**
 
-The 2.0 and 2.1 success criteria are essentially the same in 2.2, with one exception: 4.1.1 Parsing is obsolete and removed from WCAG 2.2. More information is in [WCAG 2 FAQ, 4.1.1 Parsing](https://www.w3.org/WAI/standards-guidelines/wcag/faq/#parsing411). WCAG 2.2 includes Notes about different languages; more information is in [WCAG 2 FAQ, internationalization](https://www.w3.org/WAI/standards-guidelines/wcag/faq/#118n22).
+The 2.0 and 2.1 success criteria are essentially the same in 2.2, with one exception: 4.1.1 Parsing is obsolete and removed from WCAG 2.2. More information is in [WCAG 2 FAQ, 4.1.1 Parsing](/standards-guidelines/wcag/faq/#parsing411). WCAG 2.2 includes Notes about different languages; more information is in [WCAG 2 FAQ, internationalization](https://www.w3.org/WAI/standards-guidelines/wcag/faq/#i18n22).
 
 ## Guideline 2.4 Navigable