mirror of
https://github.com/discourse/discourse.git
synced 2024-11-27 20:03:39 +08:00
880311dd4d
- Themes can supply translation files in a format like `/locales/{locale}.yml`. These files should be valid YAML, with a single top level key equal to the locale being defined. For now these can only be defined using the `discourse_theme` CLI, importing a `.tar.gz`, or from a GIT repository.
- Fallback is handled on a global level (if the locale is not defined in the theme), as well as on individual keys (if some keys are missing from the selected interface language).
- Administrators can override individual keys on a per-theme basis in the /admin/customize/themes user interface.
- Theme developers should access defined translations using the new theme prefix variables:
JavaScript: `I18n.t(themePrefix("my_translation_key"))`
Handlebars: `{{theme-i18n "my_translation_key"}}` or `{{i18n (theme-prefix "my_translation_key")}}`
- To design for backwards compatibility, theme developers can check for the presence of the `themePrefix` variable in JavaScript
- As part of this, the old `{{themeSetting.setting_name}}` syntax is deprecated in favour of `{{theme-setting "setting_name"}}`
28 lines
882 B
Ruby
28 lines
882 B
Ruby
class ThemeTranslationParser
|
|
class InvalidYaml < StandardError; end
|
|
|
|
def initialize(setting_field)
|
|
@setting_field = setting_field
|
|
end
|
|
|
|
def self.check_contains_hashes(hash)
|
|
hash.all? { |key, value| value.is_a?(String) || (value.is_a?(Hash) && self.check_contains_hashes(value)) }
|
|
end
|
|
|
|
def load
|
|
return {} if @setting_field.value.blank?
|
|
|
|
begin
|
|
parsed = YAML.safe_load(@setting_field.value)
|
|
rescue Psych::SyntaxError, Psych::DisallowedClass => e
|
|
raise InvalidYaml.new(e.message)
|
|
end
|
|
raise InvalidYaml.new(I18n.t("themes.locale_errors.invalid_yaml")) unless parsed.is_a?(Hash) && ThemeTranslationParser.check_contains_hashes(parsed)
|
|
raise InvalidYaml.new(I18n.t("themes.locale_errors.top_level_locale")) unless parsed.keys.length == 1 && parsed.keys[0] == @setting_field.name
|
|
|
|
parsed.deep_symbolize_keys!
|
|
|
|
parsed
|
|
end
|
|
end
|