[DOCU-729] Generall update on i18n pages Created: 21/Apr/16  Updated: 20/Jun/16  Resolved: 20/Jun/16

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
dependency
depends upon DOCU-732 Use new i18n location for app-tutoria... Closed
relation
is related to DOCU-697 Document the i18n key generators and ... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCU-734 Create page 'Magnolia i18n API' Sub-task Closed Christoph Meier  
DOCU-735 Rewrite / adapt 'Making a module tran... Sub-task Closed Antti Hietala  
DOCU-732 Use new i18n location for app-tutoria... Sub-task Closed Martin Drápela  
DOCU-697 Document the i18n key generators and ... Sub-task Closed Martin Drápela  
Template:
Acceptance criteria:
Empty
Date of First Response:
Sprint: Docu Sprint 10

 Description   

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)


 Comments   
Comment by Martin Drápela [ 04/May/16 ]

I've restructured the whole section into a one prominent i18n subsection, it seems more logical as the original first two subpages are of a more general character.

I thought it would be good to have the I18n API page renamed as a ../Language/i18n/Summary page providing a brief - well - a summary of the way i18n works now. I guess the page could still be expanded if needed

Generated at Mon Feb 12 01:11:52 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.