Mark and remove some translations #5110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Stefan Parviainen <[email protected]>
Signed-off-by: Stefan Parviainen <[email protected]>
Signed-off-by: Stefan Parviainen <[email protected]>
lukebarnard1
suggested changes
Oct 3, 2017
docs/translating-dev.md
Outdated
| @@ -6,10 +6,16 @@ | |||
| - Be able to understand English | |||
| - Be able to understand the language you want to translate riot-web into | |||
|
|
|||
| ## Translating strings vs. marking strings for translation | |||
|
|
|||
| Translating strings are done with the `_t()` function found in matrix-react-sdk/lib/languageHandler.js. It is recommended to call this function wherever you introduce a string constant which should be translated. However, translating can not be performed until after the translation system has been initialized. Thus, sometimes translation must be performed at a different location in the source code than where the string is introduced. This breaks some tooling and makes it difficult to find translatable strings. Therefore, there is the alternative `_td()` function which is used to mark strings for translation, without actually performig the translation (which must still be performed separately, and after the translation system has been initialized). | |||
There was a problem hiding this comment.
I think it would be useful to provide a small code-snippet example of a string being defined as a module constant, and then later translating at the point of rendering.
docs/translating-dev.md
Outdated
| @@ -21,6 +27,8 @@ | |||
|
|
|||
| ## Things to know/Style Guides | |||
|
|
|||
| - Do not use it inside ``getDefaultProps`` at the point where ``getDefaultProps`` is initialized the translations aren't loaded yet and it causes missing translations. | |||
| - If using translated strings as constants, translated strings can't be in constants loaded at class-load time since the translations won't be loaded. | |||
| - Do not use `_t()` inside ``getDefaultProps`` at the point where ``getDefaultProps`` is initialized when the translations aren't loaded yet and it causes missing translations. Use `_td()` instead and perform the actual translation later. | |||
There was a problem hiding this comment.
Can I suggest, "Do not use _t() inside getDefaultProps: the translations aren't loaded when getDefaultProps is called, leading to missing translations. Use _td to indicate that _t will be called on the string later "
docs/translating-dev.md
Outdated
| - If a string is presented in the UI with punctuation like a full stop, include this in the translation strings, since punctuation varies between languages too. | ||
| - Avoid "translation in parts", i.e. concatenating translated strings or using translated strings in variable substitutions. Context is important for translations, and translating partial strings this way is simply not always possible. | ||
| - Concatenating strings often also introduces an implicit assumption about word order (e.g. that the subject of the sentence comes first), which is incorrect for many languages. |
There was a problem hiding this comment.
Some very good advice, thanks for this 😃
|
So apparently |
|
It depends on matrix-org/matrix-react-sdk#1421 which has not been merged. Perhaps that is the problem? |
|
Ah, yep that will be it. I'll merge that and then rerun the tests here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mark some strings as translatable in the source code, and remove some obsolete strings. Depends on matrix-org/matrix-react-sdk#1421
The following strings were found to be unnecessary: