102. Language

This module does all language related stuff:

102.1. Summary of Module Globals

List of Global Functions

  • CJKLanguage - Check if the language is "CJK" (and thus could not be shown in text mode - see bug #102958)

  • Export - AutoYaST interface function: Return the Language configuration as a map.

  • GetExpertValues - GetExpertValues()

  • GetGivenLanguageCountry - de_DE@UTF-8 -> "DE"

  • GetLang2KeyboardMap - return the content of lang2keyboard map (mapping of languages to their default (proposed) keyboard layouts)

  • GetLang2TimezoneMap - return the content of lang2timezone map (mapping of languages to their default (proposed) time zones)

  • GetLanguageCountry - de_DE@UTF-8 -> "DE"

  • GetLanguagesMap - Return the whole map with language descriptions

  • GetLocaleString - generate the whole locale string for given language according to DB (e.g. de_DE -> de_DE.UTF-8)

  • GetLocales - return the map of all supported countries and language codes

  • GetName - return user readable description of language

  • GetTextMode - return the value of text_mode (true for ncurses)

  • Import - AutoYaST interface function: Get the Language configuration from a map.

  • IncompleteTranslation - Returns true if translation for given language is not complete

  • Language - Constructor

  • MakeProposal - Return proposal string.

  • MakeSimpleProposal - Return 'simple' proposal string.

  • Modified - was anything modified?

  • PackagesCommit - Install and uninstall packages selected by Pkg::SetAdditionalLocales

  • PackagesInit - Initializes source and target, computes the packages necessary to install and uninstall, checks for disk space (#50745)

  • PackagesModified - Does the modification of language(s) require installation of new packages? This test compares the list of original languages (primary+secondary) with the list after user's modifications

  • QuickSet - Set the language that was read from sysconfig, read only one needed language file

  • Read - Store the inital values; in normal mode, read from system was done in constructor

  • ReadSysconfigLanguage - Read the RC_LANG value from sysconfig and exctract language from it

  • ReadSysconfigValues - Read the rest of language values from sysconfig

  • Save - Save state to target.

  • Selection - Return a map of ids and names to build up a selection list for the user. The key is used later in the Set function to select this language. The name is a translated string.

  • Set - Set module to selected language.

  • SetDefault - Store current language as default language.

  • SetExpertValues - SetExpertValues()

  • Summary - AutoYaST interface function: Return the summary of Language configuration as a map.

  • WfmSetGivenLanguage - WfmSetLanguag()

  • WfmSetLanguage - WfmSetLanguag()

List of Global Variables

102.2. Global Functions

102.2.1. CJKLanguage

Check if the language is "CJK" (and thus could not be shown in text mode - see bug #102958)

Function parameters

  • string lang

Return value

  • boolean

102.2.2. Export

AutoYaST interface function: Return the Language configuration as a map.

Return value

  • map - with the settings

102.2.3. GetExpertValues

GetExpertValues()

Return value

  • map - with values filled in

102.2.4. GetGivenLanguageCountry

de_DE@UTF-8 -> "DE"

Function parameters

  • string lang

Return value

  • string - country part of language

102.2.5. GetLang2KeyboardMap

return the content of lang2keyboard map (mapping of languages to their default (proposed) keyboard layouts)

Return value

  • map<string,string>

102.2.6. GetLang2TimezoneMap

return the content of lang2timezone map (mapping of languages to their default (proposed) time zones)

Return value

  • map<string,string>

102.2.7. GetLanguageCountry

de_DE@UTF-8 -> "DE"

Return value

  • string - country part of language

102.2.8. GetLanguagesMap

Return the whole map with language descriptions

Function parameters

  • boolean force

Return value

  • map<string, list>

102.2.9. GetLocaleString

generate the whole locale string for given language according to DB (e.g. de_DE -> de_DE.UTF-8)

Function parameters

  • string lang

Return value

  • string

102.2.10. GetLocales

return the map of all supported countries and language codes

Return value

  • map<string,integer>

102.2.11. GetName

return user readable description of language

Return value

  • string

102.2.12. GetTextMode

return the value of text_mode (true for ncurses)

Return value

  • boolean

102.2.13. Import

AutoYaST interface function: Get the Language configuration from a map.

Function parameters

  • map settings

Return value

  • boolean - success

102.2.14. IncompleteTranslation

Returns true if translation for given language is not complete

Function parameters

  • string lang

Return value

  • boolean

102.2.15. Language

Constructor

Return value

  • void

102.2.16. MakeProposal

Return proposal string.

Function parameters

  • boolean force_reset

  • boolean language_changed

Return value

  • list<string> - user readable description. If force_reset is true reset the module to the language stored in default_language.

102.2.17. MakeSimpleProposal

Return 'simple' proposal string.

Return value

  • string - preformated description.

102.2.18. Modified

was anything modified?

Return value

  • boolean

102.2.19. PackagesCommit

Install and uninstall packages selected by Pkg::SetAdditionalLocales

Return value

  • boolean

102.2.20. PackagesInit

Initializes source and target, computes the packages necessary to install and uninstall, checks for disk space (#50745)

Function parameters

  • list<string> selected_languages

Return value

  • boolean - false when there is not enough disk space for new packages

102.2.21. PackagesModified

Does the modification of language(s) require installation of new packages? This test compares the list of original languages (primary+secondary) with the list after user's modifications

Return value

  • boolean

102.2.22. QuickSet

Set the language that was read from sysconfig, read only one needed language file

Function parameters

  • string lang

Return value

  • void

102.2.23. Read

Store the inital values; in normal mode, read from system was done in constructor

Function parameters

  • boolean really

Return value

  • boolean

102.2.24. ReadSysconfigLanguage

Read the RC_LANG value from sysconfig and exctract language from it

Return value

  • string - language

102.2.25. ReadSysconfigValues

Read the rest of language values from sysconfig

Return value

  • void

102.2.26. Save

Save state to target.

Return value

  • void

102.2.27. Selection

Return a map of ids and names to build up a selection list for the user. The key is used later in the Set function to select this language. The name is a translated string.

Return value

  • map<string, list> - of $[ language : [ utf8-name, ascii-name] ...] for all known languages 'language' is the (2 or 5 char) ISO language code. 'utf8-name' is a user-readable (UTF-8 encoded !) string. 'ascii-name' is an english (ascii encoded !) string.

102.2.28. Set

Set module to selected language.

Function parameters

  • string lang

Return value

  • void

102.2.29. SetDefault

Store current language as default language.

Return value

  • void

102.2.30. SetExpertValues

SetExpertValues()

Function parameters

  • map val

Return value

  • void -

102.2.31. Summary

AutoYaST interface function: Return the summary of Language configuration as a map.

Return value

  • string - summary string

102.2.32. WfmSetGivenLanguage

WfmSetLanguag()

Function parameters

  • string lang

Return value

  • void - -

102.2.33. WfmSetLanguage

WfmSetLanguag()

Return value

  • void - -

102.3. Global Variables

102.3.1. language

currently selected language

102.3.2. language_on_entry

original language

102.3.3. languages

Default settings for INSTALLED_LANGUAGES in /etc/sysconfig/language

102.3.4. languages_on_entry

Original value of INSTALLED_LANGUAGES

102.3.5. preselected

language preselected in /etc/install.inf

102.4. Module Requirements

102.4.1. Module Imports

  • AsciiFile
  • Directory
  • Encoding
  • FileUtils
  • HTML
  • Linuxrc
  • Misc
  • Mode
  • PackageCallbacksInit
  • PackageSystem
  • ProductFeatures
  • Stage

102.4.2. Module Includes