JSON Resource Bundles - Revision history

Olibouban: /* Typical with Keys for Comments */

2024-04-15T18:38:03Z

Typical with Keys for Comments

← Older revision		Revision as of 18:38, 15 April 2024
Line 16:		Line 16:

	=== Typical with Keys for Comments===		=== Typical with Keys for Comments===
	This file, named for instance ''resources_en.json'', looks similar to a .properties file, with a key/value pair on each line. The first line has a key which start with an underscore, indicating a description for the key just after it. The text for "_description_groupAccessOpen" will not be translated:		This file, named for instance ''resources_en.json'', looks similar to a .properties file, with a key/value pair on each line. The first line has a '''key which start with an underscore''', indicating a description for the key just after it. The text for "_description_groupAccessOpen" will not be translated:
	<pre>		<pre>
	{		{

Llawson: /* Language Tags */

2023-01-17T23:12:24Z

Language Tags

← Older revision		Revision as of 23:12, 17 January 2023
Line 176:		Line 176:
	''' The pattern of the language tag is configurable '''		''' The pattern of the language tag is configurable '''

	In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the [[Group_Configuration_Files#config_lrm_info.properties\|config_lrm_info.properties]] file.		In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the [[Group_Configuration_Files#config_lrm_info.properties\|config_lrm_info.properties]] file. The language tag pattern must match the pattern that are in your resource files. However, your resource files must contain consistent patterns or 'MISSING_KEY' errors may occur.

	~~''' Language tag pattern and Localyzer locales '''~~

	The language tag pattern must match the pattern that are in your resource files. However, your resource files must contain consistent patterns or 'MISSING_KEY' errors may occur.
	~~Examples:~~
	~~{\| class="wikitable" style="border: none; background: none;"~~
	~~\| rowspan="4" style="border: none; background: none;"\|~~
	~~\|+ Resource File Language Tags~~
	~~! scope="col" \| language.tag.pattern~~
	~~! scope="col" \| en_us (base)~~
	~~! scope="col" \| fr_fr~~
	~~! scope="col" \| es~~
	~~! scope="col" \| zh_hans_cn~~
	\|-
	~~\| Language-only (default) \|\| en \|\| fr \|\| es \|\| zh~~
	\|-
	~~\| l-c \|\| en-us \|\| fr-FR \|\| es \|\| zh-hans~~
	\|-
	~~\| l_c_v \|\| en_us \|\| fr_FR \|\| es \|\| zh_hans_cn~~
	\|-
	\|}

Llawson: /* Global Tags */

2023-01-17T22:59:11Z

Global Tags

← Older revision		Revision as of 22:59, 17 January 2023
Line 235:		Line 235:
	''' Global tags are configurable '''		''' Global tags are configurable '''

	In the above example, 'ProjectLogin' is a global tag and needs to added to the ''global.tags'' attribute of the [[Group_Configuration_Files#config_lrm_info.properties\|config_lrm_info.properties]] file. There can be multiple global tags as long as they are at the top of file. In the above example, both ''ProjectLogin'' and ''nestedKey'' could be global tags. Global tags are expected to be in all files...both base and target.		In the above example, 'ProjectLogin' is a global tag and needs to be added to the ''global.tags'' attribute of the [[Group_Configuration_Files#config_lrm_info.properties\|config_lrm_info.properties]] file. There can be multiple global tags as long as they are at the top of file. In the above example, both ''ProjectLogin'' and ''nestedKey'' could be global tags. Global tags are expected to be in all files...both base and target.

Llawson: /* Global Tags */

2023-01-17T22:58:54Z

Global Tags

← Older revision		Revision as of 22:58, 17 January 2023
Line 222:		Line 222:
	A global tag is a static top-level key that is in all files but should be ignored by Localyzer when determining keys to be sent out for translation.		A global tag is a static top-level key that is in all files but should be ignored by Localyzer when determining keys to be sent out for translation.
	Example:		Example:
	{
			{
	"ProjectLogin": {		"ProjectLogin": {
	"nestedKey": {		"nestedKey": {

Llawson: /* Language Tags */

2023-01-17T21:59:46Z

Language Tags

@@ Line 162: / Line 162: @@
 === Language Tags ===
-A language tag is the language code of the resource file's locale and located at the top of the file. When a LRM prep kit file is imported, the language tag will reflect the locale of the imported file.
+A language tag is the language code of the resource file's locale and located at the top of the file. When a Localzyer prep kit file is imported, the language tag will reflect the locale of the imported file.
+    {
@@ Line 218: / Line 218: @@
 |-
 |}

Llawson: /* Language Tags */

2023-01-17T21:54:17Z

Language Tags

← Older revision		Revision as of 21:54, 17 January 2023
Line 200:		Line 200:


	''' ~~LRM~~ ignores the JSON language tag when determining the resource keys '''		''' Localyzer ignores the JSON language tag when determining the resource keys '''

	If a JSON file contains nested keys, then ~~LRM~~ ''flattens out'' the structure so that a unique key can be created. Each field name within the nested object has a separator of '''''_^o^_'''''. The language tag is not included in the creation of the unique key. The following is an example of the unique LRM resource keys created from the above JSON file.		If a JSON file contains nested keys, then Localyzer ''flattens out'' the structure so that a unique key can be created. Each field name within the nested object has a separator of '''''_^o^_'''''. The language tag is not included in the creation of the unique key. The following is an example of the unique LRM resource keys created from the above JSON file.

	~~The~~ key/value pairs created by ~~LRM are~~:		Example of the key/value pairs created by Localyzer for the above file:

	{\| class="wikitable" style="border: none; background: none;"		{\| class="wikitable" style="border: none; background: none;"

Llawson: /* Language Tags */

2023-01-17T21:52:05Z

Language Tags

← Older revision		Revision as of 21:52, 17 January 2023
Line 184:		Line 184:
	{\| class="wikitable" style="border: none; background: none;"		{\| class="wikitable" style="border: none; background: none;"
	\| rowspan="4" style="border: none; background: none;"\|		\| rowspan="4" style="border: none; background: none;"\|
	\|+ Resource ~~Files~~ Language Tags		\|+ Resource File Language Tags
	! scope="col" \| language.tag.pattern		! scope="col" \| language.tag.pattern
	! scope="col" \| en_us (base)		! scope="col" \| en_us (base)

Llawson: /* Language Tags */

2023-01-17T21:51:20Z

Language Tags

@@ Line 176: / Line 176: @@
 ''' The pattern of the language tag is configurable '''
-In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the [[Group_Configuration_Files#config_lrm_info.properties|config_lrm_info.properties]] file. If your base resource file has 'en-us' as its language tag, then the pattern needs to be ''l-c''. Using this pattern, locale 'fr_FR' and 'zh' json language tags would be 'fr-fr' and 'zh' respectively (case insensitive). If you create a pattern such as 'l-c' and your base or target locale has a country code, then the language tag in your resource files must contain a country code otherwise 'MISSING_KEY' errors will occur.
+In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the [[Group_Configuration_Files#config_lrm_info.properties|config_lrm_info.properties]] file.
 ''' LRM ignores the JSON language tag when determining the resource keys '''

Llawson: /* Language Tags */

2023-01-17T21:34:30Z

Language Tags

← Older revision		Revision as of 21:34, 17 January 2023
Line 176:		Line 176:
	''' The pattern of the language tag is configurable '''		''' The pattern of the language tag is configurable '''

	In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the config_lrm_info.properties file. If your base resource file has 'en-us' as its language tag, then the pattern needs to be ''l-c''. Using this pattern, locale 'fr_FR' and 'zh' json language tags would be 'fr-fr' and 'zh' respectively (case insensitive). If you create a pattern such as 'l-c' and your base or target locale has a country code, then the language tag in your resource files must contain a country code otherwise 'MISSING_KEY' errors will occur.		In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the [[Group_Configuration_Files#config_lrm_info.properties\|config_lrm_info.properties]] file. If your base resource file has 'en-us' as its language tag, then the pattern needs to be ''l-c''. Using this pattern, locale 'fr_FR' and 'zh' json language tags would be 'fr-fr' and 'zh' respectively (case insensitive). If you create a pattern such as 'l-c' and your base or target locale has a country code, then the language tag in your resource files must contain a country code otherwise 'MISSING_KEY' errors will occur.

	''' LRM ignores the JSON language tag when determining the resource keys '''		''' LRM ignores the JSON language tag when determining the resource keys '''

Llawson: /* Language Tags */

2023-01-17T21:33:26Z

Language Tags

← Older revision		Revision as of 21:33, 17 January 2023
Line 176:		Line 176:
	''' The pattern of the language tag is configurable '''		''' The pattern of the language tag is configurable '''

	In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the config_lrm_info.properties file. If your base resource file has 'en-us' as its language tag, then the pattern needs to be ''l-c''. Using this pattern, locale 'fr_FR' and 'zh' json language tags would be 'fr-fr' and 'zh' respectively (case insensitive)		In the above example, 'en' is a language-only language tag. This is the default pattern. The language tag pattern is configurable through the config_lrm_info.properties file. If your base resource file has 'en-us' as its language tag, then the pattern needs to be ''l-c''. Using this pattern, locale 'fr_FR' and 'zh' json language tags would be 'fr-fr' and 'zh' respectively (case insensitive). If you create a pattern such as 'l-c' and your base or target locale has a country code, then the language tag in your resource files must contain a country code otherwise 'MISSING_KEY' errors will occur.

	''' LRM ignores the JSON language tag when determining the resource keys '''		''' LRM ignores the JSON language tag when determining the resource keys '''

← Older revision		Revision as of 21:52, 17 January 2023
Line 184:		Line 184:
	{\| class="wikitable" style="border: none; background: none;"		{\| class="wikitable" style="border: none; background: none;"
	\| rowspan="4" style="border: none; background: none;"\|		\| rowspan="4" style="border: none; background: none;"\|
	\|+ Resource ~~Files~~ Language Tags		\|+ Resource File Language Tags
	! scope="col" \| language.tag.pattern		! scope="col" \| language.tag.pattern
	! scope="col" \| en_us (base)		! scope="col" \| en_us (base)