Skip to content

SPM-18747 Update readme: clarification, typos #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 19, 2023
Merged

SPM-18747 Update readme: clarification, typos #150

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0425a3
SPM-18747 Update readme: clarification, typos
ThomasR Jan 5, 2023
ef494b1
Merge branch 'master' into SPM-18747-update-readme
Matwog Jan 16, 2023
3d2632a
Merge branch 'master' into SPM-18747-update-readme
marpme Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,9 @@ i18n('Contact __supportLink__', {
})
```

The default syntax for interpolations is a group of characters or numbers (`\w+`) wrapped in double underscores (`__`). If you require a different syntax this can be customized using the init option `interpolationPattern`. Internally, pattern value will be used to create a regular expression for matching interpolation placeholder like this:
The default syntax for interpolations is a group of characters or numbers (`\w+`) wrapped in double underscores (`__`). Note that the identifiers `context` and `markdown` are reserved and should not be used as a placeholder (see docs below).

If you require a different syntax this can be customized using the init option `interpolationPattern`. Internally, pattern value will be used to create a regular expression for matching interpolation placeholder like this:

```
new RegExp(interpolationPattern, 'g')
Expand All @@ -139,10 +141,20 @@ i18n('Showing __count__ item', 'Showing __count__ items', { count })
```

To use this feature simply pass two different translations to the `i18n` function.
The first string is used for the singular case and the second one for the plural case.
Note that you **have** to hand in a variable called count.
The first string is used for the singular case (`count == ±1` ) and the second one for the plural case.
Note that you **have** to hand in a variable called `count`.
This variable is used to decide which version of the translation to choose.

You can also use multiple variables, but only the `count` variable is used to select the translation:

```javascript
i18n(
'Showing __count__ item out of __total__',
'Showing __count__ items out of __total__',
{ count, total }
)
```

### Message context

Sometimes the same translation key can have different meanings based on the context in which is it used.
Expand All @@ -166,7 +178,7 @@ i18n('I want _this_ to be **bold**', {

### Replacements

#### Extrtaction
#### Extraction

Sometimes there may be cases when you need to rename several entities across the whole project, but keep the both versions of translations and show them based on the feature flag.
Doing that manually could be laborious, that's why `i18n-extract` supports a path to the replacements json as an optional third command line argument.
Expand Down Expand Up @@ -237,7 +249,7 @@ msgstr ""

#### Usage

To use the replacements instead of the old strings in runtime pass the same replecements object which was used in the extraction step to the `init` function:
To use the replacements instead of the old strings in runtime pass the same replacements object which was used in the extraction step to the `init` function:

```javascript
import replacements from 'replacements.json'
Expand Down