Upgrading language files?

After updating many strings in Dolphin to read more naturally in English (apologies Boonex), I created a my own 'language' to prevent them from being overwritten during upgrades.

How to ensure all language changes occurring in an upgrade are included in your language files?

Though helpful, this page is pretty basic, and doesn't discuss upgrades:
http://www.boonex.com/trac/dolphin/wiki/DolLang

Thanks in advance

Have a look at NOTE section at the end of this page (or any other upgrade instructions):

http://www.boonex.com/trac/dolphin/wiki/7.0.6-7.0.7

Fair enough, but to ensure any language changes are not missed during an upgrade, should the following files be checked against the files in the patch zip, e.g., Dolphin-v.7.0.7.zip?

• lang_xx.php
• /public_html/modules/boonex/MODULENAME/langs/xx.php (for each and every module)
  

where xx = two letter language abbreviation e.g., en for English

Strongly suggest this note is moved to the beginning of the instructions where it could be most useful to those performing the upgrade, not after, when it is too late.

Also, can someone explain the relationship between

• system language file i.e., /public_html/langs/lang_en.php
• module language files i.e., /public_html/modules\boonex\forum\integrations\base\langs\en.ph &
• compilation process for both?

How do these all fit together?

Thanks!

1. System language files handle language keys for the script itself.
2. Module language files handle language keys for modules (one for each module).
3. You can compile system language files from Administration > Settings > Languages Settings. You can compile module language files from Administration > Tools > Modules. You need to compile the forum module's language files from the forum management page.

 This I understand. Two questions:

• what is the relationship between compiling the system language file, module language files & forum language files? Are there any dependencies between them? Do they need to be compiled in a certain order?
• are updates to language keys on the Languages Settings page updated in the language files immediately, on compilation, or not at all, i.e., only in the database?

Thanks in advance!

Thank you, Nathan.

No particular order, but usually system lang file then modules and orca lang files.  

During upgrade - changes are applied to the database for system and modules lang files.

During recompilation:

• system lang file - lang keys are transferred to the compiled lang file
• modules lang files - lang keys are transferred from actual modules language files to the database then to compiled lang file
• forum lang file - lang keys are taken from forum lang file and inserted inline into the code, then compiled version of the code is used for particular language 

More questions:

• What's the difference between the system language file & the compiled language file?
  public_html/langs/lang_en.php is the system language file, correct? Which is the compiled language file?

• Sounds like the forum language files are not inserted into the compiled language file?

• What about making changes on the Languages Settings page? Where do these changes go - database & compiled language file?
• where do the compiled files live - for both the system, modules, & forums?
• what is the difference between the two forum language files?
  /public_html/modules/boonex/forum/integrations/base/langs
  /public_html/modules/boonex/forum/install/langs

Thanks in advance!

1. langs/lang_XX.php - is compiled language file with both system language keys and modules language keys. The system language keys are in the database only (they are inserted into the database during the initial installation).

2. Forum language file is different, and it is compiled different way, so it is not compiled onto langs/lang_XX.php.

3. Into the database and immediacy compiled into lang file langs/lang_XX.php

4. Compiled system lang keys and modules lang keys are stored in langs/lang_XX.php file. Compiled forum lang keys are inserted inline into the code, and the version of compiled code for particular language is in the folders: forum/classes/XX, forum/js/XX, forum/layout/base_XX, forum/layout/SKINNAME_XX.

5. Forum was standalone software before. After it was integrated into Dolphin we have to leave original language system:  forum/integrations/base/langs; and add some language keys dolphin system: forum/install/langs  

If forum language files are not compiled into system language file

• how are forum language keys updated? Does the forum language file /public_html/modules/boonex/forum/integrations/base/langs have to be updated manually or can they still be updated in Admin / Language Settings?
• how can you export updated forum language keys?

Many thanks!

1. They can be updated manually, by editing files in forum/integrations/base/langs folder, there is no admin interface for it.

2. To export it - just download files via ftp from forum/integrations/base/langs folder

Last & very important question:

What is the best way to ensure new/updated language keys included in an upgrade are included in existing translated language files?

Sounds like changes made via Language Settings, are not updated in module language files, so if these changes are found only in the compiled system language file, adding new keys to module langauge files without adding changes made via Language Settings will wipe them out.

Thanks!

Have a look at NOTE section at the end of this page (or any other upgrade instructions):

http://www.boonex.com/trac/dolphin/wiki/7.0.6-7.0.7

Understood, but when Dolphin has a complex set of language files - system, modules, forums - which can be updated differently via the admin interface (or not) and which are processed differently, this note doesn't sufficiently explain how to update language keys which may have been added or modified during an upgrade.

As someone who has inadvertently overwritten language keys during the upgrade process, since there's not much detail describing how to avoid this, more specific steps are needed. This is what I'm asking for.

Thanks.

For system lang file - make changes in the database (using admin panel for languages management).

For modules and forum lang files - make changes in the lang files, but during applying version upgrade patch, you need to merge these files.  

In other words

• export the system lang file prior to the upgrade
• identify new keys in the module and forum language files
• translate them & merge them into the system lang file
• import the system lang file to Language Settings after the upgrade
• make sure never to compile the module or forum files or your changes will be lost

Sound correct?

Let me know if I missed anything.

No, it is wrong way.

Merge each file individually: modules/boonex/*/install/langs/en.php, modules/boonex/forum/integrations/base/langs/en.php

+

Have a look at NOTE section at the end of this page (or any other upgrade instructions):

http://www.boonex.com/trac/dolphin/wiki/7.0.6-7.0.7

Yes, but doesn't this assume you have made no changes to any module language strings via Admin interface?

If you have and follow the procedure you mention above, any changes will be lost.

The changes which were made via admin interface in modules language strings will be lost, the changes made in system language file will be preserved. 

Thanks for your response.

Given how system language files & module language files operate & that updates made from Language Settings are not reflected in the module language files, updates to language keys & strings included in Dolphin upgrades are sticky business, i.e., without a good understanding for how this works, it's easy to screw up (as I did).

Obviously this isn't be easy to redesign, but better documentation would certainly help. What's there now is not sufficient.

For each upgrade release, would it be possible to post in the release notes if any language keys (sys_localization_keys table) have been added and if any existing language strings (sys_localization_strings table) have been updated?

It would make each upgrade much easier for those who have created languages or have made modifications to the default language strings.

Thanks

All language keys are in separate files (for system and each module) so there is a list of language strings is already there. In the future we can add comment near language string if it was added or updated.

Thanks very much!

Anything you could do like this would save a lot of time.

I've seriously got a headache from reading this !!!

In the past I updated the changes I made to the language keys manually after I completed each dolphin update but this is very time consuming. I've changed some of the language strings by managing the language keys in the 'Settings' section of my Dolphin admin panel. Does that mean that when I next upgrade, in order to avoid manually updating my language keys, I should export my current language file and then upload it once the upgrade is complete and then compile the two languages together?

 RE:

Join the club.  Yes, it would be a stellar idea to export your language file every time you make a change, and especially before you apply an upgrade patch.   Boonex has some sort of obsession with recompiling language files, that I never really understood.

In my opinion, the Dolphin upgrade script should ask, "Would you like us to f*ck up your language strings?" (Y/N)

 Yes, that should be a question they ask!  So what is the best way for me to maintain the changes I have made to my language settings when it is time to next update dolphin? I'm tired of having to update the language settings manually. it's a bore.

Just follow upgrade instructions.  

The upgrade instructions are not clear to me Alex. May I present my scenario. I have changed some language key/strings via the admin panel. However, whenever I upgrade I lose these changes and have to manually update the language keys/strings. Can you please list the steps I need to take inorder to upgrade dolphin whilst preserving the changes I have made to the language keys?

 Have you downloaded your current language files?

Have you made changes to the forums as well?

Those differences are mentioned above.

Have you followed this too? http://www.boonex.com/trac/dolphin/wiki/7.0.8-7.0.9

snippet:

NOTE: You can also update your custom language translations if you create the appropriate translated files for your custom language, BEFORE THE UPGRADE PROCESS, in upgrade/files/7.0.7-7.0.8/ and upgrade/files/7.0.7-7.0.8/modules/*/ directories. There are lang_en.php files by default in these directories. Create a translated copy of lang_en.php for your custom language. For example, if you have the Russian language installed you can add lang_ru.php files. Then all new language keys for your custom language will be added automatically.

Maybe some of this will help.

I have to ask this question because your language changes should not be getting wiped out during a upgrade.

Question 1) How are you editing the language strings?

A common mistake many people make is making changes directly to the file in the langs folder which is incorrect.

Question 2)  Do you also loose those language changes after installing or uninstalling a module or when recompiling the languages?

Just some more input from working on others sites.

I noticed that some when dragging a new HTML block up insert the language there thinking that is what should be there.

i.e. they have put "Weather" where should have been "_index_weather_block"

[edit] then add that key to the language file and

then compiled the languages files and download. That saves everything you have done that way..

Re upload the file and you have all your changes.

Another mistake I've seen is leaving that field blank, then only can change that via the database which can be a nightmare.

I edit the language strings by searching for the original language string via the admin panel and changing them and saving the changes I have made. I then recompile the language.

For new language strings, if the word appears with the  '_' symbol before the word, then I search for that string and correct it.

I feel that I may not be doing this correctly. Please will you enlighten me.

Thanks.

That is the proper procedure.

You should not be loosing your changes during a upgrade.

Upgrades do not contain all of the language keys. Only the ones that were new. So i cannot see how you are loosing them. It does not make sense.

If modules language strings were modified - they are overwitten upon modules languages recompilation. So I suspect that 'callum' modified languages strings.

Almost all the possible situations and solutions are described above in this thread.

Let me give you a very basic example:

The string for  _bx_photos_public   is 'Public Photos'

I don't want the word 'public' used because none of the photos are for public viewing and this term is misleading. The photos on my site are for member viewing only and so I want to change the term from 'Public Photos' to 'Photos'. So I edit the string text, save and recompile.

Now... when I upgrade it reverts back to 'Public Photos' as do all the other strings I have edited.

What might possibly be going wrong here?

 Do you see the option to [edit]"download/save" "Export" your compiled file? it's there, down load it to your computer.

Upgrade the site, then upload the language file back in the language settings panel.

it will be called lang_en.php

But what of any new language strings that will be within the new updated language file patch? If I overwrite the new language file with my exported copy of the language file, won't I overwright any new language strings that have been added to the new updated?

hmm, that is right. I would think merging the two files with program would take care of that.

There are several free programs for that on the web.

Yea i was thinking the system language strings. The modules are handled differently.

For those it's best to edit the language key directly in the lang file for that module, then recompile that modules language. It will update whats in the database. In fact if you don't do it that way, you will lose your changes if you uninstall and reinstall the module, or even recompile it's language.

Unfortunately no easy way to deal with updates. You need to keep copies of off the modules Lang files you change and compare them with the new ones in the update for any added keys. And merge them by hand.


I know there are a few mods in the market to help with that.

I am working on one myself specifically for the purpose of backing up the language keys.

Deano,

your saying "module" language changes after re compile are stored in the database?

Yes. Modules when recompiled are pulled from the modules language file, into the database then end up in the compiled language file in the langs folder along with the system languages.

7 Posts down. AlexT also pointed out how that works.

I would link directly to the post, but these FISH forums as SkyForum calls them do not have anchors at the start of each post to link to.

Yes, wow, I did overlook that. my bad..

So am I right when I say this:  Before an upgrade I need to recompile the languages for the modules that are installed so that they are saved to the database. Then I need to compile the languages on the general 'manage language'  page in the admin panel and then export this file. After I have upgraded I then need to import the language file and overwrite the the one installed on upgrade. Any new language strings that have been added, I will have to work out what they are and add them manually. Is that right?

 You are spot on!

Hello guys,

where can I find the lang files for those Settings fellows?

Thanks.

Those are not translateable ...

Are you serious?