FabInfra-Mirror/api.fabaccess-api
1
0
Fork 0
mirror of https://gitlab.com/fabinfra/fabaccess/fabaccess-api.git synced 2025-03-12 23:01:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Be more specific

Browse Source
This commit is contained in:
Nadja Reitzenstein 2021-10-02 12:41:57 +02:00
parent 8b94301382
commit 2a14158a76
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
utils.capnp
View File

@ -10,18 +10,25 @@ interface L10NString {
get @0 ( lang :Text ) -> ( lang :Text, content :Text );
# Retrieve the string in the given locale. The input parameter MUST be a RFC5646-formatted
# locale identifier (e.g: "en-US", "de-DE", "az-Arab-IR").
# A server MUST set the outputs `lang` to the exact tag that the content it sends was written in
# and `content` to the localized string.
# If a server can't find a localized version it SHOULD try to substitute it. Substitution SHOULD
# only search for close matches, e.g. returning "en-UK" for a string requested in "en-US" or
# returning "es-ES" for a requested "es-VE". Substitution MUST NOT return a localization that an
# user can not be expected to understand unless the server has a priori knowledge that the user
# can read and understand said language.
# If a server sends a substituted string it MUST set the output `lang` to the tag of the
# substitute it is sending.
# If a server can't find a suitable substitute or is not doing substitution it MUST set the
# output `content` to a NULL pointer and set the output `lang` to the input `lang` it was
# passed.
#
# If a server can't find a localized version matching exactly it MUST try to substitute it.
# Substitution MUST always return more specific matches for general queries.
# e.g. if "it" is requested and the server has "it-CH" available it returns this string.
#
# Substitution SHOULD NOT cross language barriers, e.g. returning "en-GB" for a string requested
# in "cy-GB". Substitution MUST NOT return a localization in a different language unless server
# has a priori knowledge that the user can read and understand said language.
#
# Substitution SHOULD prefer unspecified subtags over wrong subtags. If "es-AR" is requested and a
# server has "es", and "es-VE" available, "es" should be selected.
#
# A server MUST set the output `lang` field to the exact tag that the content it sends was written
# in and `content` to the localized string.
# E.g. If a string is requested for "sr" and the server has found a string that was configured as
# "sr-Cyrl-BA" the server sets lang to "sr-Cyrl-BA".
#
# If a server can't find a suitable substitute it MUST set the output `content` to a NULL pointer
# and set the output `lang` to the input `lang` it was passed.
# If a server can't parse a given `lang` tag it MUST set the output `lang` to a NULL pointer.
available @1 () -> ( langs :List(Text) );