Generall update on i18n pages (DOCU-729)

[DOCU-735] Rewrite / adapt 'Making a module translatable' Created: 09/May/16  Updated: 10/Jun/16  Resolved: 12/May/16

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

Type: Sub-task Priority: Neutral
Reporter: Christoph Meier Assignee: Antti Hietala
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
depends upon DOCU-734 Create page 'Magnolia i18n API' Closed
Template:
Date of First Response:
Sprint: Docu Sprint 10

 Description   

° Turn the page in a way that it becomes an easy to use recipe.
° Remove theoretical details which are already explained on the new API page (DOCU-734)
° Make sure to use best practices.
°° Do not add keys for things such as cancel for which we can use the generic keys somewhere else (in Magnolia modules)
°° Good bundle file name
°° etc.



 Comments   
Comment by Martin Drápela [ 09/May/16 ]
  • the original "Making a module translatable" page will be transformed into a page providing a general, four-step procedure explaining how to start applying i18n in Magnolia
  • most of the information from the older page was moved to the new Internationalization page
  • the original "Internationalization Basics" page will provide in its new version a level-differentiated overview of i18n-ing in Magnolia: 1) The Basics, 2) Advanced Issues, + an example
    • constructed (with MIchal's help) and added a remake of Christoph's diagram presenting the general view of the i18n concept
    • additional polishing necessary, esp. for the incoming links
  • "Generic i18n + their list" page replaced the original page describing intermodular keys ( The list of generic keys could be alternatively separated into a subpage to give it more prominence within the Language section)
Comment by Martin Drápela [ 12/May/16 ]

Two pages

  • "Internationalization" and "Making a module translatable" are now in the public section. Both pages were completely restructured and use bits of text from the old Making a module translatable page as well as other pages.

The whole structure is much more streamlined now, simple to understand, with "Internationalization" page serving as more a less a complete user guide to i18n in Magnolia, and "Making a module translatable" as quick, 4-step recipe to begin a i18n task.

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