class RDoc::Generator::POT

frozen_string_literal: true

Generates a POT file.

Here is a translator work flow with the generator.

Create .pot¶ ↑

You create .pot file by pot formatter:

% rdoc --format pot

It generates doc/rdoc.pot.

Create .po¶ ↑

You create .po file from doc/rdoc.pot. This operation is needed only the first time. This work flow assumes that you are a translator for Japanese.

You create locale/ja/rdoc.po from doc/rdoc.pot. You can use msginit provided by GNU gettext or rmsginit provided by gettext gem. This work flow uses gettext gem because it is more portable than GNU gettext for Rubyists. Gettext gem is implemented by pure Ruby.

% gem install gettext
% mkdir -p locale/ja
% rmsginit --input doc/rdoc.pot --output locale/ja/rdoc.po --locale ja

Translate messages in .po

You translate messages in .po by a PO file editor. po-mode.el exists for Emacs users. There are some GUI tools such as GTranslator. There are some Web services such as POEditor and Tansifex. You can edit by your favorite text editor because .po is a text file. Generate localized documentation

You can generate localized documentation with locale/ja/rdoc.po:

% rdoc --locale ja

You can find documentation in Japanese in doc/. Yay!

Update translation¶ ↑

You need to update translation when your application is added or modified messages.

You can update .po by the following command lines:

% rdoc --format pot
% rmsgmerge --update locale/ja/rdoc.po doc/rdoc.pot

You edit locale/ja/rdoc.po to translate new messages.

Constants

DESCRIPTION: Description of this generator

Public Instance Methods

class_dir() click to toggle source

# File lib/rdoc/generator/pot.rb, line 84
def class_dir
  nil
end

generate() click to toggle source

Writes .pot to disk.

# File lib/rdoc/generator/pot.rb, line 76
def generate
  po = extract_messages
  pot_path = 'rdoc.pot'
  File.open(pot_path, "w") do |pot|
    pot.print(po.to_s)
  end
end

Protected Instance Methods

initialize(store, options) click to toggle source

Set up a new .pot generator

# File lib/rdoc/generator/pot.rb, line 68
def initialize store, options #:not-new:
  @options    = options
  @store      = store
end

Private Instance Methods

extract_messages() click to toggle source

# File lib/rdoc/generator/pot.rb, line 89
def extract_messages
  extractor = MessageExtractor.new(@store)
  extractor.extract
end