README.localization

   1 Ganymede Release 2.0
   2 22 January 2013
   3 README.localization
   4
   5 ---------------------------------------------
   6
   7 Ganymede 2.0 includes extensive support for localization and
   8 internationalization.  The Ganymede server, client, admin console and
   9 text mode xmlclient all use property files to define all publicly
  10 visible message strings.
  11
  12 These properties files are located under src/resources.  The bulk of
  13 the Ganymede server's message files are located under
  14
  15     src/resources/arlut/csd/ganymede/server
  16
  17 and those for the client are located under
  18
  19     src/resources/arlut/csd/ganymede/client
  20
  21 and for the admin console under
  22
  23     src/resources/arlut/csd/ganymede/admin
  24
  25 The Ganymede 2.0 distribution currently includes the default English
  26 language message files and a quite complete German language
  27 translation, provided by Stefan Bier from fg-networking.de.
  28
  29 When you run the Ganymede server, client, or admin console, you will
  30 by default see the language suitable for the system you are running
  31 the server, client, or admin console on.  Dates and numbers will also
  32 be printed with a region and language-suitable form.
  33
  34 If you want, you can force the use of a specific language.  See the
  35 runServer script for instructions on how to set the language for the
  36 server, and the client.jnlp and console.jnlp files for instructions on
  37 how to force a specific language for the client and admin console.
  38
  39 If you like, you can create your own translation files for Ganymede by
  40 creating new properties files in the above directories.
  41
  42 The default message files are named after the classes they are
  43 serving.  For instance, the message strings for the client's central
  44 class, arlut.csd.ganymede.client.gclient, is held in
  45 src/resources/arlut/csd/ganymede/client/gclient.properties.
  46
  47 German language message strings are held in files named after the
  48 class are named the same, with the ISO language code addded to the
  49 name of the class.  The German version of the gclient message file is
  50 called src/resources/arlut/csd/ganymede/client/gclient_de.properties.
  51
  52 By extension, a French language message file would be
  53 gclient_fr.properties, a Norwegian version would be
  54 gclient_no.properties, etc.
  55
  56 You can find a complete list of these language codes at
  57 http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt
  58
  59 To support adopters writing their own translations, Ganymede's ant
  60 build script, src/build.xml, includes special support for validating
  61 all message files against the Ganymede source code.
  62
  63 If you run 'ant validate', a Perl script will be run which will
  64 analyze all message files and cross-check them against the Ganymede
  65 sources.  'ant validate' will print out a report letting you know how
  66 complete your translation is, and whether it is properly constructed.
  67
  68 If you do generate a new translation for Ganymede, we encourage you to
  69 send us patches at ganymede_author@arlut.utexas.edu for us to
  70 incorporate into the master Ganymede repository.
  71
  72 You could also fork Ganymede on GitHub and submit pull requests to
  73 'jonabbey'.
  74
  75 Thanks!
  76
  77 Jonathan Abbey
  78 jonabbey@arlut.utexas.edu