Formatos das mensagens de localização

{
  "name": {
    "message": "Message text, with optional placeholders.",
    "description": "Translator-aimed description of the message.",
    "placeholders": {
      "placeholder_name": {
        "content": "A string to be placed within the message.",
        "example": "Translator-aimed example of the placeholder string."
      },
      ...
    }
  },
  ...
}

{
  "prompt_for_name": {
    "message": "What's your name?",
    "description": "Ask for the user's name"
  },
  "hello": {
    "message": "Hello, $USER$",
    "description": "Greet the user",
    "placeholders": {
      "user": {
        "content": "$1",
        "example": "Cira"
      }
    }
  },
  "bye": {
    "message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!",
    "description": "Say goodbye to the user",
    "placeholders": {
      "our_site": {
        "content": "Example.com",
      },
      "user": {
        "content": "$1",
        "example": "Cira"
      }
    }
  }
}

"prompt_for_name": {
  ...
},
"hello": {
  ...
},
"bye": {
  ...
}

"message": "What's your name?"
...
"message": "Hello, $USER$"
...
"message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!"

"message": "Amount (in $$)"

Embora os marcadores de posição, como $USER$, sejam a maneira preferida de se referir a strings de substituição,
strings especificadas usando o parâmetro substitutions de i18n.getMessage, também é possível se referir
a strings de substituição diretamente na mensagem. Por exemplo, a mensagem a seguir se refere às
três primeiras strings de substituição transmitidas para getMessage():
"message": "Params: $1, $2, $3"

Apesar desse exemplo, recomendamos que você use marcadores de posição em vez de strings $_n_
nas suas mensagens. Pense nos marcadores de posição como bons nomes de variáveis. Uma semana depois de escrever o
código, você provavelmente vai esquecer a que $1 se refere, mas vai saber a que os marcadores de posição se referem.
Para mais informações sobre marcadores de posição e strings de substituição, consulte a seção marcadores de posição.

descrição

Opcional. Uma descrição da mensagem, destinada a fornecer contexto ou detalhes para ajudar o tradutor
a fazer a melhor tradução possível.

Confira três exemplos de descrições, retirados da seção Exemplo:
"description": "Ask for the user's name"
...
"description": "Greet the user"
...
"description": "Say goodbye to the user"

marcadores de posição

Opcional. Define uma ou mais substrings a serem usadas na mensagem. Confira dois motivos para usar um marcador de posição:


Para definir o texto de uma parte da sua mensagem que não deve ser traduzida. Exemplos: código HTML, nomes de marcas registradas e especificadores de formatação.
Para se referir a uma string de substituição transmitida para getMessage(). Exemplo: $1.


Cada marcador de posição tem um nome, um item "conteúdo" e um item "exemplo" opcional. O nome de um marcador de posição
não diferencia maiúsculas de minúsculas e pode conter os mesmos caracteres de um nome de mensagem.

O valor do item "content" é uma string que pode se referir a strings de substituição, que são especificadas
usando o parâmetro substitutions do método i18n.getMessage. O valor de um item de "conteúdo" geralmente é algo como "Example.com" ou "US$ 1". Ao se referir a uma string de substituição que não existe, você receberá uma string vazia. A tabela a seguir mostra como as strings $_n_ correspondem a strings
especificadas pelo parâmetro substitutions.

parâmetro overrides
Valor de US $1
Valor de US $2
Valor de US $3
userName
valor de userName
""
""
["Cira", "Kathy"]
"Cira"
"Kathy"
""

O item "example" (opcional, mas altamente recomendado) ajuda os tradutores mostrando como o conteúdo
é exibido para o usuário final. Por exemplo, um marcador de posição para um valor em dólares precisa ter um exemplo como
"$23.45".

O snippet a seguir, retirado da seção Exemplo, mostra um item "placeholders" que
contém dois marcadores de posição chamados "our_site" e "user". O marcador de posição "our_site" não tem o item "example"
porque o valor dele é óbvio no campo "content".
"placeholders": {
  "our_site": {
    "content": "Example.com",
  },
  "user": {
    "content": "$1",
    "example": "Cira"
  }
}