AU3Text: Internationalization UDF

[dany 33]

AU3Text.au3 v1.0

An extensive UDF to ease the internationalization of AutoIt scripts and programs. Add multi-lingual support to your scripts and programs in a consistent and portable manner.

Main features:

• Store messages in a human-readable INI format.
• Organize messages in different categories.
• Handle singular and plural string variants at run time.
• Expands meta-characters and all AutoIt macro's.
• Supports UTF-16 Little-Endian encoding.
• GUI Menu and Combo Create/Read helper functions.
• Command line utility to extract messages from AutoIt scripts.
• Fully portable!

The download contains the following files:

ReadMe.txt                  Instructions and information on the UDF.
AU3Text-HowTo.txt           Step by step instructions to convert programs for
                            internationalization with AutoIt.
AU3Text-Demo.au3            AU3Text demo.
AU3Text-Extractor.au3       Source file for command line utility to extract
                            AU3Text messages from scripts. You'll need to compile
                            this script before you can use it. This is BETA software!
LibAU3Text.au3             Main AU3Text library.
LibAU3TextGUI.au3          AU3Text GUI helpers.
LibAU3TextDev.au3          Additional developer functions.
LibLocale.au3              Locale functions. Originally based on guinness'
                            excellent _GetOSLanguage function, but has grown into
                            a full stand-alone UDF.
LibIni.au3                 UTF-16 LE INI functions.
LibStringFormatEx.au3      Modified StringFormat function. See
                            http://www.autoitscript.com/forum/topic/139260-autoit-snippets/page__st__60#entry1010824
I18nAU3Text-Demo.en.lng    English demo language file.
I18nAU3Text-Demo.nl.lng    Dutch demo language file.
I18nAU3Text-Translation-HowTo.txt
                            Basic translation instructions.
ResAU3Text-Extractor.ico   Pic unrelated :)

A simple example of translating a string:

#include 'LibAU3Text.au3'
_AU3Text_BindTextSection('MESSAGES', 'nl') ; Set translations to dutch.
; ... Create a GUI.
; Translate a string:
GUICtrlCreateLabel(_AU3Text('The flying dutchman flies again.', 'FLYING_DUTCHMAN'), -1, -1) ; De vliegende hollander vliegt alweer.
; Translate a string with plural variants:
GUICtrlCreateLabel(StringFormat(_AU3Text_Plural('Deleted %i file.', 2, 'DELETED_FILES'), 2), -1, -1) ; 2 bestanden verwijdert.
; Using shorthand functions:
GUICtrlCreateLabel(_('The flying dutchman flies again.', 'FLYING_DUTCHMAN'), -1, -1)
GUICtrlCreateLabel(StringFormat(_P('Deleted %i file.', 2, 'DELETED_FILES'), 2), -1, -1)
; Let AU3Text generate the INI keys, keys are MD5 hashes of the messages.
GUICtrlCreateLabel(_('The flying dutchman flies again.'), -1, -1)
GUICtrlCreateLabel(StringFormat(_P('Deleted %i file.', 2), 2), -1, -1)
; ...

The UDF:

AU3Text.zip

If you encounter any bugs or have any suggestions, requests or improvements, then please let me know.

Happy coding!

edit 1: zip added

edit 2: If you compiled AU3Text-Extractor and want to test it, run it against AU3Text-Demo like this:

AU3Text-Extractor.exe Au3Text-Demo.au3 be

This will create AU3Text-Demo.be.lng in the I18n directory.

Edited September 15, 2012 by dany

[JackDinn 1]

well quite a coincidence , iv just been asked if i can translate my speed tester app into French http://www.gmwsoftware.co.uk/guestbook.html

I was wondering how i might go about doing this as of course if i do it for French i really should do many of the other languages that use my software.

All i need to do now is hope i can figure out how your great looking AU3text works :-/

cool timing coincidence,

Many Many thx.

[dany 33]

All i need to do now is hope i can figure out how your great looking AU3text works

Thanks for the compliment Just take a good look at the demo script. You'll figure it out, it isn't hard to set up. Post any questions or problems here if you have them!

edit: Included a How-To in the zip with instructions on how to prepare programs for internationalization with AutoIt.

Edited September 9, 2012 by dany

[MrCreatoR 136]

Look at

[dany 33]

Very impressive MrCreator. Mine is just a specialized little tool and I'm not planning on developing a GUI until I have a stable and bulletproof version 1 command line tool.

I'm looking through the code and it's very interesting. Yours is definitely a different approach from mine.

I ran ATT on AU3Text-Demo.au3. It found way too many strings but I can just use the regexp from AU3Text-Extractor to pick up the ones I want. That's pretty awesome. However, it didn't pick up the strings spread across multiple lines. I'll have to figure out a regex pattern for that. And I certainly didn't expect it to rewrite my script! He, lucky for me the script was open in notepad++ so I could undo it all.

Well, it's going to keep me busy for the next hour or so I bet. I'll post further comments in your thread. But I'll say it again, very impressive.

[JackDinn 1]

@dany

Thx for the PM, i had been reading your edits though. The help is appreciated

It looks like i made a major incorrect assumption in that i was hoping for something that would not just organize the language files and help implement them but i was looking for something that would actually do the translation to !

However after looking and gaining some understanding of how you have gone about using individual language files it did open my eyes as to how to go about the whole situation.

I have decided in the end that rather than use other peoples UDF's i would prefer to just keep it as simple as possible and also under my complete control (without parts that i just dont understand).

So what im going to do is replace all my text strings with a func ie _trans("text to translate") (which i would have to do anyhow).

Then when a $makeEnglishFile=1 var is set the _tras func would just create an English translation file.

So after changing all my strings in my code and setting the $makeEnglishFile=1 i would run my program and end up with an English language file. Iv decided on a very simple layout :-

some text,some text

Hello,Hello

More text,More text

text to translate,text to translate

etc etc.

then im thinking i can create a separate AI code to run through the English file and translate the whole thing for each language i need:-

some text,un texte

Hello,Bonjour

More text,Plus de texte

text to translate,texte à traduire

Now atm im using google translate desktop to do the actual translating, its a very simple gui that i can get AI to automate paste English in and retrieve whatever language i need out.

What would be really handy is an AI UDF that i could use really easily {ie. $TransOut=_translate_func("text to translate",lang) } to translate but iv not seen anything quite as simple as that, but im quite happy getting a 3rd party app to do it, id only need to use it once(ish) for each language.

So the final part of the procedure is after creating the individual language files i can turn off the $makeEnglishFile=0 and then on running my app it would read the correct language file into an array and it would then be easy for the _trans("text to translate") func to cross-ref the parsed in English string against the language array.

Well thats what im going to try anyhow. Im sure you chaps have already created all id really need but as i say reading and understanding other people code & how to use it can be a bit out of my league :-/ but i do really appreciate the methodology ,not sure id have thought of it any time soon , lol.

Cheers,

JD.

[dany 33]

Basically, what you describe is also what I've done, save the translation part with Google Translate. Mmmh, could be a nice addition...

Anyway, good luck with your own project!

[guinness 1,518]

Nice idea. One point to make (having skimmed through the code) you don't need to declare $i in _GetOSLanguage for example. I also don't know if others had this problem but I used Tidy (Ctrl+T in SciTE) on your code as it was highlighting as one massive comment, due to alignment issues.

I also couldn't run the example due to the Au3 Script being encoded as 'UTF8 with BOM'.

Func _GetOSLanguage()
    ; Local $i
    For $i = 1 To $__Locale_aTable[0][0]
        If StringInStr($__Locale_aTable[$i][0], @OSLang) Then
            Return $__Locale_aTable[$i][3]
        EndIf
    Next
    Return SetError(1, $E_LOCALE_UNKNOWN_LANGUAGE, $__Locale_aTable[1][3])
EndFunc

[JackDinn 1]

yea i also found all the code to be commented out , i saved the code again and it seemed to sort it out.

But the demo did work in my case though .

[guinness 1,518]

But the demo did work in my case though .

Because you re-saved it. I fixed it at my end, but it's best issues like this get resolved now rather than 2 years down the line.

[dany 33]

Nice idea. One point to make (having skimmed through the code) you don't need to declare $i in _GetOSLanguage for example. I also don't know if others had this problem but I used Tidy (Ctrl+T in SciTE) on your code as it was highlighting as one massive comment, due to alignment issues.

I also couldn't run the example due to the Au3 Script being encoded as 'UTF8 with BOM'.

Ah yes, I'm in the habit of declaring all variables because that's best practise in PHP. But is this an AutoIt issue or something to do with the wrappers and Tidy? Either way, I'll do some code cleaning.

Also, what IS the best format to save my scripts then? I couldn't reproduce your error so I'm curious as to why that would happen...

Edited September 11, 2012 by dany

[dany 33]

Based on guinness' comment I've updated the zip:

• Removed all declarations of Local $i and let autoit handle scoping etc.
• Removed a few other stray unused variables I came across.
• Changed the encoding of all files to UTF-16 LE. That should be best.
• Lastly, fixed a small bug in both _AU3Text_Plural and _AU3Text_SectionPlural, now plural forms should be picked up correctly.

[guinness 1,518]

[*]Removed all declarations of Local $i and let autoit handle scoping etc.

If only used in a For loop then there is no need to declare it.

[dany 33]

That's the only place I use $i, $ii etc. i as in incrementer. Admittedly not very descriptive but since it's the only place I use one-letter variables always easy to spot.

Edited September 11, 2012 by dany

[TheDcoder 1,179]

@dany Thanks for the UDF, it looks very promising, sadly it is no longer working with the latest version of AutoIt. I am not going to necro-post this thread, but I am indeed here to resurrect it!

I fixed up the UDF to run with the latest version, as well as converted the encoding of the script files to UTF-8

Here is the file: AU3Text (Fixed - UTF16 NoBOM - AutoIt v3.3.14.5).zip

Spoiler

AU3Text (Fixed - UTF8 - AutoIt v3.3.14.5).zip
This is the older version which uses UTF8 everywhere, I had issues with the extractor.

Edit: Fixed some more stuff.

Edit 2: Fixed yet more stuff, reverted some of the code to use UTF16 w/o BOM because Ini functions require that encoding...

Edited September 2, 2020 by TheDcoder