Moodle in English: langdoc.php - a tool for online docs and help files translation

langdoc.php - a tool for online docs and help files translation

by David Mudrák - Tuesday, 15 February 2005, 2:29 AM

Hi!

I've written a small script that can be used for online translation of /docs and /help files. Maybe you can find it useful for your needs

How to install:

download attached langdoc.php
copy it into your /admin Moodle directory
go to http://yourmoodle.url/admin/langdoc.php

langdoc.php

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Martin Dougiamas - Tuesday, 15 February 2005, 3:13 AM

Yay! We've needed that for ages - that's going straight into CVS!

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by János Fehér - Tuesday, 15 February 2005, 3:50 PM

Can we use it on moodle.org? I still waiting for an account to the CVS =)

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Martin Dougiamas - Tuesday, 15 February 2005, 7:24 PM

Sorry, I never saw any mail from you ... just found it now though!

Will mail you back.

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by János Fehér - Tuesday, 15 February 2005, 8:57 PM

It's interesting...

2005-02-11 15:10:55 1CzbVT-000HMe-0i <= feher.janos@mindworks.hu H=adsl215151.vnet.hu (golem.devel.mindworks.hu) [62.77.215
.151] P=esmtp S=1618 id=1108131037.2648.30.camel@ganja.devel.mindworks.hu
2005-02-11 15:10:57 1CzbVT-000HMe-0i => martin@moodle.org R=dnslookup T=remote_smtp H=moodle.org [69.93.78.186] X=TLSv1:AES
256-SHA:256
2005-02-11 15:10:57 1CzbVT-000HMe-0i Completed

The letter was:

Hello Martin, Near half year ago I've sent you a letter about Hungarian translation of Moodle but you haven't answered me. I try to actualize and organize the translation, but I should get a CVS account (aries69 at SF) to update the language files. Can you help me? Bests,

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Martin Dougiamas - Tuesday, 15 February 2005, 11:35 PM

Just because mail gets into my mailbox doesn't mean I always see it!

You should see the size of that thing! Anyhow, I replied today ... you should contact Karoly who is coordinating Hungarian.

Average of ratings: -

Re: langdoc.php - how to handle CVS tags?

by David Mudrák - Tuesday, 17 May 2005, 3:39 PM

Hi folks

I'd like to ask you - should I care about some CVS tags of langdoc.php or is this Martin's job? I've read developer manual but being still CVS beginner I don't understand very much how langdoc.php will became part of official (pre)release.

Thanks for any explanation.

David

Average of ratings: -

Re: langdoc.php - how to handle CVS tags?

by Martin Dougiamas - Tuesday, 17 May 2005, 3:47 PM

Unless there's a big problem with it it will be in Moodle 1.5. Is it all working correctly now?

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by koen roggemans - Tuesday, 15 February 2005, 4:21 AM

Going to test this immediately. Thanks a lot!

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by koen roggemans - Tuesday, 15 February 2005, 6:34 AM

Works great. I love the preview button. With firefox tidy installed, you can immediately check the xhtml-compliance as well, without the need having the site on the internet or to click several times and that for both English and translated file

I just changed the (!) for untranslated files in *** for visability, but I might as wel need new glasses

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Mitsuhiro Yoshida - Tuesday, 15 February 2005, 6:39 AM

Thank you, Great work!
I really love this new cool feature.

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Ling Li - Tuesday, 15 February 2005, 11:19 AM

I have used it on my 1.4.3 installation and it works fine except one problem.

I found the script create a new empty file when I choose a file not existing from the dropdown list, no matter I press save button or not. If I haven't write anything, I will have to delete the empty file by hand sometime later or it prevent the English one being displayed. Maybe it's better not save the empty file.

Average of ratings: -

Re: langdoc.php - a lot of empty files

by David Mudrák - Tuesday, 15 February 2005, 10:23 PM

I know about this problem. It is caused by touch() function (langdoc.php tries to create non-existing file in order to check permissions). I'll try to change this behaviour ASAP.

Average of ratings: -

Svar: langdoc.php - a tool for online docs and help files translation

by Anders Berggren - Tuesday, 15 February 2005, 5:39 PM

Very cool! Thanks.

Anders, Swedish translator.

Average of ratings: -

Re: langdoc.php - PATCH #1

by David Mudrák - Tuesday, 15 February 2005, 11:18 PM

To fix Ling Li's bugreport I've patched langdoc.php. Empty files doesn't remain in the directory now

As long as I haven't got CVS write access I attach patched version to this post.

Thanks all for your feedback!

David (http://moodle.cz)

langdoc.php

Average of ratings: -

Re: langdoc.php - PATCH #1

by Martin Dougiamas - Tuesday, 15 February 2005, 11:40 PM

Hi, David! I made quite a few changes to the script when I checked it in, so this is out of date already!

I've given you CVS access to it so make fixes there! Thanks!

Average of ratings: -

Re: langdoc.php - PATCH #1

by Petr Skoda - Wednesday, 16 February 2005, 12:35 AM

...looking at the code array $options is not initialized

Average of ratings: -

Re: langdoc.php - code array $options is not initialized

by David Mudrák - Wednesday, 16 February 2005, 9:52 PM

Ahoj

Sorry for this. Being newbie to Moodle coding style I forgot this stuff. Good job, Security Officer

Average of ratings: -

Re: langdoc.php - PATCH #1 committed

by David Mudrák - Wednesday, 16 February 2005, 11:25 PM

Done - the patched version is in CVS. I hope it is clean and without bugs now. Thanks for your help!

Average of ratings: -

Re: langdoc.php - PATCH #1 committed

by Nicolas Martignoni - Thursday, 17 February 2005, 3:09 AM

Hi,

Many, many thanks for this tool !

May I suggest to the translators that ANY file in the help folder begins with this string on the first line:



and to set the $filetemplate var in langdoc.php accordingly by default. This way we could know rapidly when the last changes were made. It could be very useful

Thanks again !

Nicolas, french translator

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Lasha Altunashvili - Saturday, 30 April 2005, 7:21 AM

Hi,
Thanks a lot for this script. It's great.

I change it a little bit and added editor support. It is much easier for other translators to do the translation in editor rather then in HTML.
Lasha

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Lasha Altunashvili - Saturday, 30 April 2005, 7:27 AM

Sorry, here is the script.

langdoc.php

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Martin Dougiamas - Saturday, 30 April 2005, 12:24 PM

Sorry, but this is not a good idea, because the editor will produce a lot of messy HTML code with styles in the help files that will need to be cleaned up.

The help files must remain free of all styles so that they can be used in different contexts.

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Lasha Altunashvili - Sunday, 1 May 2005, 3:43 AM

Thanks for your reply Martin. You are right, WYSIWYG editors have there drawback, however you can always switch to the html source editing and compare original to the translated one. HTML editor may encourage other people to translate entire help. As you know not all the help files are translated to other languages (e.g. Russian). I think completely translated help is more valuable than extra several Kb of HTML code.

Anyway this script helps us to move more quickly and other people may find it useful as well. We will make sure all the doc/help files are clean from any extra code.

Thanks again
Lasha

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by David Mudrák - Monday, 2 May 2005, 3:50 PM

Hi Lasha
I don't think so - IMHO it is not a good idea to allow wysiwyg in langdoc.php (for the same reasons as Martin noted). And I don't think that HTML editor would encourage other people to translate help - at least not in my country

But maybe you will find a way how to keep the code clean...
And the last note: my experiences show me it is not necessary to have whole help and doc translated. Users don't read it anyway - they always try to find their own solutions

david

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Lasha Altunashvili - Tuesday, 3 May 2005, 2:19 PM

Hello David,

I like this one "Users don't read it anyway" .

About the way to keep it clean. We are copying the original html to translation box, changing it to HTML and replacing the English text with our translation. it works pretty well.

Our problem is that several translation team members are not familiar with HTML and they prefer to work in editor.

Lasha

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Martin Dougiamas - Tuesday, 17 May 2005, 3:49 PM

If they are not familiar with HTML then it seems even more likely that using the editor will cause problems in the code.

It doesn't take long to learn what the HTML codes do, and they don't need to change them anyway, just avoid them.

Average of ratings: -

Re: langdoc.php - a tool for online docs and help files translation

by Jaime Villate - Wednesday, 4 May 2005, 10:13 PM

Very nice. Thanks David!

But I have a problem:

When I translate a page that includes some php script, it is
replaced by the result of the script.

For example, in the Installation FAQ (faq.html) there is a place
where it is suggested that the user writes the script

<?PHP phpinfo() ?>

to find out what PHP version is running. When I save the changes
to my translation, that line is replaced by the whole outpout
from that command (that does not happen if you edit the file
using the file module).

Average of ratings: -

Re: langdoc.php - should we allow PHP included?

by David Mudrák - Thursday, 5 May 2005, 3:47 AM

Hi Jaime

Thanks for your report! The important question has arised: are <? <php and <PHP tags allowed to be included in help and doc files? Are they needed somewhere? The current version of langdoc assumes the translator to be responsible for the HTML code so it allows put these tags. But we can let some filters to be applied before saving the code.
One has got possibility to include these tags with & lt;php syntax (how is it called - HTML entities?) so I would prefer not to filter anything and trust the translators...

David

Average of ratings: -

Re: langdoc.php - should we allow PHP included?

by Jaime Villate - Thursday, 5 May 2005, 9:20 AM

Yes, you are right.

I did not explain the problem correctly. The current bug is:
when the user first translates the file, he will use entities
< and > when he wants to refer to some tag.

If he tries to edit the translated file again, the
< and > entities in the original file are shown
as < and > in the translation form.
When the user saves the file, even if no changes were done, the
file will be spoiled (the literal tags that were initially
written correctly using entities will be transformed into real tags, causing trouble).

Also. I have not checked it yet, but a single backslash in the original
file should not become a double backslash when one saves a new
version of the file (that was a bug that we already fixed in
the file module).

Average of ratings: -

fix for langdoc.php

by Jaime Villate - Monday, 9 May 2005, 5:43 AM

Translators can see the problem I was referring to if the try
to look at any of the mods.html files, for instance help/hotpot/mods.html, using langdoc.php

You can compare what langdoc.php shows you with the real content
of the file:
http://cvs.sourceforge.net/viewcvs.py/moodle/moodle/lang/en/help/hotpot/mods.html?rev=1.4&view=markup

Due to that bug, there are several translated files,
in several languages, which are wrong. For instance, look at the
Dutch translation of the file above (no need to know Dutch;
just compare the URL in the first line):

http://cvs.sourceforge.net/viewcvs.py/moodle/moodle/lang/nl/help/hotpot/mods.html?rev=1.1&view=markup

The file I send in attachment solves the bug.

langdoc.php

Average of ratings: -

Re: fix for langdoc.php

by koen roggemans - Monday, 9 May 2005, 6:54 AM

Yes, I've been fooled by that one today verlegen

.
So it's the editor causing trouble. Thanks for pointing that out.

I've found about 18 affected files over all language packs in ja/ja_utf8, lt and sv.

I'll fix them asap

Average of ratings: -

Re: fix for langdoc.php

by koen roggemans - Monday, 9 May 2005, 7:14 AM

done

Average of ratings: -

Re: fix for langdoc.php

by Mitsuhiro Yoshida - Monday, 9 May 2005, 7:23 AM

Thanks for ja, ja-utf8 fix!

Average of ratings: -

Re: fix for langdoc.php

by Jaime Villate - Monday, 9 May 2005, 5:53 PM

> I've found about 18 affected files over all language packs in
> ja/ja_utf8, lt and sv

Good job, Koen. You only missed the Finish language (fi) where
instead of "localhost" you should look for occurrances of
"http://moodlepalvelut.fi" which most be the server where
the Finish team has been running langdoc.php

Average of ratings: -

Re: fix for langdoc.php

by koen roggemans - Tuesday, 10 May 2005, 4:25 AM

They don't make it easy up north. Thanks Searched for http in mods and found 16 more

Average of ratings: -

Re: langdoc.php - prevent PHP parsing

by David Mudrák - Sunday, 15 May 2005, 8:40 PM

Thanx Jaime for his report again! There has been a bug in langdoc.php: The content of textarea edit fields has been obtained by include() function and thus been parsed by PHP. I've just changed the code to read the files directly by fread() without PHP processing. I'm going to do some tests and will commit patched version to CVS today.

D.

Average of ratings: -