]> git.xonotic.org Git - xonotic/xonotic.wiki.git/commitdiff
Improve presentation a bit
authorSpiKe <leguen.yannick@gmail.com>
Sat, 5 Oct 2019 16:53:09 +0000 (16:53 +0000)
committerSpiKe <leguen.yannick@gmail.com>
Sat, 5 Oct 2019 16:53:09 +0000 (16:53 +0000)
Translation-guidelines.md

index b3401c1a45ffe85e49efe9fc7ea194271b82c0ea..a857dd3ba644481cb9253470a29402f64afdc0ea 100644 (file)
@@ -4,17 +4,17 @@
 
 -   Always match variables in the strings properly, as explained here: http://docs.translatehouse.org/projects/localization-guide/en/latest/guide/translation/variables.html
 
--   Keep color codes the same, like ^BG or ^TC or ^F4 or ^2, these are special color codes and are handled by the HUD/text rendering code. See the [List of color codes](List of color codes).
+-   Keep color codes the same, like `^BG` or `^TC` or `^F4` or `^2`, these are special color codes and are handled by the HUD/text rendering code. See the [List of color codes](List of color codes).
 
 -   Normally do not translate proper nouns, like most weapon names (excluding Machinegun, Shotgun, etc), or game mode names, unless they make sense in your language to be translated. Mutators CAN be translated, but not mutators which have proper names, like "MinstaGib", or "NIX" which is an acronym.
 
 -   Pay attention to capitalization... scoreboard columns for example are intended to be lowercase. In general, it's always a good idea to follow the context of the English writing, and make sure the capitalization matches in English (Unless your language has some other grammatical rule that makes more sense here.)
 
--   Strings that have **no English words** do not need to be translated, like "%s %s (%s%s)" should not be translated: if you see these, please report them on https://gitlab.com/xonotic/xonotic-data.pk3dir, as they should not have been added in the first place.
+-   Strings that have **no English words** do not need to be translated, like `%s %s (%s%s)` should not be translated: if you see these, please report them on https://gitlab.com/xonotic/xonotic-data.pk3dir, as they should not have been added in the first place.
 
--   If you are even slightly unsure of the context or meaning of a string, read the code or ask someone on IRC, if you're still unable to be 100% sure, then mark your string as a "suggestion" on Transifex and MOVE ON, do not risk adding an improper translation.
+-   If you are even slightly unsure of the context or meaning of a string, read the code or ask someone on IRC, if you're still unable to be 100% sure, then mark your string as a *suggestion* on Transifex and MOVE ON, do not risk adding an improper translation.
 
--   Some strings have prefixes which help you know the context of the string... For example, say there is a listbox in the menu which controls effects settings, we can add a prefix into the translatable string for each item in the list like this: "PREFIX^translatable text". In the case of effects, we can do: "EFFECTS^Low", "EFFECTS^Medium", and "EFFECTS^High", and you can then know the context of the Low/Medium/High translation easily. When forming the final translated string, REMOVE THE PREFIX AND THE ^ SYMBOL. However, be careful not to confuse these with color codes or intentional placements of ^. If in doubt, read the code, context sensitive lines of code which use this prefix idea will have a ZCTX() or CTX() wrapper around the whole string, giving you a good clarification as to how to proceed. Please refer to the [List of prefixes](List of prefixes).
+-   Some strings have prefixes which help you know the context of the string... For example, say there is a list box in the menu which controls effects settings, we can add a prefix into the translatable string for each item in the list like this: `PREFIX^translatable text`. In the case of effects, we can do: `EFFECTS^Low`, `EFFECTS^Medium`, and `EFFECTS^High`, and you can then know the context of the Low/Medium/High translation easily. When forming the final translated string, REMOVE THE PREFIX AND THE ^ SYMBOL. However, be careful not to confuse these with color codes or intentional placements of ^. If in doubt, read the code, context sensitive lines of code which use this prefix idea will have a ZCTX() or CTX() wrapper around the whole string, giving you a good clarification as to how to proceed. Please refer to the [List of prefixes](List of prefixes).
 
 -   NEVER pervert, profane, or mock a string that is not normally written as such in English. If there is no joke or gore in the English writing, do not add one in the translation. We must adhere to supporting cl_gentle (a non-swearing, "E rated" version of the texts) even in translations.