Lähdekoodi sivulle Gettext

'''Gettext''' on [[GNU]]-projektin työkalu ohjelmien [[kotoistus|kotoistamiseen]]. 

Gettextiä käytettäessä ohjelman käännettävät merkkijonot merkitään sen lähdekoodiin, jonka jälkeen lähdekoodista luodaan alkuperäiset tekstit sisältävä <tt>.pot</tt>-tiedosto. Tähän tiedostoon kääntäjät sitten lisäävät käännökset eri kielille. Lopulta käännökset sisältävä <tt>.po</tt>-tiedosto muutetaan binäärimuotoon ja tallennetaan sopivaan hakemistoon, jonka jälkeen ohjelma korvaa ajonaikana alkuperäiset merkkijonot käännöksillä.

== Käyttö ==

=== Ohjelma käyttämään Gettextiä ===
Luodaan esimerkiksi [[C]]-kielinen esimerkkiohjelma ja sille käännökset. Luodaat tiedosto <tt>ohjelma.c</tt> jonka sisältö on seuraava:
<pre>
#include <stdio.h>
#include <stdlib.h>
/* Gettextin tarvitsemat kirjastot */
#include <libintl.h>
#include <locale.h>

/* Gettext ei ymmärrä muuta kuin gettext()-funktiolla ympäröidyt merkkijonot
   Käytetään mieluummin lyhyempää _()-funktiota, jonka esikääntäjä sitten
   korvaa gettext()-funktiolla */
#define _(merkkijono)    gettext(merkkijono)

int main ( void )
{
  /* Alustetaan Gettext */
  char nimi[] = "ohjelma";
  setlocale ( LC_ALL, "" );   /* Käytetään ympäristömuuttujia */
  bindtextdomain ( ohjelma, "./kaannos" );  /* Haetaan käännökset kaannos-alihakemistosta */
  textdomain ( ohjelma );  /* Otetaan käännökset käyttöön */

  /* Varsinainen ohjelma */

  printf ( _("Hello Linux.fi\n") );

  char url[]="http://linux.fi";
  /* TRANSLATORS: Please let %s as it is */
  printf( _("Visit %s") , url);

  printf("\n");

  return EXIT_SUCCESS;
}
</pre>

Ohjelmassa tulostettavat merkkijonot on korvattu <tt>_()</tt>-funktiolla, jolle annetaan parametrina alkuperäiskielellä kirjoitettu merkkijono. Tämä ohjelma voidaan kääntää normaalisti [[GCC]]:llä:
 gcc ohjelma.c -o ohjelma
Ja ajaa komennolla 
 ./ohjelma
Ohjelman tuloste on nyt normaalisti englanniksi:
 $ ./ohjelma
 Hello Linux.fi
 Visit http://linux.fi

=== Luodaan .pot-tiedosto ===
Nyt kun ohjelma käyttää käännöksiä, on seuraavaksi luotava tiedosto, johon kääntäjät voivat lisätä käännöksiä eri kielille. Lähdekooditiedostojen merkkijonot voidaan hakea <tt>xgettext</tt>-ohjelmalla:
 xgettext ohjelma.c
jonka tuloksena on <tt>messages.po</tt>-niminen tiedosto. Kuitenkin oletuksena <tt>xgettext</tt> ymmärtää vain <tt>gettext()</tt>-funktiolla merkattuja merkkijonoja, joten kerrotaan sille, että käytämme <tt>_()</tt>-funktiota. Lisäksi lähdekoodissa on lisätty kommentti kääntäjille ''TRANSLATORS:''-tunnisteella varustettuna. Koska haluamme sisällyttää nämä kommentit luotavaan tiedostoon, kerrotaan myös tämä avainsana <tt>xgettextille</tt>:
 xgettext -k_ ohjelma.c -o ohjelma.pot
Nyt tiedoston <tt>ohjelma.pot</tt> pitäisi näyttää tältä:
<pre>
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2007-10-13 19:36+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"

#: ohjelma.c:13
#, c-format
msgid "Hello Linux.fi\n"
msgstr ""

#. TRANSLATORS: Please let %s as it is
#: ohjelma.c:17
#, c-format
msgid "Visit %s"
msgstr ""
</pre>
Tiedoston alussa olevat otsikkotiedot on selitetty [[kotoistus]]-artikkelissa.

Tiedostossa alkuperäiset merkkijonot on merkitty <tt>msgid</tt>-kohtiin ja käännökset on tarkoitus kirjoittaa <tt>msgstr</tt>-kohtiin. Huomaa myös kääntäjälle tarkoitettu kommentti, joka kehottaa olemaan muuttamatta <tt>%s</tt>-merkintää joka on välttämätön C-ohjelman toiminnalle.

=== Kääntäminen ===
Kun ohjelmasta on luotu <tt>.pot</tt>-tiedosto, seuraava vaihe on [[kotoistus|käännösten tekeminen]]. Lopullinen käännöstiedosto voisi näyttää tältä (tiedosto <tt>fi.po</tt>:
<pre>
# Linux.fi:n esimerkkiohjelma
# Copyright (C) Linux.fi
# This file is distributed under the same license as the ohjelma package.
# Linux.fi:n koodariryhmä <foo@bar>, 2007
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: 1.0\n"
"Report-Msgid-Bugs-To: linux.fi\n"
"POT-Creation-Date: 2007-10-13 18:51+0300\n"
"PO-Revision-Date: 2007-10-13 18:52+0300\n"
"Last-Translator: Linux.fin käännösryhmä <foo@bar>\n"
"Language-Team: Finnish <fi@bar>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ohjelma.c:14
#, c-format
msgid "Hello Linux.fi\n"
msgstr "Terve Linux.fi\n"

#. TRANSLATORS: Please let %s as it is
#: ohjelma.c:18
#, c-format
msgid "Visit %s"
msgstr "Vieraile osoitteessa %s"
</pre>

=== Käännöksen käyttöönotto ===
Kun käännös on valmis, se pitää muuttaa binäärimuotoon. Tämä onnistuu <tt>msgfmt</tt>-ohjelmalla komennolla
 msgfmt fi.po -o ohjelma.mo
Huomaa, että tiedostonimen pitää olla lähdekoodissa <tt>textdomain()</tt>-funktiolle annettu nimi ja tiedostopäätteen <tt>.mo</tt>.

Koska <tt>bindtextdomain()</tt>-funktiolla on käännöksen poluksi asetettu <tt>./kaannos</tt>, on juuri luoto <tt>ohjelma.mo</tt> tallennettava sen alle sopivaan alihakemistoon joka riippuu käytetystä kielestä, ja suomen tapauksessa se on
 ./kaannos/fi/LC_MESSAGES/
[[Mv|Siirrä]] <tt>ohjelma.mo</tt> nyt tähän polkuun ja aja alussa käännetty ohjelma, jolloin käännösten pitäisi olla käytössä:
 $ ./ohjelma
 Terve Linux.fi
 Vieraile osoitteessa http://linux.fi


== Katso myös ==
*[[Kotoistus]]
[[Luokka:Kehitystyökalut]]