= XDCC-Fetch Translation HOW-TO

Creating a new translation is very simple, just follow the next steps.

1. Download the latest version of XDCC-Fetch, extract it, and move to
   the directory "src/Translations".

1. Copy the file "en.rb" to a filename that matches your language. (E.g.
   "de.rb" if you want to translate into German)

1. Open the newly created file with your favourite texteditor, and find
   the following section:

     lang = $cfg.text.en
     lang.language_name = "English"
     
1. Now change the first line to contain the language shortcut (e.g.
   "de", do not use whitespace or any other special character), and
   the second line to contain the name:

     lang = $cfg.text.de
     lang.language_name = "Deutsch"

1. That's all you need to set up, now just translate all the english texts
   into your language. Take care not to forget any of the tabulators
   ('\t'), they are important.

1. After translating, run the script 'check_translations' to check if
   your translation is ok:
   
     ./check_translations de.rb
     
   This prints everything that might be a problem, for example:
   
     missing translation items: none :-)

     untranslated: 12 items :-(
         $cfg.text.de.bot (in English: "Bot")
         $cfg.text.de.channel (in English: "Channel")
         $cfg.text.de.channel_name (in English: "Channel Name")
         $cfg.text.de.name (in English: "Name")
         $cfg.text.de.of (in English: "/")
         $cfg.text.de.packs (in English: "")
         $cfg.text.de.port (in English: "Port")
         $cfg.text.de.revision (in English: "Revision")
         $cfg.text.de.server (in English: "Server")
         $cfg.text.de.status (in English: "Status")
         $cfg.text.de.submit (in English: "&Submit")
         $cfg.text.de.version (in English: "Version")

     translations that can be removed: none :-)

   If there are any missing translations, you may have accidently removed
   something, this should definitely be fixed.
   
   As you can see, untranslated items might not be a problem, sometimes
   terms are the same in several languages.
   
   Translations that can be removed are translations that exist in your
   translation, but not in the english reference language.
   