Valve Developer Community:Alternative Languages

From Valve Developer Community
Jump to: navigation, search
English (en)Deutsch (de)Esperanto (eo)français (fr)italiano (it)日本語 (ja)русский (ru)español (es)中文 (zh)
Edit
Shortcut
VDC:AL
Blank image.pngTodo: This documentation page needs to be updated to include current information regarding the subject. Should document the new translation templates.

This page is a reference on having alternative languages here on the Valve Developer Community. Translating the page you want should be simple if you are fluent in a language. This article does not go into depth in translation of articles.

For information on how to add a new language, see the language checklist.

Titles

It is important that all page names contain only ASCII characters; otherwise, the pages aren't handled correctly by the database.

For pages using {{MultiPage}} (Recommended)
The title for a translated page (called "language subpages") should be the English name followed by a forward slash (/) and the abbreviation (usually ISO_639-1) for the language. This includes English. The root page should only have {{MultiPage}} and categories. An correct title is Half-Life 2/en. Language subpages should have the {{Language subpage}} template at the top followed by the body text for the article. Remember, categories go on the root page only, not the subpages.
For pages using {{Lang}} (deprecated)
The name of a translated page should put the English name first, followed by a colon (:), followed by the abbreviation described in {{Lang}}'s documentation (which is not always the language's ISO_639-1 and ISO_639-2 abbreviation). An example of a proper page name is Help:Contents:ru. It is not a problem to use non-English text in the pages themselves, but the name of the page cannot contain any non-English, non-ASCII characters.

English pages are usually the originals (with the exception of MultiPage having the /en page, but the main page itself always have the original English language), and there is no :en tag on them.

There are a number of ways to change how a page title will appear to readers without affecting the URL.

  • {{MultiPage}}: Preferred. Should be used for most articles, and categories page.
  • {{Lang}}: This is slowly being deprecated and replaced by MultiPage. Only should be used if other language templates doesn't work properly. Do not use this if possible!
  • {{This is a}} (The series of templates such as {{base point}} are deprecated), which are used on entity articles, material shader articles, console command/variable articles, etc.
  • {{DISPLAYTITLE:title}} - This is not a template, rather a magic word to change the page title to whatever you want. All the templates listed use this internally. This should only be used in rare scenarios where all other methods fail, but is still preferred before lang.

Linking to Pages in Another Language

{{MultiPage}} is the improved version of {{Lang}}. {{MultiPage}} will automatically detect when a page is available in other languages, and creates a row of flags that can change the language of the UI so that the corresponding content will be displayed. Read the documentation of the template for details.

Do not try to use {{Lang}} when creating new pages. Old pages should be updated to use {{MultiPage}}.

Note.pngNote:{{Lang}} is gradually approaching the role of an deprecated template. {{MultiPage}} will be used instead.



Templates

Using {{Autolang}} and {{Uselangflags}}

{{Autolang}} will change the contents according to your language of the interface. There are some strings subpages in some templates (such as {{Software page}}), and the translations are in them. All the strings subpages use this template internally.

See the documentation of the template for its usage. Alternatively, check the source code of pages that have already used this template to learn how to use it.

Using {{Lang}} (deprecated)

Obsolete-notext.png Deprecated: Only use this sparingly if other translation template isn't working on certain templates at the moment, eventually there will be somebody able to properly fix it and properly use the {{Autolang}} template, to the point that {{Lang}} isn't needed anymore.

Templates containing text visible on content pages should have that text translated into the translated page's language before the page is considered finished. Any documentation on the template should also be translated.

Templates without visible text may also have their documentation translated. If the template itself is identical to the English one however, the "translated" template should not be used on pages, because then if one version of the template is changed, it creates a needless hassle to change other versions as well, even though the templates are identical.

Categories

Categories have no longer been needed to be separated by language since the new translation template {{MultiPage}} was appeared. If you want translations for categories page, use {{MultiPage}} or {{Autolang}} combined with {{Uselangflags}} instead.

Icon-Important.pngImportant:Once you have used {{MultiPage}}, remove all the language categories from language subpages.

Language Checklist

Every language on the wiki should have:

  • An icon of a flag representative of the language Flag-en.png
Tip.pngTip:Most of the flags currently on the wiki seem to come from SteamCommunity flags
Icon-Important.pngImportant:DO NOT create a separate template for the flag such as {{En}}, these are leftovers from {{Lang}}
Note.pngNote:This page currently uses {{lang}}, and is therefore unable to support newer languages
  • Translations of some commonly used templates
  • Optionally, you can add translations of other language names to {{language name}}
Blank image.pngTodo: More?

Final Notes

This guide is not definitive, but it makes things much simpler when everyone follows one method of translating content, so everything in the wiki stays consistent throughout languages.

Please fully translate pages. A page partially in another language is simply not helpful for readers who only know one language.

If a page has received an important update, translations of the page should be marked with {{Updatetranslation}}.

See also