CINXE.COM

How to Translate a WAI Resource | Web Accessibility Initiative (WAI) | W3C

<!DOCTYPE html> <html class="no-js" lang="en" dir="ltr" prefix="og: http://ogp.me/ns#"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <script> document.documentElement.className = document.documentElement.className.replace('no-js', 'has-js'); function downloadJSAtOnload() { var element = document.createElement("script"); element.src = "/WAI/assets/scripts/main.js?1732321439590790613"; document.body.appendChild(element); } window.addEventListener("load", downloadJSAtOnload, false); </script> <link rel="stylesheet" href="/WAI/assets/css/style.css?1732321439590790613"> <title> How to Translate a WAI Resource | Web Accessibility Initiative (WAI) | W3C</title><!-- Begin Jekyll SEO tag v2.8.0 --> <meta name="generator" content="Jekyll v4.3.3" /> <meta property="og:title" content="How to Translate a WAI Resource" /> <meta name="author" content="W3C Web Accessibility Initiative (WAI)" /> <meta property="og:locale" content="en" /> <meta name="description" content="Help make the Web accessible to people with disabilities around the world. We appreciate your contributions to translating W3C WAI accessibility resources." /> <meta property="og:description" content="Help make the Web accessible to people with disabilities around the world. We appreciate your contributions to translating W3C WAI accessibility resources." /> <link rel="canonical" href="https://www.w3.org/WAI/about/translating/resources/technical-steps/" /> <meta property="og:url" content="https://www.w3.org/WAI/about/translating/resources/technical-steps/" /> <meta property="og:site_name" content="Web Accessibility Initiative (WAI)" /> <meta property="og:image" content="https://www.w3.org/WAI/content-images/about/social-translations.png" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://www.w3.org/WAI/content-images/about/social-translations.png" /> <meta property="twitter:title" content="How to Translate a WAI Resource" /> <meta name="twitter:site" content="@w3c_wai" /> <meta name="twitter:creator" content="@W3C Web Accessibility Initiative (WAI)" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","author":{"@type":"Person","name":"W3C Web Accessibility Initiative (WAI)"},"description":"Help make the Web accessible to people with disabilities around the world. We appreciate your contributions to translating W3C WAI accessibility resources.","headline":"How to Translate a WAI Resource","image":"https://www.w3.org/WAI/content-images/about/social-translations.png","url":"https://www.w3.org/WAI/about/translating/resources/technical-steps/"}</script> <!-- End Jekyll SEO tag --> <link rel="alternate" type="application/rss+xml" href="/WAI/feed.xml"> </head> <body id="top" class="page-how-to-translate-a-wai-resource "> <nav aria-label="Skip Link and Language Selector" id="controls" class="default-grid"> <ul> <li><a href="#main">Skip to Content</a></li> <li class="opt"> <a href="/WAI/meta/customize/">Change Text Size or Colors</a> </li> <li class="opt"> <a href="/WAI/translations/">All Translations <svg focusable="false" aria-hidden="true" class="icon-translations "><use xlink:href="/WAI/assets/images/icons.svg#icon-translations"></use></svg></a> </li> </ul></nav> <header id="site-header" class="default-grid with-gap"> <div class="logos"> <a lang="en" class="home w3c" href="https://www.w3.org/"> <svg role="img" aria-label="W3C" viewBox="0 0 68 34" xmlns="http://www.w3.org/2000/svg"><g><path d="m16.117 1.006 5.759 19.58 5.759-19.58h4.17 11.444v1.946l-5.879 10.128c2.065.663 3.627 1.868 4.686 3.615 1.059 1.748 1.589 3.799 1.589 6.155 0 2.914-.775 5.363-2.324 7.348s-3.555 2.978-6.017 2.978c-1.854 0-3.469-.589-4.845-1.767-1.377-1.178-2.396-2.773-3.058-4.786l3.256-1.35c.477 1.218 1.106 2.178 1.887 2.879.781.702 1.701 1.052 2.76 1.052 1.112 0 2.052-.622 2.82-1.866.768-1.245 1.152-2.74 1.152-4.489 0-1.933-.411-3.429-1.231-4.488-.954-1.244-2.45-1.867-4.489-1.867h-1.588v-1.906l5.56-9.612h-6.712l-.382.65-8.163 27.548h-.397l-5.958-19.937-5.957 19.937h-.397l-9.53-32.168h4.17l5.759 19.58 3.892-13.185-1.906-6.395z"/><path d="m64.92 1.006c-.819 0-1.554.295-2.111.861-.591.6-.92 1.376-.92 2.178s.313 1.545.887 2.128c.583.591 1.334.912 2.145.912.793 0 1.562-.321 2.161-.903.574-.557.887-1.3.887-2.136 0-.811-.321-1.57-.878-2.136-.584-.592-1.344-.904-2.171-.904zm2.643 3.065c0 .701-.271 1.351-.768 1.832-.524.507-1.174.777-1.892.777-.675 0-1.342-.278-1.84-.785s-.777-1.157-.777-1.849.287-1.368.802-1.891c.481-.49 1.131-.751 1.84-.751.726 0 1.376.271 1.883.785.49.489.752 1.147.752 1.882zm-2.559-1.807h-1.3v3.445h.65v-1.469h.642l.701 1.469h.726l-.769-1.57c.498-.102.785-.439.785-.929 0-.625-.472-.946-1.435-.946zm-.118.422c.608 0 .886.169.886.591 0 .405-.278.549-.87.549h-.549v-1.14z"/><path d="m59.807.825.676 4.107-2.391 4.575s-.918-1.941-2.443-3.015c-1.285-.905-2.122-1.102-3.431-.832-1.681.347-3.587 2.357-4.419 4.835-.995 2.965-1.005 4.4-1.04 5.718-.056 2.113.277 3.362.277 3.362s-1.452-2.686-1.438-6.62c.009-2.808.451-5.354 1.75-7.867 1.143-2.209 2.842-3.535 4.35-3.691 1.559-.161 2.791.59 3.743 1.403 1 .854 2.01 2.721 2.01 2.721z"/><path d="m60.102 24.063s-1.057 1.889-1.715 2.617c-.659.728-1.837 2.01-3.292 2.651s-2.218.762-3.656.624c-1.437-.138-2.772-.97-3.24-1.317s-1.664-1.369-2.34-2.322-1.733-2.859-1.733-2.859.589 1.91.958 2.721c.212.467.864 1.894 1.789 3.136.863 1.159 2.539 3.154 5.086 3.604 2.547.451 4.297-.693 4.73-.97s1.346-1.042 1.924-1.66c.603-.645 1.174-1.468 1.49-1.962.231-.36.607-1.092.607-1.092z"/></g></svg> </a> <a lang="en" class="home" href="/WAI/"> <span class="wai"><span class="wa">Web&nbsp;Accessibility</span> <span class="i"><span class="initieative">Initiative</span> <span>WAI</span></span></span> </a> <div class="claim"> <span>Strategies, standards, resources to make the Web accessible to people with disabilities</span> </div> <button class="button button-menu" aria-haspopup="true" aria-expanded="false" id="openmenu"><span><svg focusable="false" aria-hidden="true" class="icon-menu "><use xlink:href="/WAI/assets/images/icons.svg#icon-menu"></use></svg> Menu</span></button> </div> <div class="navigations"> <nav class="metanav" aria-label="Meta &amp; Search" lang="en"> <ul> <li><a href="/WAI/about/participating/">Get Involved</a></li> <li><a href="/WAI/about/">About W3C WAI</a></li> <li> <form action="/WAI/search/" role="search"> <div> <label for="header-search"> <span class="visuallyhidden">Search:</span> <input id="header-search" type="search" name="q" placeholder="Search" aria-label="Search"> </label> <button class="button button-icon button-nobg button-noborder"><span><svg focusable="false" aria-label="Submit Search" class="icon-search "><use xlink:href="/WAI/assets/images/icons.svg#icon-search"></use></svg></span></button> </div> </form> </li> </ul> </nav> </div> </header><nav class="mainnav" aria-label="Main" lang="en"><ul><li><a lang="en" href="/WAI/fundamentals/"><span>Accessibility Fundamentals</span></a></li><li><a lang="en" href="/WAI/planning/"><span>Planning &amp; Policies</span></a></li><li><a lang="en" href="/WAI/design-develop/"><span>Design &amp; Develop</span></a></li><li><a lang="en" href="/WAI/test-evaluate/"><span>Test &amp; Evaluate</span></a></li><li><a lang="en" href="/WAI/teach-advocate/"><span>Teach &amp; Advocate</span></a></li><li><a lang="en" href="/WAI/standards-guidelines/"><span>Standards/<wbr>Guidelines</span></a></li></ul></nav><nav class="default-grid breadcrumb" aria-label="Breadcrumb" lang="en"> <ul style="align-self: center;"> <li><a href="/WAI/" lang="en">Home</a></li><li><a lang="en" href="/WAI/about/"><span>About W3C WAI</span></a></li><li><a lang="en" href="/WAI/about/translating/"><span>Translating</span></a></li><li><a lang="en" href="/WAI/about/translating/resources/"><span>Translating a WAI Resource</span></a></li><li><a lang="en" href="/WAI/about/translating/resources/technical-steps/" aria-current="page"><span>Technical Steps</span></a></li></ul> </nav> <div class="default-grid with-gap leftcol"> <div class="sidenav"><nav class="sn-contents" aria-label="Secondary"> <ul class="sidenav--list"> <li> <a lang="en" href="/WAI/about/" class="page-link"><span>About WAI</span></a></li><li> <a lang="en" href="/WAI/update/" class="page-link"><span>What We&apos;re Working On</span></a></li><li> <a lang="en" href="/WAI/about/participating/" class="page-link"><span>Participating</span></a></li><li> <a lang="en" href="/WAI/about/groups/" class="page-link"><span>Groups</span></a><ul><li> <a lang="en" href="/WAI/about/groups/agwg/" class="page-link"><span>AGWG: Accessibility Guidelines <abbr title="Working Group">WG</abbr></span></a><ul><li> <a lang="en" href="https://www.w3.org/WAI/GL/charter" class="page-link"><span>Charter</span></a></li><li> <a lang="en" href="/WAI/about/groups/agwg/task-forces/" class="page-link"><span>Task Forces</span></a></li><li> <a lang="en" href="/WAI/about/groups/agwg/decision-policy/" class="page-link"><span>Decision Policy</span></a></li><li> <a lang="en" href="/WAI/about/groups/agwg/communication/" class="page-link"><span>Communication</span></a></li><li> <a lang="en" href="/WAI/about/groups/agwg/participate/" class="page-link"><span>How to Participate (Join)</span></a></li></ul></li><li> <a lang="en" href="/WAI/about/groups/apawg/" class="page-link"><span>APA: Accessible Platform <abbr title="Working Group">WG</abbr></span></a><ul><li> <a lang="en" href="https://www.w3.org/2023/07/apa-wg-charter" class="page-link"><span>Charter</span></a></li><li> <a lang="en" href="/WAI/about/groups/apawg/task-forces/" class="page-link"><span>Task Forces</span></a></li><li> <a lang="en" href="/WAI/about/groups/apawg/decision-policy/" class="page-link"><span>Decision Policy</span></a></li><li> <a lang="en" href="/WAI/about/groups/apawg/deliverables/" class="page-link"><span>Deliverables and Status</span></a></li><li> <a lang="en" href="/WAI/about/groups/apawg/video-examples/" class="page-link"><span>APA Video Examples</span></a></li><li> <a lang="en" href="/WAI/about/groups/apawg/communication/" class="page-link"><span>Communication</span></a></li><li> <a lang="en" href="/WAI/about/groups/apawg/contribute/" class="page-link"><span>How to Contribute</span></a></li><li> <a lang="en" href="/WAI/about/groups/apawg/participate/" class="page-link"><span>How to Participate (Join)</span></a></li></ul></li><li> <a lang="en" href="/WAI/about/groups/ariawg/" class="page-link"><span>ARIA: Accessible Rich Internet Applications <abbr title="Working Group">WG</abbr></span></a><ul><li> <a lang="en" href="https://www.w3.org/WAI/ARIA/charter" class="page-link"><span>Charter</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/task-forces/" class="page-link"><span>Task Forces</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/decision-policy/" class="page-link"><span>Decision Policy</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/workflow/" class="page-link"><span>Workflow</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/roadmap/" class="page-link"><span>Roadmap</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/planning/" class="page-link"><span>Deliverables and Status</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/communication/" class="page-link"><span>Communication</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/editors/" class="page-link"><span>Editors</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/contribute/" class="page-link"><span>How to Contribute</span></a></li><li> <a lang="en" href="/WAI/about/groups/ariawg/participate/" class="page-link"><span>How to Participate (Join)</span></a></li></ul></li><li> <a lang="en" href="/WAI/about/groups/waiig/" class="page-link"><span>WAI IG: WAI Interest Group</span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/" class="page-link"><span>Group Task Forces</span></a><ul><li> <a lang="en" href="/WAI/about/groups/task-forces/conformance-testing/" class="page-link"><span>ACT: Accessibility Conformance Testing <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/practices/" class="page-link"><span>APG: ARIA Authoring Practices <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/coga/" class="page-link"><span>COGA: Cognitive and Learning Disabilities <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/css-a11y/" class="page-link"><span>CSS A11Y: CSS Accessibility <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/low-vision-a11y-tf/" class="page-link"><span>LVTF: Low Vision Accessibility <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/matf/" class="page-link"><span>MATF: Mobile Accessibility <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/maturity-model/" class="page-link"><span>MMTF: Maturity Model <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/research-questions/" class="page-link"><span>RQTF: Research Question <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/silver/" class="page-link"><span>Silver <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/pronunciation/" class="page-link"><span>Spoken Presentation <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/adapt/" class="page-link"><span>WAI-Adapt <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/wcag2x-backlog/" class="page-link"><span>WCAG 2.x Backlog <abbr title="Task Force">TF</abbr></span></a></li><li> <a lang="en" href="/WAI/about/groups/task-forces/wcag2ict/" class="page-link"><span>WCAG2ICT <abbr title="Task Force">TF</abbr></span></a></li></ul></li></ul></li><li> <a lang="en" href="/WAI/about/translating/" aria-current="location" class="page-link"><span>Translating</span></a><ul><li> <a lang="en" href="/WAI/about/translating/resources/" aria-current="location" class="page-link"><span>Translating a WAI Resource</span></a><ul> <li> <a lang="en" href="/WAI/about/translating/resources/technical-steps/" aria-current="page" class="page-link"><span>Technical Steps</span></a></li><li> <a lang="en" href="/WAI/about/translating/resources/using-github/" class="page-link"><span>Using GitHub</span></a></li><li> <a lang="en" href="/WAI/about/translating/resources/subtitles/" class="page-link"><span>Subtitles/Descriptions</span></a></li><li> <a lang="en" href="/WAI/about/translating/resources/images/" class="page-link"><span>Images</span></a></li><li> <a lang="en" href="/WAI/about/translating/resources/resource-specific-instructions/" class="page-link"><span>Resource-Specific Instructions</span></a></li></ul></li><li> <a lang="en" href="/WAI/about/translating/reviewing/" class="page-link"><span>Reviewing a Translation</span></a></li><li> <a lang="en" href="/WAI/about/translating/wcag/" class="page-link"><span>Translating WCAG</span></a><ul><li> <a lang="en" href="/WAI/about/translating/wcag/wcag21-update/" class="page-link"><span>Updating WCAG 2.1 Translations</span></a></li></ul></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/" class="page-link"><span>Translations Sitemaps</span></a><ul><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-ar/" class="page-link"><span>Arabic</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-zh-hans/" class="page-link"><span>Chinese (Simplified)</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-cs/" class="page-link"><span>Czech</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-fr/" class="page-link"><span>French</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-de/" class="page-link"><span>German</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-el/" class="page-link"><span>Greek</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-id/" class="page-link"><span>Indonesian</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-ja/" class="page-link"><span>Japanese</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-ko/" class="page-link"><span>Korean</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-pl/" class="page-link"><span>Polish</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-ru/" class="page-link"><span>Russian</span></a></li><li> <a lang="en" href="/WAI/about/translating/sitemaps/sitemap-es/" class="page-link"><span>Spanish</span></a></li></ul></li></ul></li><li> <a lang="en" href="/WAI/about/sponsoring/" class="page-link"><span>Sponsoring</span></a></li><li> <a lang="en" href="/WAI/about/contacting/" class="page-link"><span>Contacting</span></a></li><li> <a lang="en" href="/WAI/about/projects/" class="page-link"><span>Projects</span></a><ul><li> <a lang="en" href="/WAI/about/projects/wai-coop/" class="page-link"><span>WAI-CooP</span></a><ul><li> <a lang="en" href="/WAI/about/projects/wai-coop/symposium1/" class="page-link"><span>Research Symposium 2021</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-coop/symposium2/" class="page-link"><span>Research Symposium AI</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-coop/symposium3/" class="page-link"><span>Research Symposium Evaluating Accessibility</span></a></li></ul></li><li> <a lang="en" href="/WAI/about/projects/wai-guide/" class="page-link"><span>WAI-Guide</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/" class="page-link"><span>WAI-Tools</span></a><ul><li> <a lang="en" href="/WAI/about/projects/wai-tools/final-open-meeting/" class="page-link"><span>Final Open Meeting</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/session1/" class="page-link"><span>Video Recording 1</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/session2/" class="page-link"><span>Video Recording 2</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/session3/" class="page-link"><span>Video Recording 3</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/session4/" class="page-link"><span>Video Recording 4</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/session5/" class="page-link"><span>Video Recording 5</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/third-open-meeting/" class="page-link"><span>Third Open Meeting</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/second-open-meeting/" class="page-link"><span>Second Open Meeting</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/symposium/" class="page-link"><span>Online Symposium</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-tools/first-open-meeting/" class="page-link"><span>First Open Meeting</span></a></li></ul></li><li> <a lang="en" href="/WAI/expand-access/" class="page-link"><span>WAI Expanding Access</span></a></li><li> <a lang="en" href="/WAI/about/projects/easy-reading/" class="page-link"><span>Easy Reading</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-core-2015/" class="page-link"><span>WAI-Core 2015, 2020</span></a></li><li> <a lang="en" href="/WAI/about/projects/wai-core-ford/" class="page-link"><span>WAI-Core Ford</span></a></li></ul></li><li> <a lang="en" href="/WAI/about/accessibility-statement/" class="page-link"><span>Accessibility Statement</span></a></li><li> <a lang="en" href="/WAI/about/using-wai-material/" class="page-link"><span>Using WAI Material</span></a></li></ul></nav> </div> <main id="main" lang="en"> <header> <h1> How to Translate a WAI Resource </h1></header> <aside class="box box-full"><header class="box-h box-h-full"> <h2> Summary </h2></header><div class="box-i"> <p>This page guides you through the technical steps to translate Web Accessibility Initiative (WAI) resources, and provides other important guidance.</p> <p>For instructions on translating the Web Content Accessibility Guidelines (WCAG), see <a href="/WAI/about/translating/wcag/">How to Translate WCAG 2</a>.</p> </div></aside> <nav class="box box-simple box-simple" aria-labelledby="tocheading" id="toc"> <header id="tocheading" class="box-h box-h-simple box-h-simple"> Page Contents</header> <div class="box-i"> <ul id="markdown-toc"> <li><a href="#overview" id="markdown-toc-overview">Overview</a></li> <li><a href="#general-guidance" id="markdown-toc-general-guidance">General guidance</a></li> <li><a href="#initial-step-declare-your-intent" id="markdown-toc-initial-step-declare-your-intent">Initial step: Declare your intent</a></li> <li><a href="#create-file" id="markdown-toc-create-file">Step 1: Create a new file</a></li> <li><a href="#frontmatter" id="markdown-toc-frontmatter">Step 2: Update the “front matter” metadata</a></li> <li><a href="#main-content" id="markdown-toc-main-content">Step 3: Translate main content</a></li> <li><a href="#commit-changes" id="markdown-toc-commit-changes">Step 4: Commit your changes and open a Pull Request</a></li> <li><a href="#we-are-here-to-help" id="markdown-toc-we-are-here-to-help">We are here to help</a></li> </ul> </div> </nav> <h2 id="overview">Overview</h2> <p>There are 4 main technical steps to create a new WAI resource translation:</p> <ol> <li> <p><strong><a href="#create-file">Create a new file</a></strong></p> </li> <li> <p><strong><a href="#frontmatter">Update the “front matter” metadata</a></strong></p> </li> <li> <p><strong><a href="#main-content">Translate the main content</a></strong></p> </li> <li> <p><strong><a href="#commit-changes">Commit your changes and open a Pull Request</a></strong></p> </li> </ol> <h2 id="general-guidance">General guidance</h2> <ul> <li><strong>Do not change or adapt or add to the meaning of the English version</strong> in your translation.<br /> 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.</li> <li><strong>Before starting, find the relevant <a href="https://www.w3.org/International/questions/qa-choosing-language-tags">“language tag”</a></strong> from the <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">Language Subtag Registry <svg focusable="false" aria-label="External Site" class="icon-external-link "><use xlink:href="/WAI/assets/images/icons.svg#icon-external-link"></use></svg></a>. You will use it many times during the translation.</li> <li>The markdown files are very sensitive to indentation, commas, quotes, and special characters. <strong>We recommend that you use a markdown editor or a simple text editor</strong> (including GitHub interface) — and not a document editor like Microsoft Word that often changes quotes and indentation.</li> <li><strong>Some resources have specific instructions.</strong> Please take a look at <a href="/WAI/about/translating/resources/resource-specific-instructions/">Resource-Specific Translation Instructions</a> to see if this applies to your targeted resource, and follow these additional instructions if it does.</li> <li>If you wish to translate the <a href="https://www.w3.org/WAI/eval/report-tool/">WCAG-EM Report Tool</a>, please read <a href="https://github.com/w3c/wai-wcag-em-report-tool/wiki/How-to-add-a-language">this specific guidance <svg focusable="false" aria-label="External Site" class="icon-external-link "><use xlink:href="/WAI/assets/images/icons.svg#icon-external-link"></use></svg></a>, as different steps have to be followed.</li> </ul> <h2 id="initial-step-declare-your-intent">Initial step: Declare your intent</h2> <p>In accordance with the WAI Translations process, please always <a href="/WAI/about/translating/resources/#intent">declare your intent</a> and wait for reply from WAI team <em>before</em> starting a translation.</p> <h2 id="create-file">Step 1: Create a new file</h2> <p>Duplicate the file used by the original version, with the language shortcode added to the middle of the filename, as follows:</p> <aside class="box"><header class="box-h "> Example</header><div class="box-i"> <ul> <li>Original English file: <code class="language-plaintext highlighter-rouge">index.md</code></li> <li>New Korean file: <code class="language-plaintext highlighter-rouge">index.ko.md</code></li> </ul> </div></aside> <h2 id="frontmatter">Step 2: Update the “front matter” metadata</h2> <aside class="box box-highlighted"><div class="box-i"> <p>From now on, only edit the newly created translation file.</p> </div></aside> <p>At the top of WAI website files are some metadata, also known as “front matter”.</p> <p>Your first step into the file is to update this section.</p> <aside class="box"><header class="box-h "> Example of front matter (this may differ on your file)</header><div class="box-i"> <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span> <span class="na">title</span><span class="pi">:</span> <span class="s">Evaluation Tools Overview</span> <span class="na">lang</span><span class="pi">:</span> <span class="s">en</span> <span class="na">last_updated</span><span class="pi">:</span> <span class="s">2020-04-28</span> <span class="na">github</span><span class="pi">:</span> <span class="na">label</span><span class="pi">:</span> <span class="s">wai-evaluation-tools</span> <span class="na">permalink</span><span class="pi">:</span> <span class="s">/test-evaluate/tools/</span> <span class="na">ref</span><span class="pi">:</span> <span class="s">/test-evaluate/tools/</span> <span class="na">footer</span><span class="pi">:</span> <span class="pi">&gt;</span> <span class="s">&lt;p&gt;&lt;strong&gt;Editor:&lt;/strong&gt; &lt;a href="https://www.w3.org/People/Shawn/"&gt;Shawn Lawton Henry&lt;/a&gt;.&lt;/p&gt;</span> <span class="s">&lt;p&gt;Video developed by the Education and Outreach Working Group (&lt;a href="http://www.w3.org/WAI/EO/"&gt;EOWG&lt;/a&gt;) with support from the &lt;a href="https://www.w3.org/WAI/about/projects/wai-guide/"&gt;WAI-Guide&lt;/a&gt; project funded by the European Commission (EC) under the Horizon 2020 program (Grant Agreement 822245). &lt;a href="./acknowledgements/"&gt;Acknowledgements&lt;/a&gt;.&lt;/p&gt;</span> <span class="s">---</span> </code></pre></div></div> </div></aside> <h3 id="21-update-the-following-front-matter-values">2.1. Update the following front matter values:</h3> <p><code class="language-plaintext highlighter-rouge">lang</code></p> <ul> <li>Replace the original value (<code class="language-plaintext highlighter-rouge">en</code>) with the language shortcode of your translation.</li> </ul> <p><code class="language-plaintext highlighter-rouge">path</code> (below <code class="language-plaintext highlighter-rouge">github</code>)</p> <ul> <li>Add the language shortcode at the middle of the filename.</li> </ul> <p><code class="language-plaintext highlighter-rouge">permalink</code></p> <ul> <li>Add the language shortcode at the end of the permalink, with no <code class="language-plaintext highlighter-rouge">/</code> at the end.</li> </ul> <p><code class="language-plaintext highlighter-rouge">footer</code> (not always present)</p> <ul> <li>If this attribute is present, translate its content.</li> </ul> <h3 id="22-add-translation-information">2.2. Add translation information</h3> <p>After <code class="language-plaintext highlighter-rouge">last_updated</code> (that corresponds to the date of the English version), add these lines:</p> <aside class="box"><div class="box-i"> <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">translation</span><span class="pi">:</span> <span class="na">last_updated</span><span class="pi">:</span> <span class="s">2000-00-00</span> <span class="na">translators</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Your</span><span class="nv"> </span><span class="s">Name"</span> <span class="na">contributors</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Other</span><span class="nv"> </span><span class="s">Name"</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Other</span><span class="nv"> </span><span class="s">Name"</span> </code></pre></div></div> </div></aside> <p><code class="language-plaintext highlighter-rouge">translation</code> – <code class="language-plaintext highlighter-rouge">last_updated</code></p> <ul> <li>Change <code class="language-plaintext highlighter-rouge">last_updated: 2000-00-00</code> to the date you finish the translation.<br /> Use the format: YYYY-MM-DD (with month in the middle).</li> </ul> <p><code class="language-plaintext highlighter-rouge">translators</code> and <code class="language-plaintext highlighter-rouge">contributors</code></p> <ul> <li>Add information depending on how many translators there are, and if there are contributors. Policy for names and links is introduced in <a href="/WAI/about/translating/#links">Translating WAI Resources</a>.</li> <li>If the lines are present and commented out with “<code class="language-plaintext highlighter-rouge">#</code> “ before: delete the # and the space.</li> </ul> <aside class="box"><header class="box-h "> Updated front matter for a translation into French</header><div class="box-i"> <details id="optional-id"><summary> <p>Show example</p> </summary> <div> <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span> <span class="na">title</span><span class="pi">:</span> <span class="s">Evaluation Tools Overview</span> <span class="na">lang</span><span class="pi">:</span> <span class="s">fr</span> <span class="na">last_updated</span><span class="pi">:</span> <span class="s">2020-04-28</span> <span class="na">translation</span><span class="pi">:</span> <span class="na">last_updated</span><span class="pi">:</span> <span class="s">2024-11-11</span> <span class="na">translators</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Your</span><span class="nv"> </span><span class="s">Name"</span> <span class="na">contributors</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Other</span><span class="nv"> </span><span class="s">Name"</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Other</span><span class="nv"> </span><span class="s">Name"</span> <span class="na">github</span><span class="pi">:</span> <span class="na">label</span><span class="pi">:</span> <span class="s">wai-evaluation-tools</span> <span class="na">permalink</span><span class="pi">:</span> <span class="s">/test-evaluate/tools/fr</span> <span class="na">ref</span><span class="pi">:</span> <span class="s">/test-evaluate/tools/</span> <span class="na">footer</span><span class="pi">:</span> <span class="pi">&gt;</span> <span class="s">&lt;p&gt;&lt;strong&gt;Rédactrice :&lt;/strong&gt; &lt;a href="https://www.w3.org/People/Shawn/"&gt;Shawn Lawton Henry&lt;/a&gt;.&lt;/p&gt;</span> <span class="s">&lt;p&gt;Vidéo créée par le groupe de travail Éducation et Promotion (&lt;a href="http://www.w3.org/WAI/EO/"&gt;EOWG&lt;/a&gt;) avec le soutien du projet &lt;a href="https://www.w3.org/WAI/about/projects/wai-guide/"&gt;WAI-Guide&lt;/a&gt; financé par la Commission européenne (CE) dans le cadre du programme Horizon 2020 (convention de subvention n°822245) &lt;a href="./acknowledgements/"&gt;Remerciements&lt;/a&gt;.&lt;/p&gt;</span> <span class="s">---</span> </code></pre></div> </div> </div> </details> </div></aside> <h3 id="follow-additional-inline-instructions">Follow additional inline instructions</h3> <p>Many resources have inline instructions in the front matter (after the “<code class="language-plaintext highlighter-rouge">#</code>” character).</p> <p>Please follow these instructions. It will help you know what to translate/update and what to not change.</p> <h2 id="main-content">Step 3: Translate main content</h2> <h3 id="markdowncode">Markdown/Code</h3> <p>Please leave the code, HTML, and markdown as is without changing it.</p> <p>Make sure to:</p> <ul> <li> <p>Translate titles in the markdown, such as “Summary” in:</p> <aside class="box"><div class="box-i"> <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span>box.html<span class="w"> </span><span class="na">type</span><span class="o">=</span><span class="s2">"start"</span><span class="w"> </span><span class="na">title</span><span class="o">=</span><span class="s2">"Summary"</span><span class="w"> </span><span class="na">class</span><span class="o">=</span><span class="s2">""</span><span class="w"> </span><span class="cp">%}</span> </code></pre></div></div> </div></aside> </li> <li> <p>Translate image alternative text, such as “mouse crossed out” in:</p> <aside class="box"><div class="box-i"> <ul> <li>in Markdown: <code class="language-plaintext highlighter-rouge">![mouse crossed out](https://www.w3.org/WAI/intro/no-mouse.png)</code></li> <li>in HTML: <code class="language-plaintext highlighter-rouge">&lt;img src="https://www.w3.org/WAI/intro/no-mouse.png" alt="mouse crossed out" /&gt;</code></li> </ul> </div></aside> </li> <li> <p>Make sure that the quote marks stay as is, and are not converted to “smart quotes” by word processing software.</p> </li> </ul> <h3 id="links">Links</h3> <p>Most links are formatted with single or double brackets and parentheses; for example:</p> <aside class="box"><div class="box-i"> <div class="language-markdown highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">[</span><span class="nv">Text that is linked</span><span class="p">](</span><span class="sx">/path/to/filename/</span><span class="p">)</span> <span class="p">[</span><span class="nv">[Title of WAI Page]</span><span class="p">](</span><span class="sx">/path/to/filename/</span><span class="p">)</span> </code></pre></div></div> </div></aside> <p>Make sure to:</p> <ul> <li>Keep brackets and parentheses together, with no space between the closing <code class="language-plaintext highlighter-rouge">]</code> and the opening <code class="language-plaintext highlighter-rouge">(</code>.</li> <li>Keep double <code class="language-plaintext highlighter-rouge">[[</code> or single brackets <code class="language-plaintext highlighter-rouge">[</code> as they are.</li> <li>Translate the text in the links, including document titles.</li> <li>Do not manually add <code class="language-plaintext highlighter-rouge">(in English)</code>, even for external links.</li> </ul> <h3 id="links-to-w3c-standards">Links to W3C standards</h3> <p>If an <a href="https://www.w3.org/Translations/authorized.html">Authorized Translation of a W3C standard</a> has been published in your language, please point to the translated version.</p> <p>Example:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>- [Le standard WCAG 2.0](https://www.w3.org/Translations/WCAG20-fr/) - [Le standard WCAG 2.1](https://www.w3.org/Translations/WCAG21-fr/) </code></pre></div></div> <p>If not, translate the link text but keep the link to the English version.</p> <p>Example:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>- [Le standard WCAG 2.2](https://www.w3.org/TR/WCAG22//) </code></pre></div></div> <h3 id="specific-wording">Specific wording</h3> <ul> <li>Check <a href="/translations/">other translations in your language</a> to see how similar words and concepts have been translated. In particular, <a href="https://www.w3.org/Translations/authorized.html">Authorized Translations</a> have had significant review and input.</li> <li>Read the <a href="https://github.com/w3c/wai-translations/blob/main/glossaries/general.md">General Translation Glossary <svg focusable="false" aria-label="External Site" class="icon-external-link "><use xlink:href="/WAI/assets/images/icons.svg#icon-external-link"></use></svg></a> and see if there is a <a href="https://github.com/w3c/wai-translations#list-of-glossaries">glossary for your language <svg focusable="false" aria-label="External Site" class="icon-external-link "><use xlink:href="/WAI/assets/images/icons.svg#icon-external-link"></use></svg></a>.</li> <li>Consider different dialects. Where possible, the translation should use words and phrases that will be best understood across different areas.</li> </ul> <h3 id="videos--images">Videos &amp; Images</h3> <ul> <li>If the page has videos, refer to <a href="/WAI/about/translating/resources/video-subtitles/">How to Create Translated Video Subtitles and Descriptions</a></li> <li>If the page has images with text, refer to <a href="/WAI/about/translating/resources/images/">How to Translate Images</a></li> </ul> <h2 id="commit-changes">Step 4: Commit your changes and open a Pull Request</h2> <p>Commit your changes and follow instructions in <a href="/WAI/about/translating/resources/#preview">Step-by-Step Guide to Translating WAI Resources</a>.</p> <h2 id="we-are-here-to-help">We are here to help</h2> <p>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 <a href="mailto:public-wai-translations@w3.org">public-wai-translations@w3.org</a> mailing-list.</p> <p>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.</p> <aside class="box box-icon box-space-above" id="helpimprove" aria-label="feedback"><header class="box-h box-h-icon box-h-space-above box-h-icon"> <svg focusable="false" aria-hidden="true" class="icon-comments "><use xlink:href="/WAI/assets/images/icons.svg#icon-comments"></use></svg> <h2> Help improve this page </h2></header><div class="box-i"><p>Please share your ideas, suggestions, or comments via e-mail to the publicly-archived list <a href="mailto:wai@w3.org?body=%5Binclude%20a%20relevant%20email%20Subject%5D%0A%0A%5Bput%20comment%20here...%5D%0A%0AI%20give%20permission%20to%20share%20this%20to%20a%20publicly-archived%20e-mail%20list.">wai@w3.org</a> or via GitHub.</p> <div class="button-group"> <a href="mailto:wai@w3.org?body=%5Binclude%20a%20relevant%20email%20Subject%5D%0A%0A%5Bput%20comment%20here...%5D%0A%0AI%20give%20permission%20to%20share%20this%20to%20a%20publicly-archived%20e-mail%20list." class="button"><span>E-mail</span></a><a href=" https://github.com/w3c/wai-website/edit/main/pages/about/translating/resources/technical-steps.md " class="button"><span>Fork &amp; Edit on GitHub</span></a><a href="https://github.com/w3c/wai-website/issues/new?template=content-issue.yml&wai-resource-id=wai-translation-guidance&wai-url=https://www.w3.org/WAI/about/translating/resources/technical-steps/" class="button"><span>New GitHub Issue</span></a></div></div></aside> <a class="button button-backtotop" href="#top"><span><svg focusable="false" aria-hidden="true" class="icon-arrow-up "><use xlink:href="/WAI/assets/images/icons.svg#icon-arrow-up"></use></svg> Back to Top</span></a> </main> </div> <footer id="wai-site-footer" class="page-footer default-grid" aria-label="Page"> <div class="inner"><p><strong>Updated:</strong> 19 November 2024.</p><p><strong>Editors:</strong> <a href="https://www.w3.org/People/Shawn/">Shawn Lawton Henry</a> and Rémi Bétin.</p> <p>Developed as part of the <a href="https://www.w3.org/WAI/about/projects/wai-coop/">WAI-CooP project</a>, co-funded by the European Commission.</p> </div> </footer> <footer class="site-footer grid-4q" aria-label="Site"> <div class="q1-start q3-end about"> <div> <p><a class="largelink" href="https://www.w3.org/WAI/" lang="en" dir="auto" translate="no">W3C Web Accessibility Initiative (WAI)</a></p> <p>Strategies, standards, and supporting resources to make the Web accessible to people with disabilities.</p> </div> <div class="social" lang="en" dir="auto" translate="no"> <ul> <li><a href="https://w3c.social/@wai"><svg focusable="false" aria-hidden="true" class="icon-mastodon "><use xlink:href="/WAI/assets/images/icons.svg#icon-mastodon"></use></svg> Mastodon</a></li> <li><a href="https://www.linkedin.com/company/w3c-wai/"><svg focusable="false" aria-hidden="true" class="icon-linkedin "><use xlink:href="/WAI/assets/images/icons.svg#icon-linkedin"></use></svg> LinkedIn</a></li> <li><a href="https://www.w3.org/WAI/feed.xml"><svg focusable="false" aria-hidden="true" class="icon-rss "><use xlink:href="/WAI/assets/images/icons.svg#icon-rss"></use></svg> Feed</a></li> <li><a href="https://www.youtube.com/channel/UCU6ljj3m1fglIPjSjs2DpRA/playlists/"><svg focusable="false" aria-hidden="true" class="icon-youtube "><use xlink:href="/WAI/assets/images/icons.svg#icon-youtube"></use></svg> YouTube</a></li> <li><a href="https://www.w3.org/WAI/news/subscribe/" class="button">Get News in Email</a></li> </ul> </div> <div lang="en" dir="auto" translate="no"> <p>Copyright © 2024 World Wide Web Consortium (<a href="https://www.w3.org/">W3C</a><sup>®</sup>). See <a href="/WAI/about/using-wai-material/">Permission to Use WAI Material</a>.</p> </div> </div> <div lang="en" dir="auto" translate="no" class="q4-start q4-end"> <ul style="margin-bottom:0"> <li><a href="/WAI/about/contacting/">Contact WAI</a></li> <li><a href="/WAI/sitemap/">Site Map</a></li> <li><a href="/WAI/news/">News</a></li> <li><a href="/WAI/sitemap/#archive">Archive</a></li> <li><a href="/WAI/about/accessibility-statement/">Accessibility Statement</a></li> <li><a href="/WAI/translations/"> Translations</a></li> <li><a href="/WAI/roles/">Resources for Roles</a></li> </ul> </div> </footer><!-- Details4Everybody --> <script src="/WAI/assets/scripts/details4everybody.js?1732321439590790613"></script> <!-- SVG4Everybody --> <script src="/WAI/assets/scripts/svg4everybody.js?1732321439590790613"></script> <script> svg4everybody(); </script><script> var translationStrings = {}; </script> </body> </html>

Pages: 1 2 3 4 5 6 7 8 9 10