Add initial i18n documentation #222

TheZoker · 2022-04-04T17:26:48Z

Adds initial i18n documentation

Closes #207

sdirix

I added some suggestions. Please add them as you see fit and make sure the document is in a good state overall.

content/docs/i18n.mdx

sdirix · 2022-04-12T07:50:31Z

content/docs/i18n.mdx

+The paths in the above example would be:
+- `firstName.label` & `firstName.description`
+- `address.street.label` & `address.street.description`
+- `comments.message.label` & `comments.message.description` (the path for arrays will not contain indices)


Can you check whether address.label, address.description and comments.label, comments.description is also called?

content/docs/i18n.mdx

Co-authored-by: Stefan Dirix <sdirix@eclipsesource.com>

sdirix · 2022-04-12T10:56:26Z

@LukasBoll

With this documentation, please try to implement translation support in the JSON Forms React seed (first update to the latest JSON Forms).

Please review and identify potential problems with the current documentation. Please test exhaustively and question all information. Try all kind of translations (usual, errors, enums) and using the translation support in a custom renderer.

LukasBoll · 2022-05-09T10:10:55Z

Documentation looks good to me!
Currently Enum options only change, when the translation function changes, but not if only the locale changes. Maybe we should address the in the future.

sdirix · 2022-07-12T07:52:47Z

Document new UI schema element translation, see here
Document handed over parameters (look through code base), e.g. schema, path, uischema etc.

Signed-off-by: Lukas Boll lukas-bool@web.de

lucas-koehler

Looks already pretty good to me.
Please note that the i18n prop is now directly defined in control elements (see inline comment).
Furthermore, I provided some grammar/wording/typo fixes I noticed ;)

lucas-koehler · 2022-09-22T13:59:08Z

content/docs/i18n.mdx

+(key: string, defaultMessage: string | undefined, context: any) => string | undefined)
+```
+
+and there for has the following parameters:


Suggested change

and there for has the following parameters:

with the following parameters:

lucas-koehler · 2022-09-22T14:00:05Z

content/docs/i18n.mdx

+
+## `locale`
+
+Allows to specify the current locale of the application.


Suggested change

Allows to specify the current locale of the application.

Specifies the current locale of the application.

lucas-koehler · 2022-09-22T14:00:42Z

content/docs/i18n.mdx

+
+## `translate`
+
+Allows to provide a translation function, which handles the actual translation.


Suggested change

Allows to provide a translation function, which handles the actual translation.

Provides a translation function handling the actual translation.

lucas-koehler · 2022-09-22T14:01:26Z

content/docs/i18n.mdx

+/>
+```
+
+The i18n prop consist of three components: `locale`, `translate` and `translateError`. 


Suggested change

The i18n prop consist of three components: `locale`, `translate` and `translateError`.

The `i18n` prop consists of three components: `locale`, `translate` and `translateError`.

lucas-koehler · 2022-09-22T14:02:01Z

content/docs/i18n.mdx

+
+### `key`
+
+The key is used to identify the string, that needs to be translated.


Suggested change

The key is used to identify the string, that needs to be translated.

The key is used to identify the string that needs to be translated.

lucas-koehler · 2022-09-22T14:04:04Z

content/docs/i18n.mdx

+} 
+```
+
+Therefore the translation will be invoked with `myCustomName.label` & `myCustomName.description`.


Suggested change

Therefore the translation will be invoked with `myCustomName.label` & `myCustomName.description`.

Therefore, the translation will be invoked with `myCustomName.label` & `myCustomName.description`.

lucas-koehler · 2022-09-22T14:04:34Z

content/docs/i18n.mdx

+}
+```
+
+The paths in the above example would be:


Suggested change

The paths in the above example would be:

The paths in the above example are:

lucas-koehler · 2022-09-22T14:05:30Z

content/docs/i18n.mdx

+
+:::note
+
+If the `defaultMessage` is `undefined` you should also return `undefined` if you don't have a translation for the given key.


Suggested change

If the `defaultMessage` is `undefined` you should also return `undefined` if you don't have a translation for the given key.

If the `defaultMessage` is `undefined`, you should also return `undefined` if there is no translation for the given key.

lucas-koehler · 2022-09-22T14:07:53Z

content/docs/i18n.mdx

+
+<ValuesTable/>
+
+Schema translation provide all properties, while UI schema translations only provide the `uischema`-property.


Suggested change

Schema translation provide all properties, while UI schema translations only provide the `uischema`-property.

Schema translations provide all properties, while UI schema translations only provide the `uischema` property.

lucas-koehler · 2022-09-22T14:20:29Z

content/docs/i18n.mdx

+
+If a i18n-key is provided in a `group` or `category` element, `<i18n>.label` will be used as key.  
+If no i18n key is provided, the value of the `label`-property is used as key.  
+In case nether a i18n-key nor a label is provided, `<property-path>.label` will be used as default key.


Suggested change

In case nether a i18n-key nor a label is provided, `<property-path>.label` will be used as default key.

In case neither a i18n-key nor a label is provided, `<property-path>.label` will be used as default key.

lucas-koehler

LGTM now, thanks for the updates!

TheZoker added 3 commits April 4, 2022 19:23

Add initial i18n documentation

31e77ed

Enhance i18n documentation

113793b

Add error customization

331dffe

sdirix requested changes Apr 12, 2022

View reviewed changes

Apply suggestions from code review

c3ef2bb

Co-authored-by: Stefan Dirix <sdirix@eclipsesource.com>

TheZoker force-pushed the i18n branch from 6d26a67 to 892a87c Compare April 12, 2022 10:12

Apply more suggestions from code review

cbcf7b5

TheZoker force-pushed the i18n branch from 892a87c to cbcf7b5 Compare April 12, 2022 10:19

Enhance i18n doc

a57605d

TheZoker requested a review from sdirix April 12, 2022 10:49

sdirix requested a review from LukasBoll April 12, 2022 10:52

Add missing useMemo()

2f886df

LukasBoll approved these changes May 9, 2022

View reviewed changes

TheZoker marked this pull request as ready for review May 10, 2022 23:27

sdirix mentioned this pull request Jun 23, 2022

Documentation for i18n support eclipsesource/jsonforms#1963

Closed

sdirix mentioned this pull request Aug 24, 2022

Missing or hard to find "localization guide" eclipsesource/jsonforms#2010

Closed

sdirix assigned LukasBoll Aug 31, 2022

add documentation for UI schema translation

f3fea2f

Signed-off-by: Lukas Boll lukas-bool@web.de

sdirix mentioned this pull request Sep 21, 2022

3.0 Release eclipsesource/jsonforms#2022

Closed

16 tasks

lucas-koehler requested changes Sep 22, 2022

View reviewed changes

review changes

f5819eb

lucas-koehler approved these changes Oct 13, 2022

View reviewed changes

lucas-koehler removed the request for review from sdirix October 13, 2022 07:45

lucas-koehler merged commit c5fe90f into eclipsesource:master Oct 13, 2022

sdirix mentioned this pull request Jan 9, 2024

3.2 Release eclipsesource/jsonforms#2245

Closed

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial i18n documentation #222

Add initial i18n documentation #222

TheZoker commented Apr 4, 2022

sdirix left a comment

sdirix Apr 12, 2022

sdirix commented Apr 12, 2022

LukasBoll commented May 9, 2022

sdirix commented Jul 12, 2022 •

edited

Loading

lucas-koehler left a comment

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler Sep 22, 2022

lucas-koehler left a comment

	and there for has the following parameters:
	with the following parameters:


		## `locale`

		Allows to specify the current locale of the application.

	Allows to specify the current locale of the application.
	Specifies the current locale of the application.


		## `translate`

		Allows to provide a translation function, which handles the actual translation.

	Allows to provide a translation function, which handles the actual translation.
	Provides a translation function handling the actual translation.

	The i18n prop consist of three components: `locale`, `translate` and `translateError`.
	The `i18n` prop consists of three components: `locale`, `translate` and `translateError`.


		### `key`

		The key is used to identify the string, that needs to be translated.

	The key is used to identify the string, that needs to be translated.
	The key is used to identify the string that needs to be translated.

	Therefore the translation will be invoked with `myCustomName.label` & `myCustomName.description`.
	Therefore, the translation will be invoked with `myCustomName.label` & `myCustomName.description`.

	The paths in the above example would be:
	The paths in the above example are:


		:::note

		If the `defaultMessage` is `undefined` you should also return `undefined` if you don't have a translation for the given key.

	If the `defaultMessage` is `undefined` you should also return `undefined` if you don't have a translation for the given key.
	If the `defaultMessage` is `undefined`, you should also return `undefined` if there is no translation for the given key.


		<ValuesTable/>

		Schema translation provide all properties, while UI schema translations only provide the `uischema`-property.

	Schema translation provide all properties, while UI schema translations only provide the `uischema`-property.
	Schema translations provide all properties, while UI schema translations only provide the `uischema` property.

	In case nether a i18n-key nor a label is provided, `<property-path>.label` will be used as default key.
	In case neither a i18n-key nor a label is provided, `<property-path>.label` will be used as default key.

Add initial i18n documentation #222

Add initial i18n documentation #222

Conversation

TheZoker commented Apr 4, 2022

sdirix left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdirix commented Apr 12, 2022

LukasBoll commented May 9, 2022

sdirix commented Jul 12, 2022 • edited Loading

lucas-koehler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lucas-koehler left a comment

Choose a reason for hiding this comment

sdirix commented Jul 12, 2022 •

edited

Loading