mirrors/Odin
1
0
Fork 0
mirror of https://github.com/odin-lang/Odin.git synced 2026-01-01 19:02:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Spell check doc.odin.

Browse Source
This commit is contained in:
Jeroen van Rijn
2024-06-19 11:15:17 +02:00
parent 53755824fb
commit e0de52efa1
1 changed files with 20 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
core/text/i18n/doc.odin
View File

@@ -2,25 +2,25 @@
/*
The `i18n` package is a flexible and easy to use way to localise applications.
It has two calls to get a translation: `get()` amd `get_n()`, which the user can alias into something like `T` and `Tn`
It has two calls to get a translation: `get()` and `get_n()`, which the user can alias into something like `T` and `Tn`
with statements like:
T :: i18n.get
T :: i18n.get
Tn :: i18n.get_n.
`get()` is used for retrieving the translation of sentences which **never**change in form,
`get()` is used for retrieving the translation of sentences which **never** change in form,
like for instance "Connection established" or "All temporary files have been deleted".
Note that the number (singular, dual, plural, whatever else) is not relevant: the semtece is fixed and it will have only one possible translation in any other language.
Note that the number (singular, dual, plural, whatever else) is not relevant: the sentence is fixed and it will have only one possible translation in any other language.
`get_n()` is used for retrieving the translations of sentences which change according to the number of items referenced.
The various signatures of `get_n()` have one more parameter, `n`, which will receive that number,
and which be used to select the correct form according to the pluraliser attached to the message catalogue when initially loaded;
for instance, to summarise a rather complex matter, some languages use the singular form when reerring to 0 items and some use the (only in their case) plural forms;
also, languages may have more or less quantifier forms than a single singular form an a universal plural form:
for istance, Chinese has just one form for any quantity, while Welsh may have up to 6 different forms for specific different quantities.
The various signatures of `get_n()` have one more parameter, `n`, which will receive that number and be used
to select the correct form according to the pluralizer attached to the message catalogue when initially loaded;
for instance, to summarise a rather complex matter, some languages use the singular form when referring to 0 items and some use the (only in their case) plural forms;
also, languages may have more or less quantifier forms than a single singular form and a universal plural form:
for instance, Chinese has just one form for any quantity, while Welsh may have up to 6 different forms for specific different quantities.
Both `get()` and `get_n()`, referred to as `T` and `Tn` here, have several different signatures.
All of them will return the key if the entry can't be found in the active translation catalogue.
By default lookup take place in the global `i18n.ACTIVE` catalogue for ease of use, unless a speciic catalogue is supplied
By default lookup take place in the global `i18n.ACTIVE` catalogue for ease of use, unless a specific catalogue is supplied.
- `T(key)` returns the translation of `key`.
- `T(key, catalog)` returns the translation of `key` from explictly supplied catalogue.
@@ -34,11 +34,11 @@ By default lookup take place in the global `i18n.ACTIVE` catalogue for ease of u
If a catalog has translation contexts or sections, then omitting it in the above calls looks up in section "".
The default pluralization rule is `n != 1``, which is to say that passing n == 1 returns the singular form (in slot 0).
Passing n != 1 returns plural form in slot 1 (if any).
The default pluralization rule is `n != 1`, which is to say that passing `n == 1` returns the singular form (in slot 0).
Passing `n != 1` returns the plural form in slot 1 (if any).
Should a language not conform to this rule, you can pass a pluralizer procedure to the catalog parser.
This is a procedure that maps an integer to an integer, taking a numbe of item and returning which plural slot should be used.
This is a procedure that maps an integer to an integer, taking a quantity and returning which plural slot should be used.
You can also assign it to a loaded catalog after parsing, of course.
@@ -47,7 +47,7 @@ Example:
import "core:fmt"
import "core:text/i18n"
T :: i18n.get
T :: i18n.get
Tn :: i18n.get_n
mo :: proc() {
@@ -55,17 +55,13 @@ Example:
err: i18n.Error
/*
Parse MO file and set it as the active translation so we can omit `get`'s "catalog" parameter.
*/
// Parse MO file and set it as the active translation so we can omit `get`'s "catalog" parameter.
i18n.ACTIVE, err = i18n.parse_mo(#load("translations/nl_NL.mo"))
defer i18n.destroy()
if err != .None { return }
/*
These are in the .MO catalog.
*/
// These are in the .MO catalog.
println("-----")
println(T(""))
println("-----")
@@ -78,9 +74,7 @@ Example:
// We pass 42 into `T` to get the plural format string, then 42 again into printf.
printf(Tn("There is %d leaf.\n", 42), 42)
/*
This isn't in the translation catalog, so the key is passed back untranslated.
*/
// This isn't in the translation catalog, so the key is passed back untranslated.
println("-----")
println(T("Come visit us on Discord!"))
}
@@ -90,19 +84,13 @@ Example:
err: i18n.Error
/*
Parse QT file and set it as the active translation so we can omit `get`'s "catalog" parameter.
*/
// Parse QT file and set it as the active translation so we can omit `get`'s "catalog" parameter.
i18n.ACTIVE, err = i18n.parse_qt(#load("translations/nl_NL-qt-ts.ts"))
defer i18n.destroy()
if err != .None {
return
}
if err != .None { return }
/*
These are in the .TS catalog. As you can see they have sections.
*/
// These are in the .TS catalog. As you can see they have sections.
println("--- Page section ---")
println("Page:Text for translation =", T("Page", "Text for translation"))
println("-----")