Vytváření helpu - Builder.cz - Informacni server o programovani

help

help

3. dubna 2002, 00.00 | Dnešní článek bych rád věnovat tématu vytvoření helpu pro vaše aplikace. Mluvím-li o helpu mám na mysli HLP soubory — help, který se poprvé objevil ve Microsoft® Windows® 95.

Dnešní článek bych rád věnovat tématu vytvoření helpu pro vaše aplikace. Mluvím-li o helpu mám na mysli HLP soubory — help, který se poprvé objevil ve Microsoft® Windows® 95.

Rád bych upozornil céčkaře, abych tento článek neskrečovali jakmile narazí na slovo Delphi. To že se zde budu zmiňovat o Delphi, berte jen jako ukázku použití, které se v céčku zase tolik neliší. A hlavně způsob vytváření HLP souborů je absolutně nezávislí na tom v jakém jazyce programujete!

Nevím zda víte, že s vyšší verzí Delphi než je Personal či Enterprise je standardně dodáván prostředek pro tvorbu helpu — Microsoft® Help Workshop. Naneštěstí se při instalaci nevytvoří žádný link, který by o tom svědčil. Rovněž tak v nápovědě samotného produktu o to není mnoho zmínek, zda-li vůbec nějaká je.

Tento softwarový prostředek, Microsoft® Help Workshop 4.00.0950, dokáže vytvářet standardní hlp a cnt soubory pro Win32. Slovem standardní myslím, to že vytvořený soubor vypadá stejně jako nápověda k samotnému systému, což se o některých výstupech jiných programů pro tvorbu helpu říci nedá. Tato verze programu má malinkatý nedostatek, a to rok vypuštění 1995. Což má za následek to, že vstupní RTF soubory musí být napsány nejvýše ve Wordu 6.0. Vyšší verze již nemají kompatibilní formát RTF.

Díky tomuto nedostatku je tato verze téměř nepoužitelná. Ale nenechme se odradit! Když pořádně zahrabeme na Internetu, pak najdeme novější verzi, 4.03, např. na http://www.helpmaster.com/hlp-developmentaids-hcw403.htm. A co víc tento nástroj je zdarma a podporuje RTF novějších verzí Wordu. A to nejlepší je od Microsoftu, což by mělo zaručovat 100% kompatibilitu.

Pozn.: dané RTF soubory samozřejmě můžete psát v čemkoliv co umí poznámky pod čarou s vlastními značkami, hypertextovými odkazy aj. + je kompatibilní s RTF formátem.

Tvorba dokumentů v RTF formátu bude většině zabírat největší množství času, což ovšem není způsobeno náročností zápisu potřebných značek, ale spíše tím co tam napíšete. Budete potřebovat editor, který dokáže:

MS Word je pro tento účel jako stvořený. Vyzkoušel jsem je od verze 6.0 až do XP a vše bez problémů.

Každá zobrazená karta musí mít definovány jednu resp. tři poznámky pod čarou

Za těmito poznámkami pod čarou obvykle následuje vlastní text karty tj. nadpis a text. V průběhu textu můžete narazit na potřebu vytvořit odkaz na jinou kartu. Takovýto odkaz se provádí následně:

Text, který má tvořit odkaz musí mít dvojité podtržení viz. obrázek.

Dále za takto označeným textem se musí nacházet název karty (viz. poznámka pod čarou #). Tento text však musí mít jen formátování jako skrytý (viz. předchozí obrázek). Celý text vypadá takto¹:

Po vytvoření HLP souboru vše bude vypadat takto:

Spusťte si Microsoft® Help Workshop, vyberte File | New a zvolte Help Project a vyberte si soubor. V Options by bylo dobré nastavit pár věcí.

V General zadat text do Default topic tj. některý textů v Map. Compression ve finální verzi na maximum. Sorting podle vámi preferovaného jazyka. Files zde vybrat, kam se bude ukládat výsledný HLP soubor a přidat všechny RTF soubory, které mají být v helpu, přes tlačítko Change. Případně vybrat CNT soubor, máte-li ho. Ještě by mělo být nutné opravit Fonts pro správnou češtinu.

V Map zadáváte jednotlivé názvy, které jste dali do RTF souborů v poznámce #. Ke každé položce je nutno přidat unikátní číslo, které se vývoji aplikace dosazuje do helpContext.

Teď již nezbývá nic jiného než zkompilovat projekt a otevřít si vytvoření HLP soubor. Případně opravit nalezené chyby či varování.

Konec dnešního dílu. Příště si ukážeme tvorbu CNT souborů a podíváme na to, jak zařadit vytvořené HLP resp. CNT soubory do projektu ať již Delphi, C++ či Visual Basicu.

1. – Pro zobrazení skrytého textu musíte mít zapnutý přepínač zobrazení skrytého textu tj. ¶