Ako v rozšírení lokalizovať reťazce súboru help.html

Ak čítate tento tutoriál, ste vývojár zasluhujúci si uznanie, pretože vaše rozšírenie obsahuje dokumentáciu. Je to veľmi dobrý nápad, ak chcete svoje rozšírenie urobiť pre používateľov komfortnejšie.

Takže vo svojom rozšírení máte súbor help.html alebo howto.html. Predpokladajme, že sa tento súbor nachádza v priečinku locale, takže sa prekladatelia môžu pustiť do svojej práce a rozšíriť to do sveta.

Problém je, že:

Súbor help.html umiestnený do každého jazykového podpriečinka rozšírenie zväčšuje (zoberte do úvahy, že na BabelZille máme niekoľko rozšírení až s 25 jazykmi).
Prekladatelia nie sú vývojári, takže prechádzanie kódom HTML pre nich nie je nič príjemné. Kľučkujú medzi tagmi a atribútmi a hľadajú reťazce na preklad. Pri úprave dokumentu vo formáte HTML môže navyše dôjsť k chybám v kódovaní.

Riešením môže byť:

Preveďte svoje súbory HTML na jeden súbor help.xhtml a presuňte ho do priečinka content.
Vytvorte entity pre všetky reťazce súboru XHTML a umiestnite ich do súboru locale/help.dtd.

Teraz sa pozrieme, ako to urobiť.

Ako testovací prípad sme si zobrali návrh rozšírenia, ktoré vytvoril Roman Mashirov.
Najprv vytvorte súbor help.dtd alebo použite v priečinku locale už existujúci súbor DTD a presuňte súbor HTML do priečinka content. Potom postupujte podľa týchto jednoduchých krokov:

Vytvorte zo súboru HTML súbor XHTML.

Odstráňte všetko pred tagom <head> a prilepte namiesto toho tento kód:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"

  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" [

<!ENTITY % helpDTD SYSTEM "chrome://outliner/locale/help.dtd" >

%helpDTD;

]>

<html xmlns="http://www.w3.org/1999/xhtml">

Mimochodom, môžete vložiť názov svojho rozšírenia a názov súboru DTD.

Časť ENTITY je dôležitá, pretože ukazuje rozšíreniu, kde má hľadať reťazce.

Pretvorte reťazce do lokalizovateľných entít.

Je to rovnaký proces, ako pri presúvaní reťazcov zo súboru content/*.xul do priečinka locale/*.dtd. Vždy, keď ide o hlásenie z používateľského prostredia:

1. Použite namiesto toho entitu.

Ak máte napríklad toto:

Napíšte jednoducho toto:

<h1>Outliner Help</h1>
<p>This is Outliner extension for Mozilla, or at least some day it will be.
For now this is just notekeeper with notes arranged in tree.</p>

<h1>&page.title;</h1>
<p>&this.is.outliner;</p>

2. Umiestnite entitu a hlásenie do súboru DTD.

<!ENTITY page.title "Outliner Help">
<!ENTITY this.is.outliner "This is Outliner extension for Mozilla, or at least some day it will be. 
For now this is just notekeeper with notes arranged in tree.">

Urobte určité úpravy:

Nezabudnite upraviť cestu k súboru Pomocníka všade, kde sa na neho odkazuje (zvyčajne v súbore .JS).

chrome://outliner/locale/help.html  --->  chrome://outliner/content/help.xhtml

Ak odkazujete vo svojom dokumente na obrázky, JavaScript alebo CSS, tiež skontrolujte novú cestu.
Syntax XHTML je náročnejšia na tagy. Skontrolujte každý uzatvorený tag, najmä ak sa vyskytne chyba analýzy.
Môžete pridať nejaké tvrdé medzery a dosiahnuť tak lepšie rozloženie.
Ak potrebujete ďalšiu pomoc, pozrite pôvodný návrh rozšírenia a upravené rozšírenie.

...A je to hotové. Blahoželáme!

Tutoriál napísal Goofy

Last Updated ( Tuesday, 03 July 2007 )

[ Back ]