-
Notifications
You must be signed in to change notification settings - Fork 9
KB configuration file translation
The language-specific strings needed to generate the knowledge base pages are stored in JSON files in the corresponding /js/lang directory.
More information about these pages is provided in the following sections.
The user interface configuation file (ui.json) contains the strings needed to generate the user interface for the site. These strings are grouped by which part of the interface they are used in (e.g., the footer content is the "footer" object). For the site to render in another language, every string in this file needs to be translated.
Note that the footer.copyright field contains a placeholder variable ('%yr%'). This variable is automatically replaced by the current year.
The topic list configuration file (topics.json) contains the strings used to produce the index pages on the site. For example, if you click on any of the categories in the right-hand menu bar, the index page that appears is generated from this file.
The only strings that should be translated in this file are the subtitle and title fields.
The id, path, and href fields are used to create the page links.
The WCAG success criteria configuration file (sc.json) is used to insert the WCAG success criteria links in the techniques section. For example, you will find bracketed tags like this at the end of each techniques: "WCAG-2.1.1". The initialization script automatically turns this into a link to WCAG 2.1.1 so that we don't have to stored hardcoded links in every file (e.g., it's easier to fix the configuration file once than repair every page when WCAG releases).
The only field that needs translating is the name, as the WCAG level designator (A, AA, or AAA) is typically not translated.