Changes between Version 8 and Version 9 of TranslationIntro


Ignore:
Timestamp:
01/05/09 21:41:23 (5 years ago)
Author:
szabgab
Comment:

add more description on translations

Legend:

Unmodified
Added
Removed
Modified
  • TranslationIntro

    v8 v9  
    1 = Short introductory guide to translating Padre = 
     1= Short introductory guide to translating (localizing) Padre = 
     2 
     3There are several thing that can and should be translated. They will be described on this page 
     4 
     5 * The GUI of Padre 
     6 * Plug-ins 
     7 * Perl 5 diagnostics 
     8 * Perl 5 documentation (perldoc in general) 
     9 * Perl 5 call-tips 
     10 * Similar things for other languages  
     11 
     12== Translating the GUI of Padre == 
     13 
    214 
    315The following is intended for people who work on unix-ish operating systems and have no fear for the command line. 
     
    3547Will create a textual report on the status of all the existing translation files. Remember to run this under the 'Padre' subdirectory. 
    3648 
    37 = Adding a translation = 
     49=== Adding a translation === 
    3850 
    3951 0. Check out the list of existing translations: http://svn.perlide.org/padre/trunk/Padre/share/locale/ 
     
    4355 4. Update the {{{Changes}}} file to brag about this new translation! :-) 
    4456 
     57== Plug-ins == 
     58 
     59So far we have not dealt with the translation of the plug-ins. We need a plan. 
     60 
     61== Perl 5 diagnostics == 
     62 
     63We have an integration with translated versions of the perldiag.pod that comes with perl. 
     64( http://perldoc.perl.org/perldiag.html ) 
     65Currently we only found French translation on POD2::FR (http://search.cpan.org/dist/POD2-FR). 
     66 
     67If someone wants to have translation to any language, the right way is to start translating 
     68the perldiag.pod file of perl 5.10 and releasing it as POD2::XY Where XY is the language code. 
     69 
     70Actually even the English version of perldiag.pod could get some improvement. The problem with  
     71it as it is with a large part of the Perl 5 documentation is that in many places it assumes  
     72prior knowledge of C or UNIX. Also in many cases it "correct but not too helpful for beginners". 
     73 
     74e.g. 
     75{{{ 
     76Global symbol "%s" requires explicit package name 
     77 
     78(F) You’ve said "use strict" or "use strict vars", which indicates that all variables 
     79must either be lexically scoped (using "my" or "state"), declared 
     80beforehand using "our", or explicitly qualified to say which package  
     81the global variable is in (using "::"). 
     82}}} 
     83 
     84A beginner probably needs something like this: 
     85 
     86{{{ 
     87You have forgotten to declare the variable using "my" or it was declared in 
     88another scope or it has a typo. 
     89}}} 
     90 
     91So the "translations" don't necessarily have to be exact translations of the 
     92English version but should be good explanations for people with  
     93not much background in Perl. 
     94 
     95See also #169 
     96 
     97As the content of perldiag is huge it is better to start with the most 
     98common warnings and errors. For now see the list here: 
     99http://www.perlmonks.org/?node_id=733201 
     100(TODO: and later maybe copy that list here) 
     101(TODO: provide examples scripts generating each one of the important errors/warnings)  
     102 
     103http://mail.perlide.org/pipermail/padre-dev/2008-December/000368.html  
     104 
     105 
     106== Perl 5 documentation (perldoc in general) == 
     107 
     108Could be translated and uploaded to CPAN as POD2::XY.  
     109We have not implemented it but we should provide and indexed  
     110access to the selected translated version of the documentation. 
     111 
     112There are several modules on CPAN in the POD2:: name space and 
     113there is the  
     114 
     115See also http://perldoc2.sourceforge.net/ 
     116 
     117== Perl 5 call-tips == 
     118 
     119The source of the call-tips is in http://svn.perlide.org/padre/trunk/Padre/share/languages/perl5/perl5.yml 
     120We have not thought of a way how to translate these. (and even the English version needs improvement) 
     121 
     122== Similar things for other languages == 
     123 
     124We have not thought about this yet. 
     125 
     126