Locale::Po4a::RubyDoc(3pm)

名前
Locale::Po4a::RubyDoc - Ruby DocumentデータとPO ファイルとを相互変換する

説明
po4a (PO for anything) プロジェクトは、gettext ツールが想定していないドキュメントのような領域で翻訳をしやすくすること (またより興味深いのは、翻訳文の保守がしやすくなること) を目標にしています。

Locale::Po4a::RubyDoc は、Ruby Document (RD) 形式（Rubyのドキュメントを書くのに使われる言語）のドキュメントを他の [自然] 言語に翻訳するのを助けるモジュールです。

このモジュールの状態
このモジュールはこの形式の構文の良い部分については押さえており、単純なRubyドキュメントファイルで試したところうまくいっています。

既知の制約としては、入力のRuby Documentの積み重なった構造を適切に認識するのに失敗するものがあります。これが暗示しているのは、例えばEnumListItemが1つ以上のBlockから構成されているとき、最初のBlockのみが実際にEnumListItemとして認識される一方で、残りのものは単なるTextBlockとして見做されてしまうということです……

このモジュールで使用できるオプション
このモジュールは以下のオプションに対応しています：

puredoc
    全体的に（"=begin"行が1つもない）Ruby Document形式のテキストからなるファイルを扱います。

    既定ではこのモジュールは "=begin" と "=end" の行の間にあるRuby Document形式テキストのみを扱います（したがってその他のものは無視します。最初の "=begin" 行が全てに先立ちます）。

関連項目
Locale::Po4a::TransTractor(3pm)

著者
Francesco Poli <invernomuto@paranoici.org>

訳者
 倉澤 望 <nabetaro@debian.or.jp>
 Debian JP Documentation ML <debian-doc@debian.or.jp>

著作権とライセンス
 Copyright © 2016-2017 Francesco Poli <invernomuto@paranoici.org>

本作はフリーソフトウェアです。フリーソフトウェア財団によって発表されているようにGNU一般公衆利用許諾書の条項のもとに再配布及び変更を行うことができます。利用許諾書のバージョンは2ないし（選択として）それ以降のバージョンのいずれかです。

この作品は有用であることを願って配布されますが、何らの保証もされません。市場性または特定目的への適合性の暗黙の保証さえもありません。詳しくはGNU一般公衆利用許諾書をご覧ください。

この作品とともにGNU一般公衆利用許諾書の複製物を受け取ったはずです。もし受け取っていなければ、Free Software Foundation, Inc, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USAに手紙を出してください。

コードの一部（多くの正規表現など）は、GNU一般公衆利用許諾書バージョン2以降の条件の下で、rdtoolのソースから転用されたものです。これらの部分は元々以下のクレジットです。

 Copyright © 2004      MoonWolf <moonwolf@moonwolf.com>
 Copyright © 2011-2012 Youhei SASAKI <uwabami@gfd-dennou.org>

初期のコードはLocale::Po4a::Textのソースから、GNU一般公衆利用許諾書のバージョン2以降の条項に従って組み入れられました。このコードは元々以下のクレジットでした。

 Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>