Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Glossary and Style Guide #4

Closed
WendellAdriel opened this issue Feb 8, 2019 · 90 comments
Closed

Glossary and Style Guide #4

WendellAdriel opened this issue Feb 8, 2019 · 90 comments

Comments

@WendellAdriel
Copy link
Member

WendellAdriel commented Feb 8, 2019

Style Guide

  • Leave code blocks untranslated. (It is usually OK to translate comments inside them. edit by @cezaraugusto: also strings inside HTML/JSX can also pass but use your best judgement)
  • Links to references (MDN, Wikipedia) should go to the Portuguese version.
  • When referring to React itself, use o React.

Common Translations

Suggestion on words and terms:

Original word/term Suggestion
bug erro
class classe
context contexto
controlled component componente controlado
debugging depuração
functional component componente funcional
key chave
library biblioteca
lowercase minúscula(s)
package pacote
React element Elemento React
React fragment Fragmento React
render renderizar (verb), renderizado (noun)
uncontrolled component componente não controlado

Content that doesn't need translation

  • array
  • arrow function
  • bind
  • bundle
  • bundler
  • camelCase
  • callback
  • DOM
  • framework
  • hook
  • mock
  • portal
  • props
  • ref
  • state
  • string
  • template literal
  • UI
  • log
@eduardomoroni
Copy link
Member

is bind one of them?

@WendellAdriel
Copy link
Member Author

I think that bind needs to be translated, something link vincular, do you agree with that @eduardomoroni? we can put on the suggested list

@eduardomoroni
Copy link
Member

If you take a look at this translation proposal #3, sometimes it makes sense to not translate bind, because you might be referencing the bind method.
But we translate bound and translate only the past tense, then the reading can be confusing for those who don't know what bind means.

I don't know what is the better way to approach honestly, but I think that making use of:

os métodos de classe que não foram bind

instead of

os métodos de classe que não foram vinculados

Can be friendlier for those with no knowledge of English and/or JS. Because people will understand that we're talking about the bind method.

@WendellAdriel
Copy link
Member Author

I understood the issue. I finished reading the translation proposal now and yeah, it can be confusing. I think that bind can be a word that we won't translate.

We can also use os métodos de classe que não foram feito bind.

I'll add that to the glossary

@glaucia86
Copy link
Member

glaucia86 commented Feb 8, 2019

I think that bind needs to be translated, something link vincular, do you agree with that @eduardomoroni? we can put on the suggested list

Agree w/ @eduardomoroni many of video tutorials in portuguese teachs as 'bind'. I think unnecessary translate this word to portuguese.

@WendellAdriel
Copy link
Member Author

I want your opinions on this one: the verb log, what do you think is the best option to translate this one? @glaucia86, @eduardomoroni?

@rafaelquintanilha
Copy link
Contributor

rafaelquintanilha commented Feb 8, 2019

I want your opinions on this one: the verb log, what do you think is the best option to translate this one? @glaucia86, @eduardomoroni?

I don't think this has a good translation (mainly if you consider its etymology as a reference to wooden logs). My suggestion is that we treat it as a noun, like "adicionar ao log", "remover do log", etc.

@eduardomoroni
Copy link
Member

I think we don't need to translate log as well, I remember the first time someone translated Arcabouço in a talk, It took me like 5min to understand that they were talking about a framework.
I someone doesn't understand log, they could easily google for it and figure out for themselves.

@WendellAdriel
Copy link
Member Author

Yeah, I was thinking about that, but when we have something like "logs SOMETHING to the console". Which expression can I use to refer to that? I mean, what's the best option?

@rafaelquintanilha
Copy link
Contributor

rafaelquintanilha commented Feb 8, 2019

Yeah, I was thinking about that, but when we have something like "logs SOMETHING to the console". Which expression can I use to refer to that? I mean, what's the best option?

I was thinking about that when I was trying to translate print. Feels really weird to say imprimir even if the translation is pretty accurate (feels like people always say printar). Maybe we can unify both cases and say imprimir no console (the least bad translation I can think of).

@WendellAdriel
Copy link
Member Author

Yeah, I was thinking about two options:

  • escrever no console
  • imprimir no console

@fjoshuajr
Copy link
Collaborator

I'm of the opinion that we should use 'imprimir no console'.

And what about markup? As in 'render components to static markup'.
I was thinking: 'renderizar componentes para markup estático'

@fjoshuajr
Copy link
Collaborator

'siblings' as well.
e.g. 'Keys used within arrays should be unique among their siblings'

Possible options:

  • 'elementos irmãos'
    or
  • 'items irmãos'

@cezaraugusto
Copy link
Member

words that are also method names such as "bind", "call", "apply" should be translated along the original inside parenthesis such as ... conectar (bind) or similar.

hard to tell without context but as PRs start to come using these terms we can refine the glossary

@cezaraugusto
Copy link
Member

also applies for "state" for example i.e. "mudança de estado (state)". it's important to educate non-English readers about the word meaning without losing context

@fjoshuajr
Copy link
Collaborator

words that are also method names such as "bind", "call", "apply" should be translated along the original inside parenthesis such as ... conectar (bind) or similar.

Yeah, I liked this idea.

@glaucia86
Copy link
Member

I want your opinions on this one: the verb log, what do you think is the best option to translate this one? @glaucia86, @eduardomoroni?

I don't think this has a good translation (mainly if you consider its etymology as a reference to wooden logs). My suggestion is that we treat it as a noun, like "adicionar ao log", "remover do log", etc.

Agree! Do not need a translation to log word

@glaucia86
Copy link
Member

I'll include log as a word unnecessary to translate

@cezaraugusto
Copy link
Member

cezaraugusto commented Feb 8, 2019

not sure if it was mentioned somewhere else but we should consider not translating code blocks (comments allowed). I'm better if we do not but don't have a strong opinion. what do you all think?

@WendellAdriel
Copy link
Member Author

It's the first item on the issue @cezaraugusto!!! 😉

@WendellAdriel WendellAdriel changed the title Glossary Glossary and Style Guide Feb 8, 2019
@cezaraugusto
Copy link
Member

lol thanks @WendellAdriel

@WendellAdriel
Copy link
Member Author

So, when translating something that relates to the React word, we need to define here a standard and stick to it, should we use:

  • React
  • a React
  • o React

After defined, we need to include that on the Style Guide above.

cc: @glaucia86 @cezaraugusto @fjoshuajr

@cezaraugusto
Copy link
Member

"o React" sounds good

@fjoshuajr
Copy link
Collaborator

So, when translating something that relates to the React word, we need to define here a standard and stick to it, should we use:

  • React
  • a React
  • o React

After defined, we need to include that on the Style Guide above.

cc: @glaucia86 @cezaraugusto @fjoshuajr

  • o React

@renato-bohler
Copy link
Contributor

Should we translate high order component? Don't think so...

@lamecksilva
Copy link
Contributor

"codebase" = "base de código" or "código-base" ?

@mrcelo
Copy link
Contributor

mrcelo commented Feb 8, 2019

"codebase" = "base de código" or "código-base" ?

+1 "código-base"

@lamecksilva
Copy link
Contributor

"código-base" then

@halian-vilela
Copy link
Collaborator

I'm not sure how to translate Composing Components?

Could you give us a little more context?

It's this section in Components and Props: https://reactjs.org/docs/components-and-props.html#composing-components

It's about using the same component but with different props.

I would go with "Compondo componentes" to keep coherence with the next section "Extraindo componentes"

@halian-vilela
Copy link
Collaborator

Should we translate high order component? Don't think so...

We should check how classic authors of Functional Programming were translated. I did a quick check in Wikipedia for Higher-order function but there's no Portuguese translation albeit all the available translations of the article were pretty literal, the Spanish one being what could be the most accurate, something like "Função de ordem superior" --> "Componente de ordem superior".

But it's a bit boring I guess, too formal... hahaha

@fmoliveira
Copy link
Contributor

Hey guys,
What about Error Boundaries? It's not listed above but I haven't seen anybody translating it in blog posts. Should we leave it in English or translate it anyway? What do you think? 🤔

@halian-vilela
Copy link
Collaborator

Hey guys,
What about Error Boundaries? It's not listed above but I haven't seen anybody translating it in blog posts. Should we leave it in English or translate it anyway? What do you think? 🤔

For the sake of searchability, I don't think this kind of terms that almost compound a noun should be translated. It will be easier in the future for a user willing to know how to use error boudaries to search for this name than for "Limites de Erro" or "Fronteiras de Erro".

I've just translated the page for "Error Decoder" but I think that's different for not being a "feature" per se, it's rather just a description of a behaviour.

Makes sense?

@fmoliveira
Copy link
Contributor

Makes total sense @halian-vilela ! Searchability is a great argument for that. 👍

Thank you!

@thealexandrelara
Copy link
Contributor

Should we translate the term lifecycle?

Examples:

Hooks let you organize side effects in a component by what pieces are related (such as adding and removing a subscription), rather than forcing a split based on lifecycle methods.

We'll talk more about how this compares to class lifecycles in [Using the Effect Hook]

I don't think so.

I think that it should be translated to:
Lifecycle methods = Métodos do Ciclo de Vida
Class lifecycles = Ciclos de vida da classe

@eduardomoroni
Copy link
Member

is bug === erro === error?

@halian-vilela
Copy link
Collaborator

halian-vilela commented Feb 9, 2019

Hey @eduardomoroni

is bug === erro === error?

I think semantically yes, but the context where they are used are pretty different.

bug: something unpredicted, not obvious or easy to spot, generally in the source code of the main codebase or associated libraries which prevents the code from running as expected

error: the result of a bug, which can be seem by an error message or something similar


That's raises the doubt if bug shouldn't be considered as "doesn't need translation".

What do you guys think?

@jancassio
Copy link
Contributor

Guys, are you really translating Context (the name of Context api) to "Contexto"?

Since props is never translated to "propiedades", I don't think it makes any sense to describe Context API using the pt-BR word "Contexto". It could confuse readers about what's Context (the api) and "Contexto" at all.

@taynancid
Copy link
Contributor

hi people,
what do you think is the best translation for "opt-in feature"?

@klzns
Copy link
Contributor

klzns commented Feb 9, 2019

"codebase" = "base de código" or "código-base" ?

I think that better translates to "base de código".

"Código-base" would be something like "base code"?

In context it even makes more sense:

Vou procurar na minha base de código.

Vou procurar no meu código-base.

@klzns
Copy link
Contributor

klzns commented Feb 9, 2019

Guys, are you really translating Context (the name of Context api) to "Contexto"?

Since props is never translated to "propiedades", I don't think it makes any sense to describe Context API using the pt-BR word "Contexto". It could confuse readers about what's Context (the api) and "Contexto" at all.

That's a good point. I would stick with Context.

@michellocana
Copy link
Contributor

hi people,
what do you think is the best translation for "opt-in feature"?

it depends of the context, but maybe "funcionalidade opcional"?

@michellocana
Copy link
Contributor

what about

[...] ReactDOM.render() does not modify the container node

should we use "nodo contêiner" or "elemento contêiner"?

@moiseshilario
Copy link
Contributor

How do you guys would translate "userland" ?

@michellocana
Copy link
Contributor

michellocana commented Feb 9, 2019

How do you guys would translate "userland" ?

@moiseshilario, if the phrase below is the one you are translating,

In general we resist adding features that can be implemented in userland.

i would translate to something like "[...] que podem ser implementadas do lado do usuário"

@tibuurcio
Copy link
Collaborator

tibuurcio commented Feb 9, 2019

@moiseshilario @michellocana This is entirely personal but I believe userland could be translated as comunidade, at least in your example, since it usually refers to open-source packages written by the community.

In general we resist adding features that can be implemented in userland.

[...] que podem ser implementadas pela comunidade.

@gmsecrieru
Copy link
Member

Hey everybody! Thanks for all the contributions and suggestions.

Defining common translations in a single issue makes it harder to keep track in the long term and also to reach consistency throughout our content.

We are starting to version control our Glossary (see #46) so if you would like to ask for suggestions on how to translate a given term please open an Issue for it. This will help to focus the discussion for each term while also helping to keep track when/how each term was added to our Glossary since we can link each issue to its own Pull Request.

Thanks again!

@GCrispino
Copy link
Contributor

Hi! Should/How should we translate:

  • Warning article titles
    • e.g "Refs Must Have Owner Warning" (I translated it as "Aviso de Refs Precisam Ter um Dono")
    • Another approach would be to leave them untranslated.
    • Or meet it halfway (something like "Aviso 'Refs Must Have Owner'"
  • Hyperlinks for specific sections
    • e.g: #strings-refs-outside-the-render-method in refs-must-have-owner (My approach was to leave it as is)
  • Terms like ref (I left as is, too)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests