Jak přispívat do LibreOffice IV – Nápověda a návrh na její úpravu

LO.png Nový tematický blok seriálu pro začátečníky se zabývá dokumentací. Největší pozornost bude věnována vestavěné nápovědě a možnostem jejích úprav, zmíníme se ale i o její české lokalizaci a o dalších materiálech pro uživatele LibreOffice.  

Kancelářský balík je software se širokou uživatelskou základnou, existuje tudíž značná poptávka po radách a návodech, jak s jeho jednotlivými součástmi pracovat. Během vývoje LibreOffice, potažmo jeho předchůdce OpenOffice.org, proto byla vytvořena oficiální dokumentace.

Ta je aktualizována pro nové verze, byť poněkud nesystematicky, jak už to při tvorbě svobodného softwaru chodí. Na jedné straně jsou na velmi dobré úrovni udržovány obsáhlé příručky, na druhé je zanedbávána a pouze sporadicky aktualizována nápověda.

Vestavěná nápověda

Nejrozšířenější dokumentací LibreOffice je vestavěná nápověda, která by měla pokrývat všechny vlastnosti programu a kterou je možné nainstalovat v různých jazycích jako offline verzi spolu s programem. Síla nápovědy spočívá v její kompletnosti a provázanosti s uživatelským rozhraním programu a dají se v ní najít cenné poznatky.

Na druhou stranu nelze přehlížet nedostatky nápovědy. Zbytečně popisný styl typu „klepnutím na OK potvrdíte změny, klepnutím na Zavřít dialog zavřete“ a absence obrázků, natožpak videí, jsou na míle daleko od dnešního trendu, kdy infografiky závodí v tom, jak na co největším prostoru přinést co nejméně informací.

Nápovědu lze procházet pomocí obsahu, rejstříku či vyhledávání. Možná ještě užitečnější je přejít do aktuálního tématu po stisknutí tlačítka „Nápověda“, které je všudypřítomné v dialogových oknech. Volitelně se části nápovědy zobrazují při přejetí myší jako tipy. Není-li nápověda nainstalována, otevře se v prohlížeči online verze nacházející se na adrese help.libreoffice.org. Ačkoliv má podobu wiki stránek, nelze ji upravovat a je generována ze stejného zdroje jako offline verze.

Online verze nápovědy, úvodní stránka pro Writer Online verze nápovědy, úvodní stránka pro Writer

Nápověda v češtině

Na lokalizaci nápovědy jsme narazili ve druhém díle u přehledu projektů ve webové aplikaci Pootle. Překlad je organizován naprosto stejně jako pro uživatelské rozhraní, v Pootlu se nachází projekty „Help“ pro aktuálně podporované řady, konzistence překladů je udržována pomocí terminologie společné pro všechny projekty.

Opět je dobré zdůraznit, že z hlediska překladu tvoří nápověda s rozhraním jeden celek – při změnách termínů a úpravách rozhraní je třeba změny promítnout také do nápovědy. Sjednocování termínů probíhá napříč oběma projekty a jeho cílem je mimo jiné odstranit rozpory mezi překladem rozhraní a nápovědy.

Postupy při hlášení chybného či podivného překladu i postup při opravě byly popsány v druhémtřetím díle seriálu. Nesrovnalost můžeme nahlásit do zdejšího fóra (nejlépe do části pro hlášení chyb) nebo do české lokalizační konference na lokalizace@cz_libreoffice_org. Návrh na opravu překladu lze také přímo vložit do příslušného projektu v Pootlu.

Při překladu nápovědy se na rozdíl od uživatelského rozhraní setkáme navíc se značkami v textu, které jsou většinou párové. Celá nápověda je totiž napsána ve formátu XML, který obsahuje značky pro zvýraznění, obrázky, odkazy nebo varianty textu pro různé operační systémy – tyto značky musí být v překladu zachovány (přehled je uveden na wiki stránce). Speciální značku představuje bookmark, která udává položku v rejstříku; jejich počet nemusí odpovídat originálu, avšak každá položka musí být v rámci celého rejstříku jedinečná.

Při překladu aktualizované nápovědy můžeme v současnosti narazit na to, že se nový text až na drobnou změnu shoduje s původním. To může být důsledek drobné změny v originále nebo převodu dialogu na modernější formát, který jsme zmínili při popisu lokalizace rozhraní (i když většina takových řetězců je přebrána z předchozího překladu automaticky). V těchto případech by měly pomoci návrhy z překladové paměti zobrazované v Pootlu nebo stačí vyhledat překlad v původních souborech.

Chybějící nápověda aneb komentáře po pěti letech

Systém nápovědy i naprostá většina jejího obsahu byly vytvořeny v době, kdy se o vývoj OpenOffice.org starala firma Sun. V současnosti je nápověda plně v rukou dobrovolníků – občas do ní zodpovědný vývojář přidá popis novinky, kterou do LibreOffice přidal, občas ji doplní nespokojený uživatel, ale zpravidla se do ní nové funkce a změny nedostanou.

V místech, kde se program neměnil, tak zůstává zcela aktuální, na jiných místech se však objevují nesrovnalosti a některé části už zoufale zastaraly. A protože jsme v seriálu pro ty, kteří problémy aktivně řeší, ukážeme si, jak můžeme přispět k nápravě tohoto stavu.

Jako příklad funkce, která v nápovědě není dostatečně popsána, si vybereme export komentářů. Vydání LibreOffice 4.3 mohou slavit všichni, kteří dlouhá léta volali po tom, aby bylo možné komentáře ve Writeru tisknout vedle textu tak, jak se zobrazují na obrazovce; dosud byl k dispozici jen tisk na konci dokumentu a podobně nepraktické možnosti.

Po pěti letech od nahlášení do bugzilly byl požadavek vyslyšen, příslušná možnost se nachází v Nástroje → Možnosti → LibreOffice Writer → Tisk. Není však příliš zřejmé, že volba ovlivňuje i export do formátu PDF: je-li vybráno Na okrajích, komentáře budou exportovány v podobě, v jaké se zobrazují, při jakékoliv jiné volbě se neexportují.

V dialogovém okně pro export do PDF přitom nalezneme položku Exportovat komentáře. Nápověda nás poučí, že tím se z komentářů stanou v souboru PDF poznámky, zmínka o možnosti zobrazení na okrajích chybí.

Neúplný popis exportu komentářů v nápovědě Neúplný popis exportu komentářů v nápovědě

V tuhle chvíli bychom měli právo zamířit do bugzilly a nahlásit, že nápověda není kompletní, ale byla by to nejspíš zbytečná snaha. Ono se totiž ví, že popis nových vlastností chybí, ale neexistuje nikdo, kdo by ho na základě takového požadavku vymyslel a doplnil. Můžeme však šance na doplnění zmnohonásobit tím, že přidáme vlastní návrh požadované úpravy.

Příprava textu změny a nahlášení

Chceme tedy do nápovědy k exportu do PDF doplnit informaci o tom, že se dá zapnout exportování komentářů na okrajích textu. Po chvíli přemýšlení z nás může vypadnout třeba pár následujících vět. Nejsou sice žádným zázrakem, ale účel bezesporu splní, a navíc respektují stávající styl nápovědy:

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.

S tímto textem už můžeme směle požadavek nahlásit, ideálním místem pro to je bugzilla LibreOffice (v seriálu ji ještě podrobně probereme). Uvedeme stránku nápovědy, ke které text patří (k tomu dobře poslouží odkaz na online verzi), samotný text a k hlášení přiřadíme kategorii „Documentation“.

Dál nezbývá než čekat, zda se problému někdo chopí a nápovědu doplní. Nevládneme-li angličtinou, můžeme zkusit připravit a nahlásit českou verzi aktualizace nápovědy do sekce hlášení chyb zdejšího fóra či případně do české uživatelské mailové konference na adrese uzivatele@cz_libreoffice_org. Šance, že se návrhu někdo ujme, však bude řádově menší.

Nesmělý začátečník může nabýt dojmu, že se svojí znalostí angličtiny nemůže přispívat do nápovědy psané tímto jazykem. Pokud jeho věty nejsou nebezpečně blízko strojovému překladu, nejsou podobné obavy na místě. Při tvorbě nápovědy platí zásada, že nedokonalým jazykem popsaná vlastnost je lepší než chybějící popis. Navíc bude návrh před začleněním číst a mít možnost korigovat ještě někdo další.

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

I když jsme návrh na úpravu nahlásili, nemáme zaručeno, že ho někdo do nápovědy skutečně začlení. V dalším díle proto postoupíme o krok dál – ukážeme si, kde jsou zdrojové soubory nápovědy uloženy, jak se upravují a jak se do úpravy můžeme sami pustit.

(Jako ve škole) Průměr: 2,00 | Hodnotilo: 4
 

Komentáře

user avatar Tm16
Odpovědět
Článek
27. 07. 2014, 16:18:33
Dost nerozumím tomuto článku. To už není o čem psát ?
user avatar Petr Valach
Odpovědět
Re:Článek
27. 07. 2014, 16:22:02
Možná o tom nevíte, ale čtenáři mají dotazy ohledně hlášení chyb. Například. A dále, LibreOffice je komunitní projekt. Jsem rád, že se někdo chopil této oblasti.
user avatar Lukáš Jelínek
Odpovědět
Re:Re:Článek
27. 07. 2014, 17:11:41
Přesně tak. LibreOffice (a stejně tak OpenOffice a spousta dalšího svobodného softwaru) funguje tak, že sice značný podíl vývoje zajišťují a financují firmy (které pak vydělávají například na placené podpoře), velká část ale leží na komunitě.

Týká se to hlavně těch věcí "okolo", tedy například nápovědy a dokumentace, včetně věcí souvisejících (překladů apod.). Je dost lidí, kteří by s tím rádi pomohli - ale nevědí, jak začít, co příslušné procesy přesně obnáší a "co dělat, když...".

Proto si velmi vážíme práce lidí, jako je právě Stanislav Horáček, který je autorem tohoto článku. Zajišťují spojení mezi hlavními vývojáři a komunitou, jsou schopni a ochotni přenášet informace oběma směry. Umožňují tak, aby se zapojil každý, kdo má chuť v tom něco udělat.
user avatar Tm16
Odpovědět
Re:Článek
27. 07. 2014, 20:33:59
Určitě věci "okolo vývoje software" a na téma "jak nejlépe použít ten či onen nástroj" patří k těm nejzajímavějším a nejčtenějším, s tím naprosto souhlasím a i mě se líbí a hodnotím je velmi pozitivně.

Spíše mě u tohoto článku zaujalo, že článek opakuje, to co bylo napsáno již dříve a podrobně se věnuje nápovědě, kterou každý zkušený uživatel zná, čímž se liší od ostatních článků, které mají vynikající úroveň, a přišel mi nadbytečný.

Každopádně každý čtenář má jiný názor - co je pro někoho nezajímavé, je pro jiného vynikající, a určitě je hodně čtenářů, které mají opačný názor.

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.

 
EDU Trainings
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.

 
AIMTEC
 
 
woo jaw demo hz