education/kstars/README.i18n

0001 README.i18n:  Instructions for Translating KStars
0002 copyright 2002 by Jason Harris and the KStars team.
0003 This document is licensed under the terms of the GNU Free Documentation License
0004 -------------------------------------------------------------------------------
0005
0006
0007 Some parts of i18n in KStars are a bit complicated, so we provide
0008 this document to answer some questions you might have.
0009
0010 + Strings in data files.
0011
0012   KStars has many data files that contain strings that you may want
0013   to translate:  cities.dat, cnames.dat, image_url.dat, info_url.dat
0014
0015   We have modified our Makefile to automatically parse these files
0016   and generate a "dummy" source file that only contains the translatable
0017   strings from our data files.  The file is called "kstars-i18n.cpp".
0018   Once the kstars.pot file is generated, this file is destroyed.
0019
0020   The advantage to this is that it requires no special effort on the
0021   part of the translation teams; the data file strings are automatically
0022   added to our POT file.  The disadvantage is that our POT file is now
0023   quite large!  Especially because of the city names.  Probably, most of
0024   the city names won't need to be translated.  We added a comment to
0025   these strings indicating that they are optional.
0026
0027   cnames.dat contains constellation names, in Latin.  We include
0028   an option in the program to display "Localized" names instead of
0029   Latin names; if you want this to work for your language, you'll
0030   need to provide translations for the strings in the POT file which
0031   have a comment like: "Constellation name (optional)".
0032
0033
0034 + Alternate internet URL lists
0035
0036   KStars provides many internet links to images and information on
0037   specific objects in the sky.  The links appear in an object's
0038   right-click popup menu.  The POT file already provides the link
0039   text for translation, but there's still a problem:  the websites
0040   that the links go to are all in English!
0041
0042   If you want to provide internet links that point to websites
0043   in your native language, you can.  Add a file to the SVN tree at:
0044   l10n-kde4/<lang>/data/kdeedu/kstars/info_url.dat (where <lang> is
0045   the two-letter code for your language).  This file should contain
0046   the list of internet links you want KStars to use when localized
0047   for your language.  You can look at the default info_url.dat to
0048   figure out the file format; briefly, it's a colon-delimited line
0049   with fields: object name, link text, link URL
0050
0051   Note that your alternate info_url.dat file will completely replace
0052   the default, so if you want to include some links from the original,
0053   you will need to copy them over.  Some of the sites we link to provide
0054   versions of their pages in other languages (e.g., seds.org).  So
0055   for these sites, you can just modify the URLs from the default file.
0056
0057   (you can also provide a localized version of image_url.dat, but this
0058   is probably unnecessary since these are only image links).
0059