[DOCU-890] Update My first translation tutorial Created: 28/Nov/16  Updated: 03/Jul/17  Resolved: 08/Dec/16

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

Type: Task Priority: Neutral
Reporter: Ruth Stocks Assignee: Ruth Stocks
Resolution: Done Votes: 0
Labels: core
Remaining Estimate: 0d
Time Spent: 2d 3.5h
Original Estimate: Not Specified

Attachments: File app-products-messages_de.properties     File app-products-messages_en.properties     File app-products-messages_es.properties     PNG File my-first-translation-de.png     PNG File my-first-translation-en.png    
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Sprint: Docu Sprint 14

 Description   

Update the My first translation tutorial at https://documentation.magnolia-cms.com/display/DOCS/My+first+translation

Things to note:

  • I (RS) tested the tutorial on 5.5
  • magnolia-app-tutorial-1.4.6.jar is out of date and does not install on 5.5.
  • magnolia-app-tutorial-1.4.7-SNAPSHOT works fine but field translations need an update (see attached screenshots for examples)
  • in Special characters section verify that saving "with UTF-8 encoding" is enough. See instructions in https://documentation.magnolia-cms.com/display/DOCS/Language+configuration#Languageconfiguration-UTF-8pagenames
  • in Test the translation section - 1 it should no longer be necessary to update resources 2 - tool in step 2 is no longer available in any event 3 - regarding the bullet point about using a local message bundle: the translations only displayed for me after a restart.


 Comments   
Comment by Ruth Stocks [ 06/Dec/16 ]

I tested this twice with the same result.
Procedure:

  • installed fresh 5.5 CE bundle
  • added /modules/app-tutorial/i18n folder + en and de properties files
  • changes were not picked up in Products app.
  • after restart the changes were picked up and all subsequent changes to the files were also picked up immediately.

Things to change in module (downloadable).

  • Three fields in the Products app (title, image, description) do not correspond with the i18n files. My "corrected" files are attached.
  • App configuration defines a label=Select image property for the image field. This overrides the label in the i18n en file and de file. When you remove this property the labels are displayed correctly from the message bundle.
Comment by Christoph Meier [ 06/Dec/16 ]

ruths, i have created a new ticket concerning the Windows issue: MAGNOLIA-6897

Comment by Ruth Stocks [ 08/Dec/16 ]

I've updated the page to correspond with the attached language files.

AFAIK these are the only changes needed in the the module:

  • include the message bundles (I've also attached a Spanish file)
  • remove the label property in the image field in the Products app configuration. (in /detail/editor/form/tabs/product/fields/image@label)
Comment by Christoph Meier [ 09/Dec/16 ]

OK.
I have updated the bundle files en and es and added the de bundle file.
And magnolia-app-tutorial:1.4.7 has been released.

https://documentation.magnolia-cms.com/display/DOCS/My+first+translation
is now perfectly up to date.

However, the same pages on DOSCS54 and DOCS53 are NOT up to date.

I'm tempted to just add a yellow box on the pages of the older version - mentioning that there is a newer version available ... and stop updating the older page version. Atlassian handles this very similar.

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