Difference between revisions of "Template:L10n/Documentation"
m (→Syntax (base+row): updated syntax) |
m (→Syntax (row): updated syntax example) |
||
Line 220: | Line 220: | ||
<pre><nowiki> | <pre><nowiki> | ||
{{L10n/switch | {{L10n/switch | ||
− | |language = Language | + | |language = Language |
− | |interface = | + | |interface = yes, no |
− | |audio = | + | |audio = yes, no, hackable, n/a, unknown |
− | |subtitles = | + | |subtitles = yes, no, hackable, n/a, unknown |
|notes = | |notes = | ||
− | |fan = | + | |fan = 'yes' if fan-made or <blank> if localization is official |
}} | }} | ||
</nowiki></pre> | </nowiki></pre> |
Revision as of 21:20, 3 March 2019
Localizations table
The localization template is the other half of the Audio settings section. This table displays all the languages a game supports (both official and fan-made) and the elements of which the localization/translation covers (interface, subtitles, and/or audio). Due to the numerous languages available, the table has been designed to be dynamic so only the relevant languages are shown.
Related templates
- Template:L10n - Base template
- Template:L10n/row - Row template
- Template:L10n/switch - Switch in each row that handles supported languages
Notes
- The table is categorized in alphabetical order (A-Z).
- The only exception to this is the English row. Unless the game has no English translation, the row always stays at the top of the table.
- Localization information is rarely kept track of and will make filling in the tables difficult.
- Currently, the most reliable source of information on this topic is Steam and even then the tables they provide are sometimes not completely accurate.
- Ultimately, the best sources will be owning the game and playing it, the game credits (localization teams and cast will be mentioned somewhere), and any official announcements on language support.
- If both an official and a fan-made localization is available, add individual sections for both. One that applies to the official localization (
fan=<blank>
) and one that applies to the fan-made localization (fan=yes
). - To create lists over fan-made localization of games, see List of Russian fan-translations as an example.
- The languages the table support all have at least one game that is localized in that language. If a game is localized in a language that is not supported by the table, contact a mod or admin and it will be added in.
- In opposite to what a lot of other templates do, this template adds an
<h3>Localizations</h3>
header at the beginning where used. This can make it slightly less flexible on non-standard pages.
Parameters
Parameter | Definition/Notes |
---|---|
Language | The name of the language; see Supported languages for supported values. If a game is localized in a language that is not supported by the table, contact a mod or admin and it will be added in. |
Interface | The game interface (e.g. menus, pause screen, health bar) is localized to this language. If a game supports a language, at the absolute minimum this field must be set to true/yes. |
Audio | The spoken audio for the game is localized to this language. In some cases, English may be the only language it has been localized into. If a game has no speech, gibberish for speech (single word remarks fall into this category), or all text-based speech, set the field to n/a. |
Subtitles | The subtitles and/or closed captions for the game are localized to this language More common to find than spoken audio localizations. If a game has no speech, gibberish for speech (single word remarks fall into this category), nor any closed caption option, set the field to n/a. |
Notes | Extra information relating to the particular language (available only in region-specific versions, unique quirks and issues, etc). For a fan-made localization/translation include a link to the download, installation instructions, etc. |
Fan | One or more parameters of this particular language section refers to a fan-made localization that is available and can be hacked in. To be used in conjunction with the Notes field. Only valid value is yes. |
Arguments
The parameters, excluding the notes parameter, can be set to true (or yes), false (or no), n/a, or hackable :
- true - An official localization exists and ships with the game (or a version of the game). No custom hacking is expected, although config editing or similar might be required.
- false - No official localization nor fan-made localization is available for the game.
- n/a - The parameter is not applicable to the game, e.g. the game does not feature any audio and/or subtitles that needs localization.
- hackable - This value have effectively two meanings depending on the value of
fan
:
fan=yes
- A fan localization is available and can be hacked (aka modded) into the game. Set the corresponding parameter that the fan localization affects to hackable - e.g. if it only affects subtitles, setsubtitles=hackable
to indicate as such.
fan=<blank>
- A fan localization is not available, however an official localization is available in some form and can be hacked (aka modded) into the game. Set the corresponding parameter that the official localization affects to hackable - e.g. if it only affects subtitles, setsubtitles=hackable
to indicate as such.
Supported languages
The following languages are currently supported by the template:
Syntax
Syntax (base+row)
{{L10n|content= {{L10n/switch |language = Language |interface = yes, no |audio = yes, no, hackable, n/a, unknown |subtitles = yes, no, hackable, n/a, unknown |notes = |fan = 'yes' if fan-made or <blank> if localization is official }} }}
Syntax (base)
{{L10n|content= --rows go here-- }}
Syntax (row)
{{L10n/switch |language = Language |interface = yes, no |audio = yes, no, hackable, n/a, unknown |subtitles = yes, no, hackable, n/a, unknown |notes = |fan = 'yes' if fan-made or <blank> if localization is official }}
Example #1
- Hypothetical example.
Localizations
Language | UI | Audio | Sub | Notes |
---|---|---|---|---|
English | ||||
French | ||||
German | ||||
Italian | ||||
Spanish |
Source
{{L10n|content= {{L10n/switch |language = English |interface = true |audio = true |subtitles = true |notes = |fan = }} {{L10n/switch |language = French |interface = true |audio = true |subtitles = true |notes = |fan = }} {{L10n/switch |language = German |interface = true |audio = false |subtitles = true |notes = |fan = }} {{L10n/switch |language = Italian |interface = true |audio = unknown |subtitles = unknown |notes = |fan = }} {{L10n/switch |language = Spanish |interface = true |audio = false |subtitles = true |notes = |fan = }} }}
Example #2
- From Dark Messiah of Might and Magic.
- Note how two Russian sections are used to list the details of both an official localization as well as a fan-made one.
Localizations
Language | UI | Audio | Sub | Notes |
---|---|---|---|---|
English | ||||
French | ||||
German | ||||
Italian | ||||
Polish | Local retail version only. | |||
Russian | Official localization by «Buka» and «Reanimedia» (Audio). A mistake in the SteamPipe update causes Xana to speak German. See Xana speaks German in a Russian version of the game for a fix. | |||
Russian | Fan translation by «SyS-team», «Spirit Team», «ENPY Studio» | |||
Spanish |
Source
{{L10n|content= {{L10n/switch |language = English |interface = true |audio = true |subtitles = true |notes = |fan = }} {{L10n/switch |language = French |interface = true |audio = true |subtitles = true |notes = |fan = }} {{L10n/switch |language = German |interface = true |audio = true |subtitles = true |notes = |fan = }} {{L10n/switch |language = Italian |interface = true |audio = true |subtitles = true |notes = |fan = }} {{L10n/switch |language = Polish |interface = true |audio = false |subtitles = true |notes = Local retail version only. |fan = }} {{L10n/switch |language = Russian |interface = true |audio = true |subtitles = true |notes = Official localization by «Buka» and «Reanimedia» (Audio). A mistake in the SteamPipe update causes Xana to speak German. See [[#Xana speaks German in a Russian version of the game|Xana speaks German in a Russian version of the game]] for a fix. |fan = }} {{L10n/switch |language = Russian |interface = hackable |audio = false |subtitles = hackable |notes = [https://enpy.net/forum/files/file/25-dark-messiah-of-might-and-magic/ Fan translation by «SyS-team», «Spirit Team», «ENPY Studio»] |fan = yes }} {{L10n/switch |language = Spanish |interface = true |audio = true |subtitles = true |notes = |fan = }} }}