Changes between Version 8 and Version 9 of TranslationIntro

Timestamp:

01/05/09 21:41:23 (4 years ago)

Author:

szabgab

Comment:

add more description on translations

TranslationIntro

@@ -1 @@
-= Short introductory guide to translating Padre =
+= Short introductory guide to translating (localizing) Padre =
+
+There are several thing that can and should be translated. They will be described on this page
+
+ * The GUI of Padre
+ * Plug-ins
+ * Perl 5 diagnostics
+ * Perl 5 documentation (perldoc in general)
+ * Perl 5 call-tips
+ * Similar things for other languages 
+
+== Translating the GUI of Padre ==
+
 
 The following is intended for people who work on unix-ish operating systems and have no fear for the command line.
@@ -35 +47 @@
 Will create a textual report on the status of all the existing translation files. Remember to run this under the 'Padre' subdirectory.
 
-= Adding a translation =
+=== Adding a translation ===
 
  0. Check out the list of existing translations: http://svn.perlide.org/padre/trunk/Padre/share/locale/
@@ -43 +55 @@
  4. Update the {{{Changes}}} file to brag about this new translation! :-)
 
+== Plug-ins ==
+
+So far we have not dealt with the translation of the plug-ins. We need a plan.
+
+== Perl 5 diagnostics ==
+
+We have an integration with translated versions of the perldiag.pod that comes with perl.
+( http://perldoc.perl.org/perldiag.html )
+Currently we only found French translation on POD2::FR (http://search.cpan.org/dist/POD2-FR).
+
+If someone wants to have translation to any language, the right way is to start translating
+the perldiag.pod file of perl 5.10 and releasing it as POD2::XY Where XY is the language code.
+
+Actually even the English version of perldiag.pod could get some improvement. The problem with 
+it as it is with a large part of the Perl 5 documentation is that in many places it assumes 
+prior knowledge of C or UNIX. Also in many cases it "correct but not too helpful for beginners".
+
+e.g.
+{{{
+Global symbol "%s" requires explicit package name
+
+(F) You’ve said "use strict" or "use strict vars", which indicates that all variables
+must either be lexically scoped (using "my" or "state"), declared
+beforehand using "our", or explicitly qualified to say which package 
+the global variable is in (using "::").
+}}}
+
+A beginner probably needs something like this:
+
+{{{
+You have forgotten to declare the variable using "my" or it was declared in
+another scope or it has a typo.
+}}}
+
+So the "translations" don't necessarily have to be exact translations of the
+English version but should be good explanations for people with 
+not much background in Perl.
+
+See also #169
+
+As the content of perldiag is huge it is better to start with the most
+common warnings and errors. For now see the list here:
+http://www.perlmonks.org/?node_id=733201
+(TODO: and later maybe copy that list here)
+(TODO: provide examples scripts generating each one of the important errors/warnings) 
+
+http://mail.perlide.org/pipermail/padre-dev/2008-December/000368.html 
+
+
+== Perl 5 documentation (perldoc in general) ==
+
+Could be translated and uploaded to CPAN as POD2::XY. 
+We have not implemented it but we should provide and indexed 
+access to the selected translated version of the documentation.
+
+There are several modules on CPAN in the POD2:: name space and
+there is the 
+
+See also http://perldoc2.sourceforge.net/
+
+== Perl 5 call-tips ==
+
+The source of the call-tips is in http://svn.perlide.org/padre/trunk/Padre/share/languages/perl5/perl5.yml
+We have not thought of a way how to translate these. (and even the English version needs improvement)
+
+== Similar things for other languages ==
+
+We have not thought about this yet.
+
+