1Locale::Po4a::RubyDoc(3pm)        Po4a Tools        Locale::Po4a::RubyDoc(3pm)
2
3
4

NAME

6       Locale::Po4a::RubyDoc -- Convert Ruby Document data from/to PO files
7

DESCRIPTION

9       The po4a (PO for anything) project goal is to ease translations (and
10       more interestingly, the maintenance of translations) using gettext
11       tools on areas where they were not expected like documentation.
12
13       Locale::Po4a::RubyDoc is a module to help the translation of
14       documentation in the Ruby Document (RD) format (a language used to
15       document Ruby) into other [human] languages.
16

STATUS OF THIS MODULE

18       This module has been successfully tested on simple Ruby Document files
19       covering a good part of the format syntax.
20
21       A known limitation is that it fails to properly recognize the stacked
22       structure of input Ruby Document: this implies that when, for instance,
23       an EnumListItem consists of more than one Block, only the first Block
24       is actually recognized as EnumListItem, while the subsequent ones are
25       considered just as TextBlocks...
26

OPTIONS ACCEPTED BY THIS MODULE

28       This module supports the following option:
29
30       puredoc
31           Handle files entirely made of Ruby Document formatted text (without
32           any "=begin" line).
33
34           By default, this module only handles Ruby Document formatted text
35           between "=begin" and "=end" lines (hence ignoring, among other
36           things, everything that precedes the first "=begin" line).
37

SEE ALSO

39       Locale::Po4a::TransTractor(3pm)
40

AUTHORS

42       Francesco Poli <invernomuto@paranoici.org>
43

45        Copyright © 2016-2017 Francesco Poli <invernomuto@paranoici.org>
46
47       This work is free software; you can redistribute it and/or modify it
48       under the terms of the GNU General Public License as published by the
49       Free Software Foundation; either version 2 of the License, or (at your
50       option) any later version.
51
52       This work is distributed in the hope that it will be useful, but
53       WITHOUT ANY WARRANTY; without even the implied warranty of
54       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
55       General Public License for more details.
56
57       You should have received a copy of the GNU General Public License along
58       with this work; if not, write to the Free Software Foundation, Inc., 51
59       Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
60
61       Parts of the code (such as many regular expressions) were adapted from
62       the source of rdtool, under the terms of the GNU General Public
63       License, version 2 or later.  These parts are originally:
64
65        Copyright © 2004      MoonWolf <moonwolf@moonwolf.com>
66        Copyright © 2011-2012 Youhei SASAKI <uwabami@gfd-dennou.org>
67
68       The initialize code was adapted from the source of Locale::Po4a::Text,
69       under the terms of the GNU General Public License, version 2 or later.
70       This code was originally:
71
72        Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>
73
74
75
76Po4a Tools                        2020-01-30        Locale::Po4a::RubyDoc(3pm)
Impressum