Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-729

Generall update on i18n pages

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Neutral Neutral
    • None
    • None
    • None
    • None
    • Docu Sprint 10

      With Magnolia 5.4.6, some changes on i18n have been introduced, for a summary see Release notes for Magnolia 5.4.6 - i18n

      The changes announced below relate only to the following page and its subpages:
      https://documentation.magnolia-cms.com/display/DOCS/Language

      The rework was started at Language _new

      Due to the "history" of i18n API itself and its documentation - the entirety of these docs is a bit a patchwork.
      Let's try to create something which is seamless and can be read as associated story.

      • Language (parent page)
        • Language configuration
        • Multilanguage structure
        • Types of translatable text
        • Internationalization basics (Explains the basic terms such i18n, L10, message bundles and keys and UTF8 encoding)
        • Magnolia Internationalization API => DOCU-734
        • Making a module translatable => DOCU-735
        • My first translation (Probably not used anymore if the page above is good)
        • Generic and specific keys
        • Best practices (Probaly not used anymore if the page above is good)

      Among other, the changes are:

      • new supported and recommended location: src/main/resources/<module-name>/i18n
      • i18n available for light modules
      • new keys ready for cross-module usage
      • etc.

      TODOs:

      • Reorganize the whole Language section
      • Get rid of parts describing old i18n
      • Provide some best practices concerning keys
      • Update folder trees (in the areas of modules and light-modules pages)

        Acceptance criteria

              cmeier Christoph Meier
              cmeier Christoph Meier
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: