Warning, /education/khangman/README.languages is written in an unsupported language. File is not indexed.

0001 Dear Translator,
0002 
0003 Here is a an outline of the steps necessary to translate the words of the game to your language. There are 175 words to translate but you can add more if you want.
0004 
0005 The twenty two available languages so far by code: ca cs da de en es fr fi hu it nb nl nn pt pt_BR ru sl sr sr@Ltn sv tg tr 
0006 
0007 Most of this data should be completed to include hints, please see below. 
0008 
0009 Complete data: fr en it only have hints so the other above languages must be updated as soon as possible.
0010 
0011 The words are stored in 4 separate files, one for each level. The files are in /khangman/data/en. The file easy.txt is for level easy, the file medium.txt is for level medium, the file animals.txt is for level animals and the file hard.txt is for level hard.
0012 
0013  English is the default and thus the only language to be shipped with KHangMan. All other language data are put in the correct kde-i18n. 
0014  
0015 1. Be sure you are working with the latest cvs HEAD sources of KHangMan by issuing a 
0016 
0017 cvs up -dPA khangman 
0018 
0019 in the kdeedu module.
0020 Then
0021 cd kdeedu/khangman
0022 
0023 2. Enter the following commands in a konsole to create the directory
0024    and files for the new language:
0025 
0026      ./add_language <language_code>
0027 
0028    Here you must replace <language_code> with your language code.
0029    
0030 The program will refuse a non-valid language code! 
0031 
0032 3. The files now use the kvtml format. The tag <o> is for the word and the tag <t> is for the hint. Try to match the hint with the level of difficulty. The level 'Easy' will require an easy hint but the level 'Hard' will require the definition in the dictionary. Try not to use words of the same family in the hint, that would give the word away too easily! An example of a kvtml file is as follow: 
0033 
0034 <?xml version="1.0"?> 
0035 <!DOCTYPE kvtml SYSTEM "kvoctrain.dtd"> 
0036 <kvtml> 
0037 <e> 
0038 <o>cane</o> 
0039 <t>รจ il tuo animale domestico preferito</t> 
0040 </e> 
0041 ...
0042 ...
0043 </kvtml>
0044  
0045  4. Edit all indicated text files in the new directory with a text editor, and replace each word inside the <o> tag with a translated word and each hint inside a <t> with a translated hint. It is not really important that the exact meaning is preserved, but try to keep the length and level of difficulty roughly the same.
0046  You can include words with white space or - in them, in that case the white space or the - will be shown instead of the _.
0047  Please contact me if there is anything special related to your language so I can adapt the code to it (especially the special and accented characters). 
0048 
0049 You can just translate the words but you can also adapt them following the level and add new words if you want. For example, "table" is in level easy in English but in your language, it can be level medium. Feel free to adapt the files to your language needs. The number of words in a file is not important, you can add some if you want.
0050 
0051  
0052 
0053 Note that you must use UTF-8 encoding when editing the files. If your editor can't do this, try using kwrite or kate. When opening a file in kwrite or kate you can select utf8 encoding with the top right combo box.
0054 
0055  Please keep the actual english tts in your language_code dir.
0056 
0057 5. Enter the following command to install the new data files:
0058 
0059      make
0060      make install
0061 
0062    You may have to become root to run 'make install', depending on your
0063    installation.
0064 
0065 6. Run the game and check that your language has been added:
0066 
0067      khangman
0068 
0069 7. Instead of committing your files, please sent them to me tarred and gzipped. As there are now twenty two languages, a   wizard (KNewStuff) is now included in KHangMan to easily download and install new languages that are placed on the website. This is done to reduce the size of the kdeedu module and it will also be done in KLettres, KStars and maybe KTouch.
0070  Please contact me by email (annemarie.mahfouf AT free DOT fr) if you need further information.
0071  When you send me the files, please don't forget to mention any special characters used in your language (put them in a text file, one per line and add this file in the tarball) and please mention any other specificity.
0072  Please never commit files in a BRANCH as it might break the game.
0073 
0074 Good luck and thanks!
0075 
0076 Last update: October 23rd 2004