luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

gsettings: Expand documentation default value l10n

Browse Source 
Mention context, translation category, and the need for syntactic
validity of the translated values.

https://bugzilla.gnome.org/show_bug.cgi?id=741788
This commit is contained in:
Philip Withnall 2014-12-19 20:42:21 +00:00
parent 73a71d6a43
commit 723961b749
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
gio/gsettings.c
View File

@ -97,9 +97,33 @@
* Similar to GConf, the default values in GSettings schemas can be * Similar to GConf, the default values in GSettings schemas can be
* localized, but the localized values are stored in gettext catalogs * localized, but the localized values are stored in gettext catalogs
* and looked up with the domain that is specified in the * and looked up with the domain that is specified in the
* gettext-domain attribute of the <schemalist> or <schema> * `gettext-domain` attribute of the <schemalist> or <schema>
* elements and the category that is specified in the l10n attribute of * elements and the category that is specified in the `l10n` attribute of
* the <key> element. * the <default> element. The string which is translated includes all text in
* the <default> element, including any surrounding quotation marks.
*
* The `l10n` attribute must be set to `messages` or `time`, and sets the
* [locale category for
* translation](https://www.gnu.org/software/gettext/manual/html_node/Aspects.html#index-locale-categories-1).
* The `messages` category should be used by default; use `time` for
* translatable date or time formats. A translation comment can be added as an
* XML comment immediately above the <default> element — it is recommended to
* add these comments to aid translators understand the meaning and
* implications of the default value. An optional translation `context`
* attribute can be set on the <default> element to disambiguate multiple
* defaults which use the same string.
*
* For example:
* |[
* <!-- Translators: A list of words which are not allowed to be typed, in
* GVariant serialization syntax.
* See: https://developer.gnome.org/glib/stable/gvariant-text.html -->
* <default l10n='messages' context='Banned words'>['bad', 'words']</default>
* ]|
*
* Translations of default values must remain syntactically valid serialized
* #GVariants (e.g. retaining any surrounding quotation marks) or runtime
* errors will occur.
* *
* GSettings uses schemas in a compact binary form that is created * GSettings uses schemas in a compact binary form that is created
* by the [glib-compile-schemas][glib-compile-schemas] * by the [glib-compile-schemas][glib-compile-schemas]