Skip to content

Latest commit

 

History

History

resource_bundles

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Application.cfc
Application.cfc
 
 
README.md
README.md
 
 
en.properties
en.properties
 
 

README.md

Masa CMS Resource Bundles

Masa CMS utilizes resource bundles to internationalize various areas of the user interface, making the code locale-independent.

Resource bundles are .properties files, located under specified directories in Masa CMS. These .properties files, or resource bundles, are named to indicate the language code, and country code. For example, the language code for English (en) and the country code for United States (US) would be represented as en_us.properties. If Masa CMS cannot find a direct language and region match, it will search for a language match. If a locale's language cannot be found, Masa CMS will fall back to its default of English, or en.properties.

The file itself is comprised of key-value pairs. The keys remain the same throughout each of the .properties files, and the value is translated into the file's designated language. If Masa CMS is searching for a specific key-value pair within a translation, and cannot locate it, Masa CMS will fall back to the English translation.

Lookup Hierarchy

Masa CMS automatically searches for resource bundles under specific directories, and uses the key-value pair(s) found in the order outlined below. If a resource_bundles directory does not exist in the following locations, you may safely create one, and place your resource bundle files there.

  • Module
    • ../{module}/resource_bundles/
    • Module (aka "Display Object") resource bundles are used for the specified module itself.
  • Theme
    • ../{ThemeName}/resource_bundles/
    • Theme resource bundles are only used when the specified theme is actively assigned to a site.
  • Site
    • {context}/sites/{SiteName}/resource_bundles/
    • Site resource bundles are shared across all themes within the specified site.
  • Global
    • {context}/resource_bundles/
    • Global resource bundles are shared across all sites under a single Masa CMS instance.
  • Core Modules
    • {context}/core/modules/v1/core_assets/resource_bundles/
    • If the requested key-value pair is not found in any of the locations above, Masa CMS will use the default resource bundles located here for Masa CMS's modules.

Note

Admin-area resource bundles are stored under {context}/core/mura/resourceBundle/resources/. However, as of v7.1, many key-value pairs are not able to be overwritten using the technique described above at this time. Allowing for this option is under consideration for a future version.