This is an unpublished draft preview that might include content that is not yet approved. The published website is at w3.org/WAI/.

Translations

Prepare a Resource for Translations

Frontmatter Checklist

Update Translations Priorities

Priorities for Translating WAI Resources are listed in the Step-by-Step Guide to Translating WAI Resources and in Translations Sitemaps.

To update the priorities list:

  1. Navigate to the wai-website-data repository.
  2. Update the translations-priorities.yml file as follows:
    • url = ref of the resource.
    • Arrange lines in the order you want them to appear in the priorities list.
    • If you want the subpages of a resource to be displayed, list their urls in a pages section.

Add Translations Sitemaps

New Translations Sitemaps can easily be created.

To add a new translation sitemap:

  1. Navigate to the wai-about-wai repository.
  2. In the _about/translating/sitemaps/ folder, duplicate an existing sitemap.
  3. Name the new file as follows: sitemap-<language subtag>.md
  4. Update the following frontmatter parameters:
    • title
      Update language name. Example: “Spanish Translations Progress”
    • nav_title
      Update language name. Example: “Spanish”
    • github > path
      Update filename. Example: _about/sitemaps/sitemap-es.md
    • permalink
      Update language subtag. Example: /about/translating/sitemaps/sitemap-es/
    • ref
      Update language subtag. Example: /about/translating/sitemaps/sitemap-es/
    • tlang
      Update language subtag.
    • Note: Do not update lang parameter (the language used in the page is still English).
  5. For the new page to appear in the secondary menu, add this new page in navigation.yml, in wai-website-data repository.
  6. When published, Translations Sitemaps list will automatically be updated.

“All WAI Translations” Page

This page lists translations of the following items:

Logic is directly coded in translations.md .

WAI Website Resources

Most translations hosted on WAI website are automatically listed.

If a translation is not shown, check the presence of the following parameters in the resource frontmatter:

To group parts of a multi-page resource in the list:

  1. In the main page of the resource, add and adapt the following parameters in the frontmatter:

  2. In other resource pages, add the main page ref in the frontmatter:

Manually Added Translations

Some stand-alone resources are not automatically listed in All WAI Translations page.

To manually add those translations to the list:

  1. Navigate to the wai-website repository.
  2. In translations.md frontmatter, update other_resources metadata as follows:

Accessibility Standards Translations

Accessibility standards translations must be manually listed.

To manually add accessibility standards translations:

  1. Navigate to the wai-website repository.
  2. In translations.md frontmatter, update translated_standards metadata as follows:

Video Subtitles

Information is pulled from video-metadata.yml file. This includes in particular:

Notes:

Technical Details

Translated Pages in Header

When a page has been translated into one or more languages, links to these translations are displayed at the top of the page. This part is managed by _includes/header.html

Features:

WAI Markdown Extension automatically modifies links to WAI website internal links, based on the following rules.

The extension looks for a translated version of the linked-to page: that is, a page sharing the same lang as the current page, and the same ref as the linked-to page:

Link text is defined as follows:

Back to Top

This is an unpublished draft preview that might include content that is not yet approved. The published website is at w3.org/WAI/.