- 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.
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:
Make sure that the quote marks stay as is, and are not converted to “smart quotes” by word processing software.
Most links are formatted with single or double brackets and parentheses; for example:
Just so you know:
- When we want the system to use the title of the linked-to page as link text, we use
- That way, when the linked-to page is translated, the system will use the translated page’s title.
- If the linked-to page is not translated, the system will use your translated text between the brackets, and add
(in English)in the translated language at the end of the link.
- When we want to use custom link text, we use
Make sure to:
- Keep brackets and parentheses together, with no space between the closing
]and the opening
- Keep double
[[or single brackets
[as they are.
- Translate the text in the links, including document titles.
- Do not manually add
(in English), even for external links.
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.
At the top of the resource file (in the “front matter” metadata), see if there is a comment like this one:
In that case, follow the link and read the specific guidance.
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 email@example.com 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.Back to Top