[Back] [English] [Japanese]

Ruby GetText Package

What is Ruby GetText Package?

Ruby GetText Package is Native Language Support Library and Tools which modeled after GNU gettext package.

Requirements

• Ruby 1.6.6 <http://www.ruby-lang.org/ja/>
• GNU gettext 0.10.35 <http://www.gnu.org/software/gettext/gettext.html>

　(Development times only)

Download

ruby-gettext-package-0.2.1.tar.gz

Install

De-Compress archive and enter its top directory.
Then type:

# ruby install.rb config
# ruby install.rb setup
# ruby install.rb install

You can also install files in your favor directory by
supplying install.rb some options. Try "ruby install.rb --help".

Basic term explanation

pot-file, po-file

They are the text files with msgid(Original message) and msgstr(Translated message). You can create it with rgettext from your script file.

mo-file

This is binary files which created from po-files by msgfmt.

domain(TextDomain)

domain is just mo-file name. Usually, it is called PACKAGE(like in GNOME).

API Reference

module GetText

GetText.bindtextdomain(domainname, path = nil, locale = nil)

Bind TextDomain to #{path}/#{locale}/LC_MESSAGES/#{domainname}.mo

• path - When value is nil, it is search in /usr/share/locale, /usr/local/share/locale)
• locale - When value is nil, it is searched in ENV(LC_ALL > LC_CTYPE > LC_MESSAGES > LANG).

GetText._(msgid)

GetText.gettext(msgid)

Return localized text by msgid. If there are not binded mo-file, it will return msgid.

GetText.N_(msgid)

Return msgid. This method does nothing. But it is required in order to recognize the msgid by rgettext.

GetText.setlocale(locale)

Set locale(String) like "C", "de", "fr", "it", "ko", "ja_JP.eucJP", "zh_CN.EUC" ...

rgettext

rgettext is the tool which create po-files from your Ruby Scripts.

Usage

$rgettext hoge.rb -o hoge.po

Development procedure

Create hello.rb

For example, write hello.rb as follows.

require 'gettext'

include GetText

bindtextdomain("hello")
print _("Hello World\n")

Pick up strings in the script(create a po-file)

Create a po-file with rgettext.

$rgettext hello.rb -o hello.pot

Translate hello.pot into <your language>.po.

This example for Japanese(not 2-byte string but 1-byte alphabet).

$cp hello.pot ja.po

Then edit ja.po as follows.

#: ../hello.rb:7
msgid "Hello World\n"
msgstr "KON-NICHI-WA SEKAI\n"

In addition, you can use the some tools in GNU gettext package for maintainig po-file.

* How to use GetText.N_(msgid)

GetText.N_(msgid) is used with GetText._(msgid).

require 'gettext'

include GetText
bindtextdomain("hello_noop")

msgs = [N_("Hello World"), N_("Hello World2")]

msgs.each do |msg|
  print _(msg), "\n"
end

In this case, rgettext can not recognize _(msg) as msgid.
But since you use GetText.N_(msgid) to define the messages, it is recognized as msgid by rgettext.

* If are there "fuzzy" comments?

If po-file have some fuzzy comments as follows:

#: hello.rb:7
#, fuzzy
msgid "Hello World"
msgstr "KON-NICHI-WA SEKAI"

Then confirm the messages(msgid and msgstr) are correct, and remove "fuzzy" line.

#: hello.rb:7
msgid "Hello World"
msgstr "KON-NICHI-WA SEKAI"

Make a mo-file.

Finally, you make a mo-file, and put it into a path properly.
In this example, you don't set path in bindtextdomain(), GetText search mo-file in /usr/share/locale/#{lang}/LC_MESSAGES/ or /usr/local/share/locale/#{lang}/LC_MESSAGES/. So you put it into one of them.
Here, you put it into /usr/local/share/locale/ja/LC_MESSAGES/.

$msgfmt ja.po -o /usr/local/share/locale/ja/LC_MESSAGES/

Run the script

$ruby hello.rb

Is it OK? Congratulations!

If you can't show the messages in your language, execute it with -d option.

$ruby -d hello.rb
Search path:["/usr/share/locale", "/usr/local/share/locale"]
locale:"ja_JP.eucJP"

MO file is not found in
      /usr/share/locale/ja_JP.eucJP/LC_MESSAGES/hello.mo
      /usr/share/locale/ja_JP/LC_MESSAGES/hello.mo
      /usr/share/locale/ja/LC_MESSAGES/hello.mo
      /usr/local/share/locale/ja_JP.eucJP/LC_MESSAGES/hello.mo
      /usr/local/share/locale/ja_JP/LC_MESSAGES/hello.mo
      /usr/local/share/locale/ja/LC_MESSAGES/hello.mo

Check hello.mo is in one of those pathes.

Difference from GNU gettext

• bindtextdomain has locale argument.
• do not exist a method same as textdomain function.
• do not support category.

License

This program is licenced under the same licence as Ruby.
(See the file 'COPYING'.)

mo.rb

Copyright (C) 2001 Masahiro Sakai <s01397ms@sfc.keio.ac.jp>

gettext.rb

Copyright (C) 2001,2002 Masahiro Sakai <s01397ms@sfc.keio.ac.jp>, Masao Mutoh <mutoh@highwhay.ne.jp>

rgettext

Copyright (C) 2001,2002 Yasushi Shoji <yashi@yashi.com>, Masao Mutoh <mutoh@highwhay.ne.jp>

install.rb

Copyright (C) 2000,2001 Minero Aoki <aamine@loveruby.net>
This file is released under LGPL. See the top of the install.rb.

Ruby GetText Package

Copyright (C) 2001,2002 Masao Mutoh <mutoh@highwhay.ne.jp>

Maintainer

Masao Mutoh <mutoh@highway.ne.jp>

ChangeLog

2002-02-22 Masao Mutoh <mutoh@highway.ne.jp>

• docs/rd/[ja|en]/ruby-gettext.rd: Some modified.
  
• lib/gettext.rb: show more informations in debug mode(-d)
  
• bin/rgettext: BugFix for bad implementation of GetText.N_(msg).
  by Masahiro Sakai<zvm01052@nifty.ne.jp>
  
• po/ja.po: change charset from iso-2022-jp to euc-jp.
  by Masahiro Sakai<zvm01052@nifty.ne.jp>
  
• 0.2.1 is released.
  

2002-02-21 Masao Mutoh <mutoh@highway.ne.jp>

• lib/gettext.rb: Implement GetText.N_(msg)
  
• bin/rgettext: Apply to GetText.N_(msg)
  
• samples/hello_noop.rb: Add a sample for GetText.N_(msg).
  
• test/gettext_test.rb: Add test_noop.
  
• docs/rd/[ja|en]/ruby-gettext.rd: Add an explanation of GetText.N_(msg).
  
• 0.2.0 is released.
  

2002-02-13 Masao Mutoh <mutoh@highway.ne.jp>

• ruby-gettext-package:
  Move pre-clean.rb to pre-install.rb.
  Reported by Yoshifumi Hiramatsu<hiramatu@boreas.dti.ne.jp>
  
• lib/gettext.rb: Improve search-path(@locale_dirs).
  
• bin/rgettext, samples/*.rb:
  Improve first line(Add #! line or change #!/usr/bin/env ruby to
  #!/usr/local/bin/ruby).
  
• samples/hellotk.rb: add new sample for Ruby/Tk
  
• 0.1.2 is released.
  

2002-02-03 Masao Mutoh <mutoh@highway.ne.jp>

• lib/gettext.rb: BugFix to occur an error
  when all of locale is not set.
  
• README, README.ja: Modified about Bad explanation
  in Install section. Reported by
  Yoshifumi Hiramatsu<hiramatu@boreas.dti.ne.jp>
  
• docs/rd/*/ruby-gettext.rd: Some improvements.
  
• docs/yard2html.rb: Some improvements.
  
• 0.1.1 is released.
  

2002-01-06 Masao Mutoh <mutoh@highway.ne.jp>

• lib/gettext.rb: Bugfix for bad scope.
  
• bin/rgettext: Sort by file, lineno.
  
• test/: Add one test.
  
• docs/rd/*/ruby-gettext.rd: Modified about rgettext.
  
• 0.1.0 is released.
  

2002-01-01 Masao Mutoh <mutoh@highway.ne.jp>

• docs/: Add english document and some improvements.
  
• test/: Add one test.
  
• samples/: Add hello2.rb.
  
• 0.0.2 is released.
  

2001-12-24 Masao Mutoh <mutoh@highway.ne.jp>

• test release
  

$Id: ruby-gettext.rd,v 1.13 2002/02/22 14:15:35 mutoh Exp $