OpenOffice.org 1.1

Localizarea Fişierelor de Ajutor
Folosind Mini Framework

Cuprins

Lucruri necesare	3

Sistem de operare	3

Mediul Java Runtime	3

Perl	3

Instalare	3

Utilizare	5

La ce foloseşte structura dosarelor?	5

Ce face script-ul?	6

Ce nu face script-ul?	7

Daca nu reuşiţi din prima...	8

Cum să creezi ajutorul	8

Condiţii	8

PASUL 1: Furnizarea fişierelor de intrare	8

PASUL 2: Rulaţi Script-ul	9

PASUL 3: Furnizaţi fişierele pentru instalare	9

Reguli pentru localizarea fişierelor	9

Următoarele fişiere trebuie localizate manual:	9

Următoarele fişiere sunt localizate automat:	10

Următoarele fişiere pot necesita ajustări:	10

Următoarele fişiere nu necesită localizare sau ajustare:	10

Revision: August 2003 Owner: Frank Peters (fpe@sun.com) Translating romanian: Mihai Kovács

Lucruri necesare

Sistem de operare

Script-ul foloseşte comenzi de sistem Windows (2000).

Mediul Java Runtime

Trebuie să aveţi instalat corect Java JRE 1.3.1 sau superior.

Perl

Scriptul necesită Perl 5 pentru a se instala corect. A fost testat folosind Perl 5.6.1. Pachetul benchmark trebuie să fie instalat pentru a folosi funcţiile de cronometrare.

Instalare

Creaţi un dosar pentru asamblarea fişierului de ajutor, ex. SO6_Help

Despachetaţi arhiva L10NHelp.zip în acest dosar păstrând structura subdosarelor.

Adăugaţi subdosarul {SO6_Help}/program la variabila path .

Ajustaţi calea către interpretorul perl în prima linie a script-ului perl createhelp.pl:

#!path/to/your/perl.exe

Ajustaţi următoarele înregistrări de la Set global variables în script-ul perl createhelp.pl:

#--------------------------------------------------------#
# Set global variables
#--------------------------------------------------------#
# adjust these:
$root_dir = 'C:\SO6_Help\\';
$java_dir = 'C:\JavaSoft\JRE\1.3.1';
$CLASSPATH = "$java_dir\\lib\\rt.jar;$java_dir\\lib\\tools.jar";

Scrieţi numele dosarului unde aţi despachetat fişierul zip la $root_dir, e.g.

$root_dir = 'C:\SO6_Help\\';

Asiguraţivă că folosiţi ghilimele simple (') şi la sfârşit două backslash-uri.

Scrieţi dosarul unde se găseşte instalat Java JRE la $java_dir, e.g.

$java_dir = 'C:\JavaSoft\JRE\1.3.1';

Asiguraţivă că folosiţi ghilimele simple (') şi la sfârşit fără backslash.

Scrieţi calea spre rt.jar şi tools.jar la $CLASSPATH separate de punct şi virgula, ex.

$CLASSPATH = "$java_dir\\lib\\rt.jar;$java_dir\\lib\\tools.jar";

Asiguraţivă că folosiţi ghilimele duble şi backslash-uri duble. Separaţi căile folosind punct şi virgulă şi folosiţi variabila $java_dir definită mai sus pentru a desemna dosarul „root“ (rădăcină) al instalării Java.

Nu trebuie să schimbaţi celelalte înregistrări de la începutul script-ului perl dacă folosiţi structura dată de dosare.

Utilizare

La ce foloseşte structura dosarelor?

Dupa ce aţi despachetat fişierele zip într-un dosar după dorinţă veţi vedea următorul arbore de subdosare:

{INSTALLDIR}

etc

input

etc

{lang}

etc

text

picture

output

{lang}

program

classes

stylesheets

Indexing

PreTransformation

source

installset

{lang}

etc	Acest dosar conţine fişiere suplimentare ca DTD-urile pentru documentele de ajutor care în sine nu sunt necesare pentru producţia ajutorului. Puteţi folosi aceste DTD-uri pentru a verifica validitatea fişierelor de ajutor localizate.
input	Acest dosar conţine fişierele de intrare, ex. Fişierele de ajutor localizate. Scriptul preia fişierele din acest dosar.
input\etc	Acest dosar conţine fişierele suplimentare necesare pentru producerea ajutorului pentru toate limbile ca de exemplu main transformation style sheet main_transform.xsl şi STOPLIST care conţine cuvinte ce trebuie excluse de procesul de indexare.
input\{lang}	Acest dosar trebuie creat de tine şi conţine ramificaţiile cu fişierele xml de ajutor text\, cu imaginile şi dosarul etc\ care conţine fişierele suplimentare dependente de limbă.
input\{lang}\etc	Acest dosar conţine fişiere specifice de limbă suplimentare, ca de exemplu bazele de date de temă(topic) specifice de platformelor *.txt, fişierele de vizualizare arborescentă, fişierele de configurare, fişierele de stiluri personalizate etc.
output	Acest dosar conţine subdosare cu fisiere de ajutor care se pot folosi pentu testări.
output\{lang}	Acest dosar este creat când porneşte script-ul. Presupunând că fişierele de intrare sunt plasate în input\newspeek, dosarul output\newspeek va fi creat.
program	Acest dosar conţine bibleoteci şi programe folosite de script.
program\classes	Acest dosar conţine clase java folosite de script.
stylesheets\ Indexing	Acest dosar conţine fişiere de stiluri folosite de script pentru a crea fişierele de index.
stylesheets\ PreTransformation	Acest dosar conţine fişiere de stiluri folosite de script pentru a transforma fişierele xml.
source	Aici puteţi plasa arborele sursă a limbi sursă favorite pentru referinţă. Structura de dosare găsită aici poate fi folosită ca referinţă pentru structura arborelui de dosare de intrare.
installset	Acest dosar conţine subdosare cu fişierele de ajutor finale rezultate.
installset\{lang}	Aici este cea ce probabil doriţi: arhivele de ajutor care pot fi folosite pentru a construi o versiune.

Ce face script-ul?

Script-ul perl depinde puternic de structura corectă a dosarelor (vezi mai sus) şi de fişierele xml valide în dosarele de ajutor. Generează ajutorul în (1+)6 paşi. Vezi scriptul perl în sine pentru explicaţi asupra unor proceduri particulare.

Fişierele de ieşire sunt plasate în dosare dependente de limbă (cu acelaşi nume ca dosarul de intrare). În acest fel limbi multiple pot fi (în teorie) procesate în acelaşi timp (dacă vă permite calculatorul) prin pornirea scriptului de mai multe ori cu parametri diferiţi. Diferitele limbi nu ar trebui să interfereze (netestat).

Pregătiri

După configurarea variabilelor globale – câteva din ele trebuind ajustate, vezi "Installation" – dosarele ţintă pentru fişierele de ieşire în output şi installset sunt create.

Pasul 1: Actualizarea bazei de date de temă (topic database)

Bazele de date de temă ASCII dependente de platformă aflate în {install}\input\{lang}\etc, ex. swriter_WIN.txt sau sbasic_UNIX.txt sunt citite şi toate titlurile conţinute sunt actualizate folosind titlurile citite din fişierele localizate din arborele {install}\input\{lang}\text. Fişierele actualizate sunt salvate ca de ex. swriter_new_win.txt.

Aceste fişiere proaspăt create sunt convertite în baze de date binare folosind programul txt2db.exe din dosarul {install}\program. Obţinând astfel baze de date ca swriter.db în dosarul {install}\output\{lang}. Acestea sunt necesare în pasul următor.

Pasul 2: Actualizarea fişierelor de vizualizare arborescentă

Fişierele *.tree existente din {install}\input\{lang}\etc sunt citite şi toate elementele
<topic id="some_id">Unlocalized string</topic> şi
<node id="some_id" title="Unlocalized string">
sunt actualizate folsind bazele de date ASCII actualizate în pasul 1 pentru a arăta noua tema (topic) sau titlul problemei (node title).

Notaţi că anumite părţe din aceste fişiere trebuie localizate manual (cf. Reguli pentru localizarea fişierelor pagina 9).

Fişierele *.tree procesate sunt plasate în dosarul {install}\output\{lang} , ex. {install}\output\{lang}\swriter.tree.

Pasul 3: Crearea arhivei şi bazei de date cu imagini

Imaginile conţinute în ramura de imagini de intrare, ex. {install}\input\icelandic\picture sunt comprimate într-un fişier arhivă şi baza de date de imagini picture.txt din dosarul {install}\input\{lang}\etc este convertită într-o formă binară folosind txt2db.exe.

Arhiva de imagini picture.jar şi baza de date de imagini picture.db sunt plasate în dosarul {install}\output\{lang}.

Pasul 4: Crearea indexilor

Fişierele index necesare pentru căutarea de text sunt create folosind programele şi bibleotecile java aflate în {install}\program şi {install}\program\classes ca şi fişierele de stiluri XSL aflate în {install}\stylesheets\indexing.

Pentru îndeplinirea cu succes al acestui pas, Java 1.3.1 trebuie să fie instalat corect. Acest pas durează cel mai mult timp, vă rog aveţi răbdare.

Fişierele index sunt plasate în subdosarele {application}.idx din dosarul {install}\output\{lang} , ex. {install}\output\icelandic\swriter.idx, şi conţin o grămadă de fişiere necesare motorului de cautare.

Pasul 5: Transformarea şi comprimarea fişierelor xml

Fişierele xml din ramura text a arborelui de intrare sunt transformate folosind programe şi bibleoteci java aflate în {install}\program şi {install}\program\classes ca şi fişierele de stiluri XSL aflate în {install}\stylesheets\pretransformation. Acest pas crează şi arhivele aplicaţiei pe care le plasează în {install}\output\{lang}\, e. g. {install}\output\icelandic\swriter.jar.

Pasul 6: Terminarea procesului

Toate fişierele suplimentare sunt adunate în {install}\output\{language}\, inclusiv fşierele de configurare *.cfg, care trebuie localizate manual, fişierul de stiluri (the stylesheet) pentru ajutor arată ca custom.css care s-ar putea să necesite ajustări în funcţie de cerinţele de limbă/corp de literă şi documentul de erori err.html care la fel trebuie localizat manual.

Fişierele necesare sunt compilate în arhive şi plasate în dosarul {install}\installset\{language}\ . De aici pot fi copiate în arborele sursă corespondent. Notaţi, indiferent ce limbă produceţi veţi obţine întodeauna fişiere *99.* în dosarul {install}\installset\{language}\ .

Ce obţineţi în final

Dupa ce script-ul a terminat cu succes veţi obţine un set de fişiere în dosarul {install}\installset\{language}\ gata să fie plasate în arborele sursă.

În acelaşi timp veţi avea un set de fişiere şi dosare în dosarul {install}\output\{language}\ care pot fi copiate în dosarul help\{language} al unei instalări de StarOffice pentru testări (nu uitaţi să faceţi o copie de siguranţă a conţinutului original al dosarului dacă faceţi testări!). Noul ajutor ar trebui să fie disponibil după repornirea StarOffice (nu uitaţi să închideţi şi quick starter-ul!).

Ce nu face script-ul?

Script-ul nu este în mod deosebit ferit de erori. Nu verifică existenţa şi instalarea corectă a Java sau alte lucruri necesare ca de exemplu dosare existente. Suprascrie orice fişier de ieşire deja prezent în {install}\output sau {install}\installset.

Daca nu reuşiţi din prima...

Nimic nu funcţionează aşa cum ar trebui

...verificaţi instalarea corectă a Java (Java 1.3.1), JRE ar trebui să fi suficient dar eu nu sunt un expert în Java şi eu lucrez cu JDK.

... verificaţi instalarea corectă a Perl (Perl 5.6.1). Pachetul benchmark ar trebui să fie instalat (implicit). Daca nu aveţi acces la pachetul benchmark sau nu doriţi această opţiune, pur şi simplu eliminaţi toate liniile care conţin şiruri ca "...new Benchmark", "...timediff", "use Benchmark".

...aţi ajustat căile de la începutul script-ului în mod corect?

...aţi ajustat calea către interpretorul perl din prima linie în mod corect (posibil să nu fie necesar întodeauna)?

Arhivarea eşuează

...Java 1.3.1 este instalat corect? Se pare că jar.exe din dosarul {install}\program necesită această versiune.

Indexarea sau paşi de transformare eşueaza

...aţi verificat toate fişierele ajutor xml pentru validitate cu DTD furnizat în {install}\etc?

Cum să creezi ajutorul

Condiţii

Localizarea datelor

Puteţi găsi detalii despre regulile de localizare a datelor în "Reguli pentru localizarea fişierelor" la pagina 9.

PASUL 1:	Furnizarea fişierelor de intrare

Creaţi un dosar {lang} pentru fişierele localizate ca subdosar al {install}\input. Numele dosarului nu este important dar vă sugerăm să folosiţi un nume descriptiv, ex. {install}\input\icelandic.

Creaţi un dosar etc ca subdosar la {lang}, ex. {install}\input\icelandic\etc.

Copiaţi toate fişierele suplimentare în acest subdosar etc. Aceasta include *.cfg, custom.css, err.html, *.tree, *.txt. Notaţi, nu toate aceste fişiere trebuiesc localizate manual (cf. mai sus)

Copiaţi conţinutul arborelui cu ajutorul localizat – începând cu subdosarul text – în acest subdosar, ex. {install}\input\icelandic\text.

Copiaţi arborele cu imaginile ajutor localizate – începând cu subdosarul picture – în acest subdosar, ex. {install}\input\icelandic\picture.

PASUL 2:	Rulaţi Script-ul

Porniţi script-ul Perl folosind următoarea sintaxă:

perl createhelp.pl [lang] [platform] [lang_iso] [country_iso] [v]

unde

lang:	subdosarul {lang} (copilul lui {install}\input) unde se găseşte arborele de intrare (începând cu dosarul text), ex. icelandic. Acesta poate să aibă orice nume. Se referă doar la dosarul unde se găsesc fişierele de intrare şi unde sunt salvate fişierele de ieşire temporare.

platform:	platforma ţintă pentru care trebuie creat ajutorul, alegeţi fie WIN sau UNIX. Folosiţi doar aceste două valori.

lang_iso:	codul limbi pentru ca limba să fie produsă conform ISO 639, ex. is pentru icelandic. Acest parametru este necesar pentru crearea indexului folosind limba corectă.

country_iso:	codul ţării pentru ţara care se produce pentru a fi conform cu ISO 3166, ex. IS pentru Iceland. Acest parametru este necesar pentru crearea indexului folosind limba corectă.

v:	(opţional) afişează ceva mai multe informaţii

Aşteptaţi ca script-ul să termine

În funcţie de viteza calculatorului poate dura până la o oră.

PASUL 3:	Furnizaţi fişierele pentru instalare

Ar trebui să obţineţi opt fişiere comprimate în dosarul {install}\installset\{lang} care pot fi transferate în dosarul corespunzător pentru StarOffice. Acestea sunt:

shared99.zip, sbasic99.zip, scalc99.zip, schart99.zip, sdraw99.zip, simpress99.zip, smath99.zip, swriter99.zip

Reguli pentru localizarea fişierelor

Următoarele fişiere trebuie localizate manual:

Fişierele de ajuror cu subiecte (help topic files) *.xml din {install}\input\{lang}\text trebuie localizate în întregime. Aceasta include şi titlu fişierului din tag-ul <dc:subject> al documentului, deoarece de aici obţine script-ul titlul subiectului (topic title) pentru baza de date. Vă rog nu folosiţi entităţihtml ca &apos; în acest tag, în schimb folosiţi caractere codate UTF-8. Deasemenea actualizaţi şi elementul de codare al limbii <dc:language>en-US</dc:language> pentru a se potrivi cu noua limbă.După procesul de localizare, validitatea fişierelor poate fi testată folosind DTD-ul {install}\etc\so-help.dtd.

Capturile de ecran din {install}\input\{lang}\pictures trebuie localizate, dacă este necesar. Fişierele localizate trebuie să aibă acelaşi nume, trebuie să fie plasate în acelaşi dosar şi trebuie să aibă aceaşi înălţime şi lăţime (numărul de octeţi nu contează). Dacă înălţimea şi lăţime diferă cel mai probabil imaginile vor fi afişate distorsionat, dacă dimensiunea nu este ajustată în fişierul de ajutor corespondent imaginii.

Următoarele parţi ale vizualizări arborescente a fişierelor {install}\input\{lang}\etc\*.tree trebuie ajustate manual:
Atributul title al tag-ului <help_section> .
Atributul title al orcărui tag <node> a cărui atribut de identificare începe cu "N" sau "C". ca <node id="C01" title="Unlocalized">

Fişierele de de configurare a aplicaţiei input\{lang}\etc\*.cfg. Trebuie să ajustaţi doar atributele title şi language.

Documentul de errori input\{lang}\etc\err.html.

Următoarele fişiere sunt localizate automat:

Bazele de date cu subiectele ajutor (help topic databases) {install}\input\{lang}\etc\*.txt sunt actualizate de script. Fişierele originale sunt lăsate neatinse, fişierele actualizate sunt denumite astfel swriter_new_win.txt. Dacă oricare din ultimele există la pornirea script-ului ele vor fi suprascrise.

Informaţile specifice subiectelor (topic specific information) ale fişierelor vizualizate arborescent {install}\input\{lang}\etc\*.tree sunt actualizate de script. Totuşi, unele părţi ale fişierelor trebuie localizate manual (cf. mai sus).

Următoarele fişiere pot necesita ajustări:

Paginile cu stiluri {install}\input\{lang}\etc\custom.css (stylesheet) pot necesita ajustări dacă limba de localizare necesită alte tipuri de corpuri de litere. Posibil să fie necesară ajustarea pentru a satisface particularităţi naţionale.

{install}\input\etc\STOPLIST conţine o listă de cuvinte de ignorat în crearea indexului pentru căutare de text. Din nefericire, fişierul nu are specific de limbă, în acest fişier trebuie să adăugaţi toate cuvintele de ignorat pentru toate limbile pentru care se produce. Iniţial, fişierul conţine cuvintele englezeşti cele mai comune care trebuie ignorate.

Următoarele fişiere nu necesită localizare sau ajustare:

Toate fişierele deasupra {install}\input\{lang} cu excepţia {install}\input\etc\STOPLIST pot fi lăsate neatinse.

Baza de date cu imagini {install}\input\{lang}\etc\picture.txt poate fi lăsată neatinsă.

9

OpenOffice.org 1.1 – Localizing the Help Files	9

Frank Peters

2002-02-18T12:54:34

Mihai Kovacs

Frank Peters