Linux-KDE Romania DOC

How-To pentru documentația KDE


Scopul acestui How-To este de a vă face o idee despre ceea ce înseamnă procesul de traducere a documentației aplicațiilor. Cu alte cuvinte help-ul.

Procesul scrierii

Dacă autorul unei aplicații dorește să scrie documentația pentru programul său în limba maternă (română, germană...), echipa de documentație este aici să vă ajute. Documentația va fi mai întîi tradusă în engleză, apoi această versiune va fi revăzută de vorbitorii de limbă engleză, înainte de a fi utilizată ca bază pentru traducerile în celelalte limbi.

Documentația este scrisă utilizînd un limbaj special numit DocBook. Bineînțeles că există programe care produc HTML, PostScript, etc... din sursa DocBook păstrînd structura documentului (indecși, titluri etc).

DocBook permite un număr de diferit implementări descrise de specificații ``DTD'' (Document Type Definition). Formatul HTML, spre exemplu, este una din cele mai cunoscute implementări ale DocBook pe lîngă multe altele. Echipele de documentație KDE utilizează stilul kde și mai sînt și altele în lucru. Trebuie să menționez că acest document este extrem de sărac și îl voi aduce la zi după ce vor fi finalizate niște HowTo-uri la http://i18n.kde.org (după 10 ianuarie 2000).

Procesul traducerii

Documentația este tradusă numai după ce aplicației corespunzătoare i s-a făcut internaționalizarea (meniurile, dialogurile și mesajele sînt deja traduse în limba română). Acest lucru asigură că documentația face referiri la ecrane și mesaje care sînt afișate de aplicația KDE. Pentru internaționalizarea aplicațiilor citiți această pagină

Traducătorii întotdeauna trebuie să traducă din engleză în română. Pentru fiecare limbaj există un coordonator de echipă. Acest lucru este valabil și pentru română. El este Florin Boariu, pe care vă rugăm să-l contactați pentru lămuriri. Înainte de a începe să traduceți o aplicație contactați șeful de echipă. Revedeți documentațiile deja traduse în română aflate pe server-ul KDE sau pe acesta.

Particularități DocBook

Iată cîteva din deciziile luate de KDE Doc Team și care trebuie cunoscute de un traducător de documentație:

  • Numele fișierelor docbook va fi "index.docbook". Va fi utilizat stilul "book" în loc de "article" sau "refpage".
  • Adaptarea la KDE este minimală (lucrul cu fișiere PNG și alte cîteva). Licența GPL și logo-ul KDE sînt distribuite o singură dată și sînt plasate în directorul common.
  • Fișiere de mai sus vor fi referite din documentațiile individuale printr-un tag <OLink>.
  • Atributul ID pentru tagurile <chapter> sînt obligatorii și cu un înțeles clar. Exemplu: <chapter id="introduction">. Există un program care verifică dacă există acel ID pentru capitole. Aceasta asigură că programul jade (care analizează fișierul docbook) nu va alege nume aleatoare pentru fișierele HTML.
  • Traducătorii de documentație NU trebuie să traducă aceste ID-uri. Fiecare fișier include cel puțin data și versiunea documentației.
  • Istoria reviziilor documentației poate fi minimală și descrie modificările aduse, în timp, documentului și nu aplicației.

Programe de utilizat

Trebuie să utilizați distribuția DocBook. Această nouă formă de scriere a documentațiilor oferă o flexbilitate foarte bună și acoperă toate probleme legate de alcătuirea de documentații tehnice.

Sfaturi

Nu traduceți niciodată o pagină HTML! Întotdeauna porniți de la fișierul DocBook, el este sursa!

Citiți Cursul rapid de DocBook, integral în limba română. De asemenea, dacă intenținați să scrieți documentație pentru aplicația dezvoltată de dumneavoastră sau să vedeți structura unui document DocBook (cu sintaxa evidențiată) atunci îl aveți aici (template-docbook.html).

Întotdeauna respectați structura documentului tradus. Nu adăugați, nu scoateți, nu corectați nimic. Numele și adresa de e-mail a traducătorului trebuie puse în secțiunea "Epilog", subsecțiunea "Autori".


Ultimul autor: Claudiu Costin
Ultima actualizare: 23 decembrie 1999