Jak přispívat do LibreOffice V – přímá úprava nápovědy, část první

LO.png Minule jsme se v tomto seriálu zabývali ukázkou chybějící části vestavěné nápovědy, připravili jsme její doplnění a řekli si, kam problém nahlásit. V dnešním pokračování se nespokojíme s nahlášením, ale sami se pokusíme nápovědu změnit.  

Před tím, než se do úpravy pustíme, je nutné zaběhnout do toho, jak se nápověda připravuje po technické stránce. Jejím základem jsou soubory, které – jak jsme viděli při překládání nápovědy ve webové aplikaci Pootle – jsou formátu XML: běžný text je uzavřen do párových značek, které uvádějí jeho význam. Mohou tak například určovat, zda se jedná o odstavec, nadpis, zvýrazněný text, položku rejstříku, odkaz na jinou stránku nápovědy a podobně. Jeden soubor zpravidla odpovídá jedné stránce nápovědy.

Během procesu, který se označuje jako překlad (nemá nic společného s překladem do cizích jazyků), se spustí určitý program, který podle stanovených pravidel soubory nápovědy zpracuje a vytvoří z nich soubory binární, se kterými si poradí počítač, ale neobsahují text čitelný pro člověka. Zabalená sada těchto souborů už tvoří balík nápovědy, který známe ze stránek pro stažení.

V zásadě stejně se připravují ze zdrojových souborů s kódem v programovacích jazycích instalační soubory celého programu LibreOffice. Oficiální instalační soubory (jak programu, tak nápovědy) vytváří organizace The Document Foundation (o její roli bude řeč v závěru seriálu), jelikož je ale LibreOffice svobodný software, může jeho zdrojové soubory kdokoliv stáhnout a vytvořit si instalaci vlastní.

Verzování softwaru

Abychom mohli se zdrojovými soubory pracovat, nestačí je jednoduše stáhnout z hlubin internetu. Každý vážně i méně vážněji míněný software je totiž vyvíjen pomocí systému pro správu verzí.

Systém pro správu verzí je nástroj, jenž umožňuje u daných souborů zaznamenávat veškeré změny tak, jak byly postupem času prováděny. To je při vývoji softwaru neocenitelné, díky tomu se můžeme například vrátit k verzi, která ještě fungovala (než jsme ji další změnou rozbili), zjistit, kdo je odpovědný za určité řádky v souboru, nebo vyvíjet více různých funkcí nezávisle na sobě a změny pro ně pak sloučit opět do jednoho souboru.

Množina všech sledovaných souborů se označuje jako repozitář nebo úložiště (repository). Změny jsou zaznamenávány v tzv. commitech – ty obsahují výpis změn u všech dotyčných souborů repozitáře spolu s metadaty (jedinečný identifikátor commitu, popis, autor, čas). V rámci repozitáře může existovat více větví (branches), variant téhož repozitáře lišících se historií změn, mezi nimiž se dají změny určitým způsobem přebírat.

Projekt LibreOffice používá systém pro správu verzí nazvaný Git, který byl původně vytvořen pro verzování linuxového jádra a který se časem stal jedním z nejpoužívanějších. K jeho popularitě přispívají webové služby typu Github, jež vývoji softwaru přidávají rozměr známý ze sociálních sítí.

Repozitář LibreOffice a jeho větve

Repozitář, ze kterého jsou připravována oficiální vydání LibreOffice, si můžeme prohlédnout ve webovém rozhraní na cgit.freedesktop.org/libreoffice/ (projekt LO využívá infrastrukturu freedesktop.org). Na této adrese je vypsán seznam dílčích repozitářů, z nichž nás tentokrát zajímá nápověda – libreoffice/help. V horní části stránky pro nápovědu se zobrazuje přehled větví, v dolní části jsou vypsány nejnovější commity.

Větve slouží mimo jiné k oddělení vývoje různých verzí LibreOffice: hlavní větev, ve které se přidávají nové funkce, se nazývá master. Z ní jsou podle předem stanoveného časového plánu oddělovány větve, ve kterých se provádí už jen menší změny a opravy chyb, například aktuální větev libreoffice-4-3 (obdobně existují větve pro jednotlivá vydání, například libreoffice-4-3-0). Texty nápovědy se v jiné větvi než master prakticky nemění – je totiž žádoucí, aby překladatelé aktualizovali překlady jednou za půl roku (tj. jednou v rámci řady LO, například 4.3), a nemuseli tak činit každou chvíli při změně řetězců.

V historii commitů nápovědy najdeme za poslední měsíce poměrně časté záznamy, což však není v rozporu s tvrzením, že se nápověda téměř neaktualizuje. Většina se týká technických změn, které jsou součástí dlouhodobějšího přepracovávání dialogových oken LibreOffice na moderní formát (zmíněno bylo ve třetím díle seriálu).

Upravujeme nápovědu

Lokální repozitář

Jak jsme si vysvětlili, nestačí pouze stáhnout soubory, je potřeba stáhnout celý repozitář. Máme-li nainstalován Git, přejdeme do adresáře, kam chceme soubory repozitáře uložit, a zadáme příkaz (místo příkazového řádku můžeme také využít některé z grafických uživatelských rozhraní pro Git):

git clone git://anongit.freedesktop.org/libreoffice/help help

V adresáři help se vytvoří lokální kopie oficiálního repozitáře s nápovědou, která je se vzdáleným originálem rovnocenná; z originálu se „pouze“ vytváří oficiální vydání LibreOffice. Všechny verzované změny jsou uloženy ve skrytém podadresáři .git.

Na seznam posledních commitů v lokálním repozitáři se můžeme podívat, když přejdeme do příslušného adresáře a zadáme příkaz git log:

cd help
git log

Pro každý commit se zobrazí identifikátor a další metadata; nejnovější commit bude první v pořadí. Po něm (resp. ve výpisu před ním) by už měla následovat naše úprava nápovědy.

Výpis posledních commitů repozitáře help v rozhraní Git Výpis posledních commitů repozitáře help v rozhraní Git

Změna souborů

Repozitář máme pod dohledem Gitu, a můžeme tedy směle měnit soubory. V minulém díle jsme si nachystali text, který chceme doplnit k popisu exportu komentářů při vytváření souborů PDF:

To export comments of Writer documents as they are shown in LibreOffice, choose Tools - Options - LibreOffice Writer - Print and select the In margins option in the Comments area. The exported pages will be scaled down and the comments will be placed into their margins.

Napřed zjistíme, do kterého souboru z repozitáře text patří. Nadpis popisované volby je v originále „Export comments“, který po prohledání repozitáře objevíme v souboru s názvem ref_pdf_export.xhp.

Zdrojový kód LibreOffice lze rychle prohledávat online službou OpenGrok na stránce opengrok.libreoffice.org. Zvolíme dílčí repozitář (core je hlavní zdrojový kód, help nápověda, translations překlady z Pootlu) a jako výsledek se vypíše seznam s odkazy na zdrojový kód souborů, ve kterých se hledaný řetězec nachází.

Po nahlédnutí do nalezeného souboru je nasnadě, že našemu připravenému textu chybí XML značky. Provedeme proto ještě následující úpravy:

  • protože doplňovaný text tvoří samostatný odstavec, uzavřeme jej do značky <paragraph>, jejím atributem je identifikátor id, který musí být jedinečný v rámci souboru,
  • místo textu „LibreOffice“ se používá proměnná %PRODUCTNAME, aby byla nápověda univerzální i pro jinak pojmenované produkty založené na LibreOffice nebo pro vývojové verze (ty jsou pojmenovány jako „LibreOfficeDev“, aby je bylo možné mít nainstalované zároveň se stabilní verzí),
  • příkazy a názvy možností zvýrazníme značkou <emph>,
  • v systému Mac OS X se k nastavení přistupuje pomocí LibreOffice › Předvolby, zatímco v ostatních systémech pomocí Nástroje › Možnosti; toho, aby se v každém systému zobrazoval jiný text, docílíme pomocí <switchinline> a souvisejících značek.

Přidávaný řádek se tak znepřehlední do této podoby:

<paragraph xml-lang="en-US" id="par_idN207C2" role="paragraph" l10n="NEW">To export comments of Writer documents as they are shown in %PRODUCTNAME, choose <emph><switchinline select="sys"><caseinline select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools - Options</defaultinline></switchinline> - %PRODUCTNAME Writer - Print</emph> and select the <emph>In margins</emph> option in the <emph>Comments</emph> area. The exported pages will be scaled down and the comments will be placed into their margins.</paragraph>

Upravený soubor nápovědy v editoru Geany Upravený soubor nápovědy v editoru Geany

Význam značek je pro překladatele, tj. z hlediska čtenáře, vysvětlen na již zmíněné wiki stránce. Celý systém nápovědy je značně komplexní a k jeho používání byla za časů OpenOffice.org sepsána objemná příručka. Pro namátkové drobné úpravy si však vystačíme s pouhými několika značkami a zásadami.

Pokračování příště

Soubor jsme změnili podle svých představ a další, bezprostředně navazující díl, bude věnován tomu, jak změnu poslat zpátky, aby se objevila ve vzdáleném originálním repozitáři.

(Jako ve škole) Průměr: 1.00 | Hodnotilo: 2
 

Komentáře

user avatar Tomáš Matýs
Odpovědět
Jak přispívat do LibreOffice V – přímá úprava nápovědy, část první
8. 08. 2014, 14:15:58
Pro redakci Lown 3 je vydáno https://wiki.documentfoundation.org/LOWN/3 .
user avatar Lukáš Jelínek
Odpovědět
Re:Jak přispívat do LibreOffice V – přímá úprava nápovědy, část první
8. 08. 2014, 18:09:08
Děkujeme, ale ono už je vydáno více než dva týdny ;-) S aktuální podobou LOWN je trochu problém, je to psáno dost nestravitelně. Takže i když jsem původně uvažoval na další vydání (po 1 a 2) upozorňovat, nakonec jsem tak v tomto případě neučinil a raději v novinkách upozorňuji na konkrétní jednotlivé věci (některé se samozřejmě v LOWN také objevují). Obecně v poslední době vydáváme na OO.cz méně novinek, ubyly takové ty "hardcorové", protože jejich cílová skupina je velmi úzká a stejně je sleduje přímo u původních zdrojů. Novinky jsou tedy teď orientovány více uživatelsky než dříve.
user avatar Tomáš Matýs
Odpovědět
Jak přispívat do LibreOffice V – přímá úprava nápovědy, část první
9. 08. 2014, 09:25:14
Když je to tedy uživatelsky zaměřené tak co třeba tohle https://plus.google.com/u/0/+NumixprojectOrg/posts/A2EoRvj9kVV a potom se může jít na 5 minut zahlasovat pro http://user-prompt.com/understanding-icons-participate-in-survey-aka-the-rising/ no a samozřejmě že jeden ze státečků Indie přešel na Libreoffice http://smc.org.in/ . Všechny tyhle věci jsou o libreoffice.
user avatar Tomáš Matýs
Odpovědět
Jak přispívat do LibreOffice V – přímá úprava nápovědy, část první
9. 08. 2014, 09:27:28
Jo a ještě o Libreoffice Draw novinka z GSOC 2014 https://matteocam.github.io/output/category/gsoc-draw-text-background-color.html
user avatar Lukáš Jelínek
Odpovědět
Re:Jak přispívat do LibreOffice V – přímá úprava nápovědy, část první
9. 08. 2014, 13:57:34
Děkuji za odkazy, podívám se na to.

Přidat názor

 

Nejsou podporovány žádné značky, komentáře jsou jen čistě textové. Více o diskuzích najdete v nápovědě. Diskuzi můžete sledovat pomocí RSS kanálu.

 
Dell - Precision
Stanislav Horáček

Stanislav Horáček

OpenOffice.org jsem objevil ve verzi 1.1, posléze jsem přešel na LibreOffice. Nejvíc používám Writer, ostatní součásti spíš doplňkově. Přispívám ke tvorbě LibreOffice (česká lokalizace, drobné úpravy nápovědy), vytvářím rozšíření „České CC0 slovníky“ a jeho stránku ceskeslovniky.cz. Od roku 2014 jsem členem The Document Foundation.

 

Public Relations

Jak uvést elektronický podpis do života

podpisÚplně správně bychom měli mluvit o biometrickém elektronickém podpisu. Biometrická data jsou totiž důležitým předpokladem pro případné ověření podpisu v případě, že to bude nutné.

Pokračování ...


 
 
woo jaw demo hz