Translation

[ramiismail]

The static text on presskit() needs to be translatable in some way. This would mean that on a presskit(), if translation files are provided, people can offer their presskit() and content in a different language.

I am not sure how the functionality would be implemented, but my current thought is presskit() scans for language files in a /lang/ folder in root. Files there will be loaded as 'language', and project folders will be scanned for data-[language].xml files to see if language specific content exists. Note that both index.php and sheet.php will need to be affected by the translations.

presskit() will default to English always, and English content is expected from the default data.xml file. Even though I'm passionate about breaking language barriers, the reality is that the majority of gaming press is English. In that regard, presskit() will continue its tradition of nudging users to do things that are good for them.

Changing language would be done with a dropdown presented in the top right of every language page.

Notes

• The credits line at the bottom of each page should not be changed or modified by translation.
• The default language will remain English.
• presskit() is user hosted, so supporting wide compatibility needs to be kept in mind.
• Some changes are being made simultaneously to this Issue being resolved. I'll try and update the git accordingly.
• presskit() needs to remain fully functional with just the files from an existing installation. Nothing may break existing data.xml, project data.xml, display order or anything else on a presskit().
• Bonus points: I would love if the project supported both LTR and RTL languages. Being able to set a flag for that in translations might be useful.

[empty-fortress]

It's been a looooong time since I last used it, but PHP has gettext support: http://php.net/manual/en/ref.gettext.php it does pretty much everything you need, is relatively simple to use (there are plenty of docs online for a bazillion prog languages), and there are plenty of free tools available to edit the strings database file.

I'd volunteer but I'm just swamped with stuff rn; that said, I'll keep an eye on this and see if I can help if you choose to use gettext.

[DaanBroekhof]

Hiya! I've made a little rough first draft for a translation/localization setup in my fork: https://github.com/DaanBroekhof/dopresskit (commit: https://github.com/DaanBroekhof/dopresskit/commit/a80104d3bb4ae07d7c4b20ee4b41ed0ce8feee24) Live demo: http://yarr.me/demo-presskit

Some assumptions / choices for this implementation:

• Least impact on current code - so no refactoring/etc
• Use similar logic/structure as already present - using file listing & detection for lists, XML for data
• Wide compatibility - gettext() kinda disqualifies because of this - requires some control of locales on servers, caches stuff, Windows somewhat shaky, archaic storage format
• Simplicity - want novice webprogrammers to be able to tinker with it. self-contained logic. no big libraries or OO constructs
• Security - html-escape translations by default, only allow for those that explicitly contain html

Some rudimentary RTL marking & logic also implemented by wrapping (see 'Projects' in Dutch). Lemme know what you think, willing & able to hack/rewrite it some more. :smile: :hocho:

[ramiismail]

@DaanBroekhof That's almost perfect. I saw some minor errors (not all text seems to be translated, dropdown in the top right would look better), but this seems to be pretty close to what I need. Shall I merge it later or would you like to finish things up first yourself? Can I add you to the credits?

[DaanBroekhof]

@ramiismail Good to hear it is what you seek! I'll give it a good cleanup & doublecheck and will offer you a pull request when I'm done. And credits are nice. :) (uhh don't have a real central URL to offer I guess... twitter I guess? https://twitter.com/McDaan - got a disused tumblr I should update too http://joror.tumblr.com/ - but twitter will suffice)

Some specific features explained:

• Currently all identical texts on the pages are translated similarly, but you can overload them by file or 'set name'
  • By filename by specifying a set as <set name="default" filename="sheet.php"> for example
  • By 'set name' by specifying a set with a specific name <set name="menu">, and using tlSet() like tlSet('Factsheet', 'menu'). (if the specific set name is not found, it will fall back to 'default')
• Text direction info is available from the tr() itself via tl('Factsheet')->attributes()->direction, if required

Things I will add:

• Will translate _template/index.php too
• Add a default en-English.xml that people can use/copy/edit as a base
• Don't show language links if there is only one language

Some questions/edge cases/possibilities:

• Shall I use tlSet() for the pages, or just use tl()? (grouping things like 'menu', 'content')
• I use tlHtml() where there was html content in the text, allowing only those texts to have html in the translations. However this disallows html in all other translations' text. I could make it so that the translation determines this instead, by adding the option to the xml like <translation type="html">. Is that desirable? Would remove the need for tlHtml(), but also allow html in places where that might not be wanted.
• Do you want the anchors ('#factsheet') to be translatable too?
• Do you want create.php / mail.php / credits.php / install.php translated? Those are not really press-facing pages, so might not be as useful.

[DaanBroekhof]

The partially translated pages are probably where I was too lazy to edit the data-nl_NL.xml for the testgame, but will double check the things. You can see the 'static' translatables when you pick a language that doesn't exist (http://yarr.me/demo-presskit/?l=moo)

For the language toggling: maybe some nice flags? http://www.famfamfam.com/lab/icons/flags/ are public domain (tho country != language, often)

[ramiismail]

Let's go with a dropbox, that's probably better. Anchors can stay as they are, and the other .php files can stay. _template/index.php does't need translation. Allowing HTML in as little as possible would be nice. No reason to allow it, really.

On Wed, Dec 10, 2014 at 11:07 AM, Daan Broekhof notifications@github.com wrote:

The partially translated pages are probably where I was too lazy to edit the data-nl_NL.xml for the testgame, but will double check the things. You can see the 'static' translatables when you pick a language that doesn't exist (http://yarr.me/demo-presskit/?l=moo)

For the language toggling: maybe some nice flags? http://www.famfamfam.com/lab/icons/flags/ are public domain (tho country != language, often)

— Reply to this email directly or view it on GitHub https://github.com/ramiismail/dopresskit/issues/29#issuecomment-66448702 .

• www.vlambeer.com
• follow vlambeer on twitter http://twitter.com/Vlambeer or like us on facebook http://www.facebook.com/pages/Vlambeer/153601874671274

[DaanBroekhof]

In the pull request I used a dropdown, and also translated _template/index.php already, which did contain some incomplete logic/vlambeer references. (prob why it doesn't need translating?) I will remove that that from the pull request. :)

(demo also updated at http://yarr.me/demo-presskit / http://yarr.me/demo-presskit/testgame)

[DaanBroekhof]

There, pullrequest https://github.com/ramiismail/dopresskit/pull/30 is done (fixed some more missing things). Let me know if there are any other things you would like changed/fixed.

[DaanBroekhof]

Note that I did leave the dropdown in the lefthand navigation menu, because I did not find a suitable 'right' page aligned styling to use within uikit - feel free to relocate/restyle.