intlify / vue-i18n

Vue I18n for Vue 3
https://vue-i18n.intlify.dev/
MIT License
2.18k stars 334 forks source link

How to include explanatory descriptions for messages in vue-i18n/vue-i18n-next? #71

Open xinbenlv opened 4 years ago

xinbenlv commented 4 years ago

Hi authors and new authors of vue-i18n

In the use cases of ours. We are expanding our i18n to around 50+ languages. Some of the UI strings for i18n are very short, such as button labels (e.g. "Go", "Next", etc, very short and can be interpreted in many ways). We will need to provide some addition context for the translators to understand what the UI strings means. I check the vue-i18n and it seems it only has key-value format. Does it provide anyway to give additional explanatory descriptions? I know we can provide in comments. But comments in both json or yml are not standardized and normally not supported in tooling for reading. We need to send our translation requests to other 3rd-party translation tools so it's better that the input source file of vue-i18n allow official way to specify description.

Such additional information can also include author of each string / unique identifying Id / timestamps etc. Examples are

  1. https://www.mediawiki.org/wiki/Localisation_file_format#Metadata
  2. https://angular.io/guide/i18n#mark-text-for-translations

Until vue-i18n , we might use the .vscode/i18n-ally-reviews.yml which contains description for i18n strings. We are happy that an organization intlify will support vue-i18n from now on and I wonder if such metadata will be standardized and included in future roadmaps

image

kazupon commented 4 years ago

Thank you for your feedback!

Unfortunately, currently, vue-i18n message syntax does not support them :disappointed: But I'll plan to extend the message syntax in the future. :smile: