PO4A.7(1)

ИМЕ
po4a - радни оквир за превод документације и осталог материјала

Увод
po4a (PO for anything [PO за било шта]) олакшава одржавање превода докумената употребом класичних gettext алата. Главна особина po4a је да раскида везу између садржаја превода и структуре његовог документа.

Овај документ служи као увод у po4a који се обраћа потенцијалним корисницима који разматрају да ли да употребе овај алат и радозналима који желе да разумеју зашто су ствари онакве какве су.

Зашто po4a?
Филозофија Слободног Софтвера је да се технологија заиста учини доступном свима. Али лиценцирање није једина брига: непреведени слободни софтвер је бескористан корисницима који не говоре енглески језик. Стога, имамо да одрадимо још посла како би софтвер био доступан свима.

Многи пројекти су добро разумели ову ситуацију и сада су сви убеђени у неопходност превођења свега. Ипак, само превођење представља огроман напор многих појединаца, отежан малим техничким потешкоћама.

На сву срећу, софтвер Отвореног Кода се уствари врло добро преводи употребом gettext свите алата. Они се користе за издвајање стрингова који треба да се преведу и за њихово представљање у стандардизованом формату (који се зове PO фајлови, или каталози превода). Појавио се читав екосистем алата који помажу преводиоцима да заиста преведу ове PO фајлове. gettext у време извршавања користи резултат превођења да крајњим корисницима прикаже преведене поруке.

Што се тиче документације, ситуација је још увек донекле разочаравајућа. На први поглед превођење документације може да изгледа лакше него превођење програма, јер се чини да је само потребно да ископирате изворни фајл документације и почнете да преводите садржај. Међутим, када се оригинална документација измени, праћење промена се брзо претвара у ноћну мору за преводиоце. Ако се ради ручно, овај задатак је непријатан и склон грешкама.

Застарели преводи су често гори од ситуације када уопште нема превода. Крајњи корисницу могу да буду заварани документацијом која описује старо понашање програма. Уз то, они не могу да имају директну интеракцију са одржаваоцима јер не говоре енглески језик. А одржаваоци такође не могу да поправе проблем јер не знају сваки језик на који је њихова документација преведена. Ове потешкоће, које су често последица лошег избора алата, могу да поткопају мотивацију преводиоца волонтера, чиме се проблем додатно погоршава.

Циљ po4a пројекта је да олакша рад преводиоцима документације. Тачније, он омогућава одржавање превода документације.

Идеја је да се искористи и прилагоди gettext приступ овом пољу. Као са gettext, текстови се издвајају из својих оригиналних локација и представљају преводиоцима као PO каталози превода. Преводиоци могу да искористе класичне gettext алате да прате рад који треба да се уради, сарађују и да се организују у тимове. po4a затим умеће преводе директно у структуру документације и тако прави преведене изворне фајлове који могу да се обраде и дистрибуирају на исти начин као и енглески фајлови. Сваки пасус који није преведен остаје на енглеском у излазном документу, па се на тај начин обезбеђује да крајњи корисници никада не виде застарели превод у документацији.

Ово аутоматизује већину незгодног посла у одржавању превода. Откривање пасуса које је потребно освежити постаје веома једноставно и процес је потпуно аутоматизован када је редослед елемента преуређен без даљих измена. Такође може да се користи и одређена верификација како би се умањила могућност грешака форматирања због којих би се документ искварио.

Молимо да такође погледате и ЧПП ниже у овом документу да бисте видели комплетнију листу добрих и лоших страна овог приступа.

  Подржани формати
Тренутно је овај приступ успешно имплементиран на неколико врста формата за форматирање текста:

man (стабилни парсер)
    Стари добри формат за стране приручника који користи велики број програма. Овде је po4a подршка веома добродошла јер је овај формат донекле компликован за коришћење и уопште није погодан за почетнике.

    Модул Locale::Po4a::Man(3pm) такође подржава и mdoc формат који користе BSD man стране (оне су такође прилично уобичајене и на Linux системима).

AsciiDoc (стабилан парсер)
    Ово је једноставан формат за обележавање који је намењен за поједностављивање писања документације. На пример, коришћен је за документовање git система. Те man стране су преведене уз помоћ po4a.

    За још детаља, погледајте Locale::Po4a::AsciiDoc.

pod (стабилни парсер)
    Ово је Perl Online Documentation формат. Сам језик и његова проширења су документовани употребом овог формата заједно са већином постојећих Perl скрипти. Он олакшава држање документације близу кода који описује уграђујући их заједно у исти фајл. Чини живот програмера једноставнијим, али на несрећу не и преводиочев. Све док не почнете да користите po4a.

    За више детаља, погледајте Locale::Po4a::Pod.

sgml (стабилни парсер)
    Чак и ако је данас превазиђен са XML форматом, овај формат се и даље користи за документе који су дугачки више од неколико екрана. Чак може да се користи и за комплетне књиге. Ажурирање докумената ове дужине може да буде прилично изазовно. diff се често показује бескорисним када је увлачење оригиналног текста поново урађено након ажурирања. На сву срећу, po4a може да вам помогне након тог процеса.

    Тренутно су подржани само DebianDoc и DocBook DTD описи, али додавање подршке за неки нови је заиста једноставно. Чак је могуће да се употреби po4a на непознатом SGML DTD без измене кода достављајући неопходне информације преко командне линије. Погледајте Locale::Po4a::Sgml(3pm) за више детаља.

TeX / LaTeX (стабилни парсер)
    LaTeX формат је главни формат документације који се користи у свету Слободног Софтвера као и за публикације.

    Модул Locale::Po4a::LaTeX(3pm) је тестиран са Python документацијом, књигом и неким презентацијама.

text (стабилни парсер)
    Text формат је базни формат за многе друге формате који укључују дугачке блокове текста, укључујући Markdown, fortunes, YAML одељак пре главног текста, debian/changelog, и debian/control.

    Ово подржава уобичајене формате који се користе за Генераторе Статичког Сајта, ПРОЧИТАЈМЕ, и остале системе документације. Погледајте Locale::Po4a::Text(3pm) за више детаља.

xml и XHMTL (вероватно стабилан парсер)
    XML формат је базни формат за многе формате документације.

    po4a тренутно подржава DocBook DTD (погледајте Locale::Po4a::Docbook(3pm) за више детаља) и XHTML.

BibTex (вероватно стабилан парсер)
    Формат BibTex се користи уз LaTex за форматирање листи референци (библиографије).

    За више детаља, погледајте Locale::Po4a::BibTex.

Docbook (вероватно стабилан парсер)
    Језик означавања заснован на XML који за описивање докумената користи семантичке ознаке.

    За више детаља, погледајте Locale::Po4a:Docbook.

Guide XML (вероватно стабилан парсер)
    XML формат документације. Овај модул је специјално развијен као помоћ за подршку и одржавање превода Gentoo Linux документације све до барем марта 2016 (како каже Wayback Machine). Од тада се Gentoo пребацио на DevBook XML формат.

    За више детаља, погледајте Locale::Po4a:Guide.

Wml (вероватно стабилан парсер)
    Web Markup Language, немојте да помешате WML са WAP протоколом који се користи на мобилним телефонима. Овај модул се ослања на Xhtml модул, који се са своје стране ослања на XmL модул.

    За више детаља, погледајте <Locale::Po4a::Wml>.

Yaml (вероватно стабилан парсер)
    Стриктни надскуп JSON. YAML се често користи за пројекте система или конфигурације. YAML је језгро за Ansible компаније Red Hat.

    За више детаља, погледајте Locale::Po4a::Yaml.

RubyDoc (вероватно стабилан парсер)
    Формат Ruby Document (RD), у почетку подразумевани формат документације за Ruby и Ruby пројекте пре конверзије у RDoc 2002. године. Мада изгледа да јапанска верзија Ruby референтног приручника још увек користи RD.

    За више детаља, погледајте Locale::Po4a::RubyDoc.

Halibut (вероватно експериментални парсер)
    Систем документације са елементима који личе на TeX, debiandoc-sgml, TeXinfo и остале, развио је Сајмон Татам, програмер програма PuTTY.

    За више детаља, погледајте Locale::Po4a:Halibut.

Ini (вероватно експериментални парсер)
    Формат фајла за конфигурацију који је MS-DOS учинио популарим.

    За више детаља, погледајте Locale::Po4a::Ini.

texinfo (врло експериментални парсер)
    Сва GNU документација је написано у овом формату (то је чак један од захтева да се постане званичан GNU пројекат). Подршка за Locale::Po4a::Texinfo(3pm) у po4a је и даље на почетку. Молимо да пријавите багове и поднесете захтеве за новим могућностима.

gemtext (врло експериментални парсер)
    The native plain text format of the Gemini protocol. The extension ".gmi" is commonly used. Support for this module in po4a is still in its infancy. If you find anything, please file a bug or feature request.

org (very highly experimental parser)
    The document format used by the Org mode. Support for this module in po4a is still in its infancy. If you find anything, please file a bug or feature request.

vimhelp (very highly experimental parser)
    The format used for Vim help files (and some third-party plugin documentation). Support for this format in po4a is still in its infancy. If you find anything, please file a bug report or feature request.

simplepod (very highly experimental parser)
    Similar to the previously mentioned pod, this one adopts the new Pod::Simple as its parser. Since it is newly created, some bugs are expected. If you notice any strange behavior, please let us know. Eventually, this module will replace pod.

Остали подржани формати
    Po4a can also handle some more rare or specialized formats, such as the documentation of compilation options for the 2.4+ Linux kernels (Locale::Po4a::KernelHelp) or the diagrams produced by the dia tool (Locale::Po4a::Dia). Adding a new format is often very easy and the main task is to come up with a parser for your target format. See Locale::Po4a::TransTractor(3pm) for more information about this.

Неподржани формати
    Нажалост, po4a још нема подршку за неколико формата документације. Подршка за многе од њих би се лако додала у po4a. То укључује формате који се не користе само за документацију, као што су описи пакета (deb и rpm), питања у скриптама за инсталацију пакета, дневници измена пакета, и сво специјализовани фајл формати које користе програми као што су сценарија за игре или wine ресурс фајлови.

Употреба po4a
Најједноставнији начин да овај алат употребите у свом пројекту је да напишете конфигурациони фајл за po4a програм и да онда имате интеракцију само за овим програмом. Молимо вас да прочитате његову документацију, налази се у po4a(1). Остатак овог одељка наводи више детаља битних напредним корисницима програма po4a који желе да продубе своје разумевање.

  Детаљна схема процеса рада са програмом po4a
Обавезно најпре прочитајте po4a(1) пре овог врло детаљног одељка да бисте имали упрошћени преглед процеса рада са програмом po4a. Вратите се овде када желите да погледате застрашујућу комплетну слику, са скоро свим детаљима.

In the following schema, master.doc is an example name for the documentation to be translated; XX.doc is the same document translated in the language XX while doc.XX.po is the translation catalog for that document in the XX language. Documentation authors will mostly be concerned with master.doc (which can be a manpage, an XML document, an AsciiDoc file, etc); the translators will be mostly concerned with the PO file, while the end users will only see the XX.doc file.

Прелази са угластим заградама као што је "[po4a ажурира po]" представљају извршавање po4a алата, док прелази са витичастим заградама као што је "{ажурирање мастер.doc}" представљају ручну измену фајлова пројекта.

                                   master.doc
                                       |
                                       V
     +<-----<----+<-----<-----<--------+------->-------->-------+
     :           |                     |                        :
{translation}    |          {update of master.doc}              :
     :           |                     |                        :
   XX.doc        |                     V                        V
 (optional)      |                 master.doc ->-------->------>+
     :           |                   (new)                      |
     V           V                     |                        |
  [po4a-gettextize]   doc.XX.po -->+   |                        |
          |            (old)       |   |                        |
          |              ^         V   V                        |
          |              |   [po4a updates po]                  |
          V              |           |                          V
   translation.pot       ^           V                          |
          |              |        doc.XX.po                     |
          |              |         (fuzzy)                      |
    {translation}        |           |                          |
          |              ^           V                          V
          |              |     {manual editing}                 |
          |              |           |                          |
          V              |           V                          V
      doc.XX.po --->---->+<---<-- doc.XX.po    addendum     master.doc
      (initial)                 (up-to-date)  (optional)   (up-to-date)
          :                          |            |             |
          :                          V            |             |
          +----->----->----->------> +            |             |
                                     |            |             |
                                     V            V             V
                                     +------>-----+------<------+
                                                  |
                                                  V
                                     [po4a updates translations]
                                                  |
                                                  V
                                                XX.doc
                                             (up-to-date)

Да поновимо, ова схема је веома компликована. Погледајте po4a(1) да видите упрошћени преглед.

Леви део приказује како po4a-gettextize(1) може да се употреби за конверзију постојећег пројекта превода у po4a инфраструктуру. Ова скрипта узима оригинални документ и његов документ његовог превода, па покушава да изгради одговарајући PO фајл. Таква ручна конверзија је прилично незграпна (за више детаља, погледајте po4a-gettextize(1) документацију), али је неопходно да се обави само једном како би се конвертовали ваши постојећи преводи. Ако немате никакве преводе за конверзију, можете да заборавите на све ово и да се фокусирате на десни део схеме.

У врху десног дела је приказана акција оригиналног аутора, освежавање документације. Средњи десни део приказује аутоматска ажурирања фајлова превода: нови материјал се издваја и пореди са постојећим преводом. За делове који се нису изменили користиће се претходни превод, док се делимично измењени делови повезују са претходним преводом помоћу „fuzzy” ознаке која означава да превод мора да се ажурира. Нови или доста измењени материјал се оставља непреведен.

Затим, ручно уређивање означава радњу преводилаца,који мењају PO фајлове како би обезбедили преводе за сваки оригинални стринг и пасус. Ово може да се обави било употребом специјализованог едитора као што је GNOME Translation Editor, KDE-ов Lokalize или poedit, било употребом платформе за локализацију на мрежи као што је weblate или pootle. Резултат превода је скуп PO фајлова, по један за сваки језик. За више детаља, молимо вас погледајте gettext документацију.

Доњи део слике приказује како po4a креира преведени изворни документ из мастер.doc оригиналног документа и doc.XX.po каталога превода који су преводиоци ажурирали. Поново се искоришћава структура документа, док се оригинални садржај замењује својим одговарајућим преводом. Необавезно, може да се употреби додатак како би се превод допунио неким додатним текстом. Ово се често користи да се дода име преводиоца финалном документу. Погледајте ниже за још детаља.

Када се покрене, po4a аутоматски ажурира и фајлове превода и преведене фајлове документације.

  Започињање новог пројекта превода
Ако почињете од нуле, потребно је само да напишете конфигурациони фајл за po4a и спремни сте. За фајлове који недостају се аутоматски креирају одговарајући шаблони, тако да сарадници могу почети да преводе ваш пројекат на свој језик. Молимо вас да погледате po4a(1). Тамо се налази туторијал за брзи почетак, као и сви детаљи.

Ако имате постојећи превод, нпр, фајл документације који је ручно преведен, алатом po4a-gettextize његов садржај можете да интегришете у po4a процес рада. Овај задатак је донекле напоран (као што је описано у man страници алата), али једном када се ваш пројекат конвертује у po4a процес рада, све ће се ажурирати аутоматски.

  Ажурирање превода и докумената
Једном када се подеси, покретање po4a је довољно да се ажурирају и PO фајлови за превођење и преведени документи. Програму po4a можете да проследите "--no-translations" ако не желите да се ажурирају преводи (односно да се ажурирају само PO фајлови) или "--no-update" ако не желите да се ажурирају PO фајлови (односно да се ажурирају само преводи). Ово отприлике одговара појединачним po4a-updatepo и po4a-translate скриптама које су сада застареле (погледајте „Зашто су појединачне скрипте застареле” у ЧПП испод).

  Употреба додатака за додавање додатног текста преводима
Додавање новог текста преводу је вероватно једина ствар која је једноставнија на дуже стазе у случају када фајлове преводите ручно :). Ове се дешава када желите да додате допунски одељак преведеном документу, који не одговара никаквом садржају оригиналног документа. Класични случај употребе је за одавање признања преводилачком тиму, као и да се наведе начин за пријаву проблема који се тичу превода.

Са po4a, морате да наведете додатак фајлове, на које концептуално може да се гледа као на закрпе које се примењују над локализованим документом након обраде. Сваки додатак мора да се достави као посебан фајл, чији формат је међутим, веома различит у односу на класичне закрпе. Прва линија је линија заглавља, која дефинише тачку уметања додатка (нажалост са криптичном синтаксом -- погледајте ниже) док се остатак фајла умеће дословно на одређену позицију.

Линија заглавља мора да почне са стрингом PO4A-HEADER:, након чега следи листа кључ=вредност поља раздвојених са тачка запета знацима.

На пример, следеће заглавље декларише додатак који мора да се постави на сам крај превода.

 PO4A-HEADER: mode=eof

Ствари постају компликованије када додатни садржај желите да поставите у средину документа. Наредно заглавље декларише додатак који у превод мора да се постави након XML одељка који садржи стринг "У вези овог документа".

 PO4A-HEADER: position=About this document; mode=after; endboundary=</section>

У пракси, када покушава да примени додатак, програм po4a тражи прву линију која задовољава "position" аргумент (то може да буде регизраз). Не заборавите да po4a овде разматра преведени документ. Ова документација је на српском језику, али ваша линија би вероватно требало да изгледа као што следи, у случају да намеравате да свој додатак уметнете у француски превод.

 PO4A-HEADER: position=À propos de ce document; mode=after; endboundary=</section>

Онда када се у циљном документу пронађе "position", програм po4a тражи следећу линију након "position" која се подудара са наведеним "endboundary". Додатак се умеће непосредно иза те линије (јер смо задали endboundary, тј. границу на којој се завршава текући одељак).

Потпуно исти ефекат би могао да се добије следећим еквивалентним заглављем:

 PO4A-HEADER: position=About this document; mode=after; beginboundary=<section>

Овде програм po4a тражи у преводу прву линију која се подудара са "<section>" након линије која се подудара са "У вези овог документа", и умеће додатак испред те линије, јер смо задали beginboundary, тј. границу која означава почетак наредног одељка. Тако да ова линија заглавља захтева да се додатак постави иза одељка који садржи "У вези овог документа", и обавештава програм po4a да одељак започиње линијом која садржи ознаку "<section>". Ово је еквивалентно са претходним примером јер, у суштини, оно што заиста желите је да уметнете овај додатак иза "</section>" или испред "<section>".

Можете такође да поставите режим уметања mode на вредност "before", са сличном семантиком: комбиновање "mode=before" са "endboundary" ће да постави додатак непосредно иза пронађене границе, то јест последње потенцијалне граничне линије испред "position". Комбиновање "mode=before" са "beginboundary" ће да постави додатак непосредно испред пронађене границе, то јест последње потенцијалне граничне линије испред "position".

  Mode   | Boundary kind |     Used boundary      | Insertion point compared to the boundary
 ========|===============|========================|=========================================
 'before'| 'endboundary' | last before 'position' | Right after the selected boundary
 'before'|'beginboundary'| last before 'position' | Right before the selected boundary
 'after' | 'endboundary' | first after 'position' | Right after the selected boundary
 'after' |'beginboundary'| first after 'position' | Right before the selected boundary
 'eof'   |   (none)      |  n/a                   | End of file

Савети и трикови у вези додатака

•   Запамтите да су све ово регуларни изрази. На пример, ако желите да пронађете крај nroff одељка који се завршава са линијом ".fi", немојте да користите ".fi" као endboundary, јер ће то да пронађе "the[ fi]le", што очигледно није оно што очекујете. У овом случају, исправна вредност за endboundary је: "^\.fi$".

•   Празни карактери у садржају "position" и граница СУ БИТНИ. Тако да се наредне две линије разликују. Друга ће да се пронађе само онда када у преведеном документу има довољно празних карактера на крају.

     PO4A-HEADER: position=About this document; mode=after; beginboundary=<section>
     PO4A-HEADER: position=About this document ; mode=after; beginboundary=<section>

•   Мада се може помислити да се ова претрага контекста оквирно врши над сваком линијом преведеног документа, она се у ствари врши над интерном стрингу података преведеног документа. Овај интерни стринг података може да буде текст који се протеже над пасусом који садржи више линија, или може да буде само једна XML ознака. Тачно место уметања додатка мора да буде пре или након интерног стринга података и не може да се нађе унутар тог стринга података.

•   Да бисте разумели како се додаци умећу у превод, проследите аргумент -vv програму po4a. Од помоћи је и да покренете програм po4a у дибаг режиму јер тако можете да видите стварне интерне стрингове података у случају када се додатак не примењује.

Примери додатака

•   Ако желите да додате нешто након следећег nroff одељка:

      .SH "AUTHORS"

    Требало би да изаберете приступ у два корака постављањем mode=after. Затим би требало да сузите претрагу на линију након AUTHORS регуларним изразом за аргумент position. Затим би требало да пронађете почетак наредног одељка (нпр. ^\.SH) помоћу регуларног израза за аргумент beginboundary. Дакле:

     PO4A-HEADER:mode=after;position=AUTHORS;beginboundary=\.SH

•   Ако желите да додате нешто непосредно иза одређене линије (нпр. након линије „Права умножавања Велики Даса”), искористите position које се подудара са том линијом, mode=after и за beginboundary задајте да се подудара са било којом линијом.

     PO4A-HEADER:mode=after;position=Copyright Big Dude, 2004;beginboundary=^

•   Ако желите нешто да додате на крај документа, поставите да се position подудара са било којом линијом вашег документа (али само са једном линијом. Програм Po4a неће наставити даље ако није једна линија), и поставите да се endboundary не подудара ни са чим. Овде немојте да користите једноставне стрингове као "EOF", већ радије задајте оне за које је мала вероватноћа да постоје у вашем документу.

     PO4A-HEADER:mode=after;position=About this document;beginboundary=FakePo4aBoundary

Детаљнији пример

Оригинални документ (POD форматиран):

 |=head1 NAME
 |
 |dummy - a dummy program
 |
 |=head1 AUTHOR
 |
 |me

Затим, следећи додатак ће обезбедити да се одељак (на француском) у вези преводиоца дода на крај фајла (на француском "TRADUCTEUR" значи "TRANSLATOR", а "moi" значи "me").

 |PO4A-HEADER:mode=after;position=AUTEUR;beginboundary=^=head
 |
 |=head1 TRADUCTEUR
 |
 |moi
 |

Да бисте уметнули свој додатак испред AUTHOR, употребите следеће заглавље:

 PO4A-HEADER:mode=after;position=NOM;beginboundary=^=head1

Ово функционише јер је наредна линија која се подудара са beginboundary "/^=head1/" иза одељка "NAME" (преведено на "NOM" у француском), она која наводи ауторе. Дакле, додатак ће да се постави између ова два одељка. Приметите да ако се касније дода још један одељак између NAME и AUTHOR одељака, програм po4a ће погрешно да постави додатак испред тог новог одељка.

Да бисте ово спречили, исти резултат можете да постигнете употребом mode=before:

 PO4A-HEADER:mode=before;position=^=head1 AUTEUR

На који начин програм функционише?
Ово поглавље ће да вам представи кратак преглед унутрашњих процеса у програму po4a, тако да нам можете са више самопоуздања помоћи да га одржавамо и унапређујемо. Такође може да вам помогне да разумете зашто не ради нешто што очекујете, као и да вам представи начине за решавање ваших проблема у раду са програмом.

  TransTractor-и и архитектура пројекта
У језгру po4a пројекта, класа Locale::Po4a::TransTractor(3pm) је заједнички предак за све po4a парсере. Ово чудно име је последица чињенице да је она у исто време задужена и за превођење документа и за издвајање стрингова.

Формалније речено, она узима документ који треба да се преведе као и PO фајл који садржи преводе који треба да се користе као улаз, а генерише два одвојена излаза: други PO фајл (произашао као резултат издвајања преводивих стрингова из улазног документа), и преведени документ (са истом структуром као и улазни документ, али са свим преводивим стринговима замењеним садржајем улазног PO). Ево графичке представе овога:

   Input document --\                             /---> Output document
                     \      TransTractor::       /       (translated)
                      +-->--   parse()  --------+
                     /                           \
   Input PO --------/                             \---> Output PO
                                                       (extracted)

Ова мала кост је срж целе po4a архитектуре. Ако наведете оба улаза и одбаците излазни PO, добијате po4a-translate. Ако уместо тода одбаците излазни документ, добијате po4a-updatepo. Програм po4a користи први TransTractor да добије ажурирани POT фајл (одбацујући излазне документе), затим позива msgmerge -U да ажурира PO фајлове превода на диску и изграђује други TransTractor са овим ажурираним PO фајловима да би ажурирао излазне документе. Укратко, po4a обезбеђује решење које у једном кораку ажурира све што је потребно, уз употребу само једног конфигурационог фајла.

po4a-gettextize такође користи два TransTractor-а, али на другачији начин: он изграђује по један TransTractor за сваки језик, па онда изграђује нови PO фајл чији су msgid стрингови msgid стрингови оригиналног документа, а msgstr стрингови msgid стрингови преведеног документа. Да би се обезбеило да се стрингови подударени на овакав начин и заиста подударају, потребно је много труда, као што је описано у po4a-gettextize(1).

  Парсери за одређене формате
Сви po4a парсери формата се имплементирају преко TransTractor. Неки од њих су врло једноставни, као што су Text, Markdown и AsciiDoc. Они читају једну по једну линију користећи TransTractor::shiftline(), акумулирају садржаје пасуса или шта већ. Онда када се стринг у потпуности парсира, парсер користи TransTractor::translate() да (1) уметне овај стринг у излазни PO фајл и (2) преузме превод из улазног PO фајла. Парсер затим гура резултат у излазни фајл користећи TransTractor::pushline().

Неки други парсеру су сложенији јер се за анализу улазног документа ослањају на спољни парсер. Xml, HTML, SGML и Pod парсери су изграђени преко SAX парсера. Они декларишу функције повратног позива на догађаје као што је „Пронашао сам нови наслов чији је садржај следеће” којима ажурирају излазни документ и излазне POT фајлове у сагласности са садржајем на улазу користећи TransTractor::translate() и TransTractor::pushline(). Yaml парсер је сличан, али ипак различит: он серијализује структуру података коју прави YAML::Tiny парсер. То је разлог што Yaml модул програма po4a не успева да декларише линије референци: парсер не чува локацију сваког стринга у улазном фајлу, тако да једино можемо навести „$filename:1” као стринг локације. Парсери засновани на SAX користе глобале и остале трикове за чување референци на имена фајлова и бројеве линија.

Један посебан проблем настаје услед кодирања фајла и BOM маркера. Прости парсеру могу да забораве на проблем, то се обрађује у TransTractor::read() (користи се интерно за читање линија улазног документа), али модули који се ослањају на спољни парсер морају обезбедити да се сви фајлови читају одговарајућим PerlIO слојем за декодирање. Најједноставнији начин је да сами отворите фајл, па да свом спољном парсеру проследите ручку фајла, или директно комплетни стринг. Погледајте Pod::read() и Pod::parse() на пример. Садржај који чита TransTractor се игнорише, али се спољном парсеру прослеђује свежа ручка фајла. Важан део је "<:encoding($charset)" режим који се прослеђује open() perl функцији.

  Po објекти
Класа Locale::Po4a::Po(3pm) је задужена за учитавање и употребу PO и POT фајлова. Тачније, можете да читате фајл, додајете ставке, преузимате преводи gettext() методом, уписујете PO у фајл. Напредније функције као што је спајање PO фајла у односу на POT фајл или потврђивање фајла се делегирају програмима msgmerge и msgfmt редом.

  Давање доприноса пројекту po4a
Чак и ако никада раније нисте дали допринос ниједном пројекту Отвореног кода, добродошли: вољни смо да вам помогнемо и да овде будемо ваш ментор. Данас po4a најбоље одржавају његови корисници. Пошто нам недостаје радне снаге, покушавамо да пројекат учинимо приступачнијим тако што унапређујемо документацију и аутоматске тестове тако да осетите поузданост приликом давања доприноса пројекту. За више детаља, молимо вас да погледате CONTRIBUTING.md фајл.

Пројекти отвореног кода који користе po4a
Следи веома делимична листа пројеката који за своју документацију у продукцији користе po4a. Ако свој пројекат желите да додате на ову листу, само нам пошаљите мејл (или Merge захтев).

•   adduser (man): алат за управљање корисницима и групама.

•   apt (man, docbook): Debian менаџер пакета.

•   aptitude (docbook, svg): терминалски менаџер пакета за Debian

•   F-Droid вебсајт <https://gitlab.com/fdroid/fdroid-website> (markdown): каталог FOSS (Free and Open Source Software) апликација за Андроид платформу које могу да се инсталирају.

•   git <https://github.com/jnavila/git-manpages-l10n> (asciidoc): дистрибуирани систем за контролу верзија који служи за праћење измена у изворном коду.

•   Linux manстране <https://salsa.debian.org/manpages-l10n-team/manpages-l10n> (man)

    Овај пројекат обезбеђује инфраструктуру за превођење многих manстраница на различите језике, спремне за интеграцију у неколико главних дистрибуција (Arch Linux, Debian и из њега изведене, Fedora).

•   Stellarium <https://github.com/Stellarium/stellarium> (HTML): бесплатан планетаријум отвореног кода за ваш компјутер. po4a се користи за превод описа небеске културе.

•   Jamulus <https://jamulus.io/> (markdown, yaml, HTML): FOSS апликација за онлајн jamming у реалном времену. Документација веб сајта се одржава на више језика помоћу po4a.

•   Још једна ставка која треба да се среди: <https://gitlab.com/fdroid/fdroid-website/> <https://github.com/fsfe/reuse-docs/pull/61>

ЧПП

  Како се изговара po4a?
Ја га лично изговарам као pouah <https://en.wiktionary.org/wiki/pouah>, што је француска ономатопејска реч коју користимо уместо бљак :) Вероватно имам чудан смисао за хумор :)

  Зашто су појединачне скрипте застареле?
Indeed, po4a-updatepo and po4a-translate are deprecated in favor of po4a. The reason is that while po4a can be used as a drop-in replacement to these scripts, there is quite a lot of code duplication here. Individual scripts last around 150 lines of codes while the po4a program lasts 1200 lines, so they do a lot in addition of the common internals. The code duplication results in bugs occurring in both versions and needing two fixes. One example of such duplication are the bugs #1022216 in Debian and the issue #442 in GitHub that had the exact same fix, but one in po4a and the other po4a-updatepo.

На дуже стазе, желео бих да укинем појединачне скрипте и да одржавам само једну верзију овог кода. Оно што је сигурно је то да се појединачне скрипте више неће унепређивати, тако да ће само po4a добијати нове функционалности. С друге стране, нема хитности око застаревања. Планирам да појединачне скрипте чувам што је могуће дуже, барем до 2030. године. Ако ваш пројекат у 2030. још увек користи po4a-updatepo и po4a-translate можда ћете наићи на проблем.

Можда у неком тренутки и укинемо застаревање ових скрипти, ако рефакторисање сведе диплирање кода на нулу. Ако имате идеју (или још боље: закрпу), ваша помоћ је добродошла.

  Шта је са осталим алатима за превођење документације помоћу gettext?
Има их неколико. Ево вероватно непотпуне листе, са још алата који су близу хоризонта.

poxml
    Ово је алат који су развили KDE људи за обраду DocBook XML. Колико ја знам, то је први програм који издваја из документације стрингове за превод у PO фајлове, па их након превођења умеће назад.

    Он може да ради само са XML форматом, и само са одређеним DTD. Посебно нисам задовољан начином на који обрађује листе, које на крају постају један велики msgid. Када листа постане велика, залогај постаје тежак за гутање.

po-debiandoc
    Овај програм који је урадио Дени Барбије представља неку врсту претече po4a SGML модула, који га мање-више чини застарелим. Као што име говори, он обрађује само DebianDoc DTD, што је такође мање-више застарео DTD.

xml2po.py
    Употребљава GIMP Тим за документацију од 2004. године, функционише прилично добро упркос томе што, као што име наговештава, ради само са XML фајловима и захтева специјално конфигурисане makefile фајлове.

Sphinx
    За управљање својим преводима, Sphinx Documentation Project такође доста користи gettext. Нажалост, функционише само за неколико текст формата, rest и markdown, мада је вероватно једини алат који то ради управљајући комплетним процесом превођења.

Главне предности програма po4a над њима је једноставност уметања додатног садржаја (која је тамо још гора) и могућност постизања gettextизације.

  РЕЗИМЕ предности приступа базираног на gettext

•   Преводи се не чувају заједно са оригиналом, чиме је омогућено да се открије застарелост превода.

•   Преводи се чувају засебно у одвојеним фајловима, чиме се спречава међусобно ометање преводиоца различитих језика, како током предаје својих закрпа тако и на нивоу кодирања фајла.

•   Интерно је заснован на gettext (мада po4a нуди веома једноставан интерфејс, тако да не морате разумети унутрашње функционисање да бисте га користили). На тај начин не морамо поново да откријемо рупу на саксији, а из разлога што су ти алати широко распрострањени, можемо претпоставити и да су мање-више ослобођени багова.

•   За крајње кориснике ништа није промењено (осим чињенице да ће највероватније боље да одржавају преводе). Резултујући фајл документације који се дистрибуира је потпуно исти.

•   Нема потребе да преводиоци уче нову синтаксу фајлова и њихов омиљени едитор PO фајлова (као што су Емаксов PO режим, Lokalize или Gtranslator) ће сасвим лепо да функционише.

•   gettext обезбеђује једноставан начин за добијање статистика у вези онога што је урађено, онога што треба да се редигује и ажурира, као и онога што је још преостало да се уради. Неки пример може да се пронађе на следећим адресама:

     - https://docs.kde.org/stable5/en/kdesdk/lokalize/project-view.html
     - http://www.debian.org/intl/l10n/

Али није све тако сјајно, овај приступ има и неке лоше стране са којима морамо да се носимо.

•   Додаци су на први поглед донекле чудни.

•   Преведени текст не можете да прилагодите по свом нахођењу, као на пример, да овде поделите пасус, а онде спојите друга два. Мада у неку руку, ако постоји проблем са оригиналом, то би у сваком случају требало да се пријави као баг.

•   Чак и са једноставним интерфејсом, он је ипак нови алат који људи морају научити како да користе.

    Један од мојих снова би био да некако интегришемо po4a у Gtranslator или Lokalize. Када се фајл документације отвори, стрингови се аутоматски издвоје, и преведени фајл + po фајл могу да се упишу на диск. Ако успемо да урадимо MS Word (TM) модул (или макар RTF) можда би га чак користили и професионални преводиоци.

ПОГЛЕДАЈТЕ ТАКОЂЕ

•   Документација све-у-једном алата који би требало да користите: po4a(1).

•   Документација појединачних po4a скрипти: po4a-gettextize(1), po4a-updatepo(1), po4a-translate(1), po4a-normalize(1).

•   Додатне помоћне скрипте: msguntypot(1), po4a-display-man(1), po4a-display-pod(1).

•   The parsers of each formats, in particular to see the options accepted by each of them: Locale::Po4a::AsciiDoc(3pm) Locale::Po4a::Dia(3pm), Locale::Po4a::Gemtext(3pm), Locale::Po4a::Guide(3pm), Locale::Po4a::Ini(3pm), Locale::Po4a::KernelHelp(3pm), Locale::Po4a::Man(3pm), Locale::Po4a::RubyDoc(3pm), Locale::Po4a::Texinfo(3pm), Locale::Po4a::Text(3pm), Locale::Po4a::Xhtml(3pm), Locale::Po4a::Yaml(3pm), Locale::Po4a::BibTeX(3pm), Locale::Po4a::Docbook(3pm), Locale::Po4a::Halibut(3pm), Locale::Po4a::LaTeX(3pm), Locale::Po4a::Org(3pm), Locale::Po4a::Pod(3pm), Locale::Po4a::SimplePod(3pm), Locale::Po4a::Sgml(3pm), Locale::Po4a::TeX(3pm), Locale::Po4a::VimHelp, Locale::Po4a::Wml(3pm), Locale::Po4a::Xml(3pm).

•   Имплементација основне инфраструктуре: Locale::Po4a::TransTractor(3pm) (од посебне важности за разумевање организације кода), Locale::Po4a::Chooser(3pm), Locale::Po4a::Po(3pm), Locale::Po4a::Common(3pm). Молимо вас да у стаблу изворног кода такође погледате и фајл CONTRIBUTING.md.

АУТОРИ
 Denis Barbier <barbier,linuxfr.org>
 Martin Quinson (mquinson#debian.org)