LOCALE::PO4A::RUBYDOC.3PM(1)

NAAM
Locale::Po4a::RubyDoc - Ruby Document data van/naar PO-bestanden converteren

BESCHRIJVING
Het doel van het project po4a (PO voor alles) is om de vertaalwerkzaamheden (en interessanter nog, het onderhoud van vertalingen) te vergemakkelijken met behulp van gettext-hulpmiddelen in domeinen waarin deze niet meteen verwacht worden, zoals documentatie.

Locale::Po4a::RubyDoc is een module ter ondersteuning van de vertaling van documentatie in de Ruby Document (RD) indeling (een taal die gebruikt wordt voor het documenteren van Ruby) naar andere [menselijke] talen.

STATUS VAN DEZE MODULE
Deze module is met succes getest op eenvoudige Ruby Document-bestanden die een groot deel van de syntaxis van het bestandsformaat dekken.

Een bekende beperking is dat het de gestapelde structuur van input Ruby Document niet goed herkent: dit houdt in dat wanneer, bijvoorbeeld, een EnumListItem uit meer dan één Block bestaat, alleen het eerste Block als EnumListItem wordt herkend, terwijl de volgende gewoon als TextBlocks worden beschouwd...

MOGELIJKE OPTIES BIJ DEZE MODULE
Deze module ondersteunt de volgende optie:

puredoc
    Bestanden verwerken die volledig uit in Ruby Document opgemaakte tekst bestaan (zonder enige "=begin" regel).

    Standaard verwerkt deze module alleen in Ruby Document opgemaakte tekst tussen "=begin" en "=end" regels (en negeert daarom onder andere alles wat voorafgaat aan de eerste "=begin" regel).

ZIE OOK
Locale::Po4a::TransTractor(3pm)

AUTEURS
Francesco Poli <invernomuto@paranoici.org>

COPYRIGHT EN LICENTIE
 Copyright © 2016-2017 Francesco Poli <invernomuto@paranoici.org>

Dit werk is vrije software; u kunt het opnieuw distribueren en/of wijzigen onder de voorwaarden van de GNU General Public License zoals gepubliceerd door de Free Software Foundation, ofwel versie 2 van de Licentie, of (naar uw keuze) een latere versie.

Dit werk wordt verspreid in de hoop dat het nuttig zal zijn, maar ZONDER ENIGE GARANTIE; zelfs zonder de impliciete garantie van VERKOOPBAARHEID of GESCHIKTHEID VOOR EEN BEPAALD DOEL. Zie de GNU General Public License voor meer details.

U zou samen met dit werk een kopie van de GNU General Public License moeten hebben ontvangen; zo niet, schrijf dan naar de Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Delen van de code (zoals veel reguliere expressies) zijn aangepast vanuit de bron van rdtool, onder de voorwaarden van de GNU General Public License, versie 2 of later. Deze onderdelen zijn oorspronkelijk:

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

De initialize-code werd aangepast vanuit de broncode van Locale::Po4a::Text, onder de voorwaarden van de GNU General Public License, versie 2 of later. Deze code was oorspronkelijk:

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