From d1b6ad4d36b4c488b47815fdf14b480f4eea1a6e Mon Sep 17 00:00:00 2001 From: Shane Exterkamp Date: Fri, 4 Oct 2019 10:03:41 -0700 Subject: [PATCH 1/2] docs(i18n): add mentions of meaning to i18n readme --- lighthouse-core/lib/i18n/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lighthouse-core/lib/i18n/README.md b/lighthouse-core/lib/i18n/README.md index 35c61af0a711..02557734b8cc 100644 --- a/lighthouse-core/lib/i18n/README.md +++ b/lighthouse-core/lib/i18n/README.md @@ -1,6 +1,6 @@ # Terminology -* **CTC format**: The [Chrome extension & Chrome app i18n format](https://developer.chrome.com/extensions/i18n-messages). JSON with their specified model for declaring placeholders, examples, etc. Used as an interchange data format. +* **CTC format**: The [Chrome extension & Chrome app i18n format](https://developer.chrome.com/extensions/i18n-messages). JSON with their specified model for declaring placeholders, examples, etc. Used as an interchange data format. With some minor changes. * **LHL syntax** (Lighthouse Localizable syntax): The ICU-friendly string syntax that is used to author `UIStrings` and is seen in the locale files in `i18n/locales/*.json`. Lighthouse has a custom syntax these strings combines many ICU message features along with some markdown. * **ICU**: ICU (International Components for Unicode) is a localization project and standard defined by the Unicode consortium. In general, we refer to "ICU" as the [ICU message formatting](http://userguide.icu-project.org/formatparse/messages) syntax. @@ -202,6 +202,7 @@ CTC is a name that is distinct and identifies this as the Chrome translation for "name": { "message": "Message text, with optional placeholders.", "description": "Translator-aimed description of the message.", + "meaning": "Description given when a message is duplicated, in order to give context to the message.", "placeholders": { "placeholder_name": { "content": "A string to be placed within the message.", From 2757b0b5e64495e4a40fecfccf07bd7f42a2e3b5 Mon Sep 17 00:00:00 2001 From: Shane Exterkamp Date: Mon, 7 Oct 2019 16:58:25 -0700 Subject: [PATCH 2/2] feedback --- lighthouse-core/lib/i18n/README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/lighthouse-core/lib/i18n/README.md b/lighthouse-core/lib/i18n/README.md index 02557734b8cc..8ec3779d9b96 100644 --- a/lighthouse-core/lib/i18n/README.md +++ b/lighthouse-core/lib/i18n/README.md @@ -1,6 +1,6 @@ # Terminology -* **CTC format**: The [Chrome extension & Chrome app i18n format](https://developer.chrome.com/extensions/i18n-messages). JSON with their specified model for declaring placeholders, examples, etc. Used as an interchange data format. With some minor changes. +* **CTC format**: The [Chrome extension & Chrome app i18n format](https://developer.chrome.com/extensions/i18n-messages) with some minor changes. JSON with their specified model for declaring placeholders, examples, etc. Used as an interchange data format. * **LHL syntax** (Lighthouse Localizable syntax): The ICU-friendly string syntax that is used to author `UIStrings` and is seen in the locale files in `i18n/locales/*.json`. Lighthouse has a custom syntax these strings combines many ICU message features along with some markdown. * **ICU**: ICU (International Components for Unicode) is a localization project and standard defined by the Unicode consortium. In general, we refer to "ICU" as the [ICU message formatting](http://userguide.icu-project.org/formatparse/messages) syntax. @@ -195,14 +195,12 @@ CTC is a name that is distinct and identifies this as the Chrome translation for ### Parts of a CTC message -(From the Chrome Docs) - ```json { "name": { "message": "Message text, with optional placeholders.", "description": "Translator-aimed description of the message.", - "meaning": "Description given when a message is duplicated, in order to give context to the message.", + "meaning": "Description given when a message is duplicated, in order to give context to the message. Lighthouse uses a copy of the description for this.", "placeholders": { "placeholder_name": { "content": "A string to be placed within the message.",