Copyright: Průvodce tvorbou nápovědy, Ján Hanák, 2001


Úvodní obrazovka
Průvodce tvorbou nápovědy

Vítám všechny příznivce programování ve Visual Basicu, no nejenom je! Určite budete se mnou souhlasit, když prohlásím, že dnes již každá seriózní aplikace obsahuje i kvalitně navženou a líbivě vypadající nápovědu. Už pravděpodobně víte, kam směruji. Ano, vítám Vás u seriálu, který Vás naučí jak si takovou nápovědu vytvořit, zkompilovat a následně ji použít ve Visual Basicu. Pokud však nejste vývojáři právě ve Visual Basicu, nevěšte hlavu. Pomocí tohoto seriálu si může vytvořit vlastní nápovědu opravdu kdokoli, teda i naprostý laik v oblasti programování. Více se dozvíte v následujících tématech.

Požadavky na software

Co je soubor nápovědy a jak je možné ho vytvořit

Tvorba zformátovaného souboru RTF

Základní formátovací techniky

Program HCW a kompilace souboru nápovědy

Další formátování souboru RTF

Zdokonalení nápovědy pomocí HCW

Použití programu Hotspot Editor

Nápověda a Visual Basic


Požadavky na software

Při své práci budete potřebovat především textový editor schopný pracovat s dokumenty RTF (Rich Text Format), například Word 97, dále pak program pro kompilaci souborů nápovědy s názvem Help Workshop (verze 4.03) a jestli chcete nápovědu využít i ve vlastním programu, tak samozřejmě taky Visual Basic. Implicitně pak předpokládáme, že máte na svém počítači nainstalován systém Windows 98.

Tento nápovědný soubor je optimalizován pro rozlišení 800x600 obrazových bodů a 16bitovou barevnou hloubku. Můžete sice použít i jiné rozlišení, no na některých počítačích se mohou při zobrazování jednotlivých témat nápovědy objevit chyby.


Co je soubor nápovědy a jak je možné ho vytvořit

Jednoduše řečeno, soubor nápovědy je důležitým prvkem každé moderní aplikace. Obvykle poskytuje podrobné informace o počítačovém programu se kterým je dodáván, napomáhá uživateli při seznamování se s programem a je tedy jakýmsi virtuálním manuálem. Důležitost nápovědy potvrzuje i fakt, že mnozí uživatelé posuzují program právě prostřednictvím nápovědy a její kvality.

Strukturu nápovědy tvoří množství témat, které jsou na sebe navázaná a tudýž jsou na sobě závislá. Soubor nápovědy vzniká jako zformátovaný soubor RTF, který obsahuje množství témat, oddělených zalomením stránky. Každé téma je formátováno speciálními znaky, které později rozezná kompilátor nápovědy při generování platného souboru nápovědy. Tyto znaky je potřebné vložit před název tématu ve formě poznámek pod čarou.


Soubor RTF

Nejdříve je potřebné vytvořit soubor RTF, který je formátován podle určitých pravidel. Pro více informací si přečtěte část Tvorba zformátovaného souboru RTF.


Kompilátor nápovědného souboru

Kompilátor je program, který z předem připraveného souboru RTF vytvoří platný soubor nápovědy. Pro více informací nalistujte sekci Program HCW a kompilace souboru nápovědy.


Nápovědný soubor

Samostatný soubor s koncovkou HLP, který můžete spustit z prostředí operačního systému Windows pouhým dvojitým kliknutím.


Tvorba zformátovaného souboru RTF

Soubor nápovědy se tvoří ze zformátovaného souboru RTF. Následující postup Vám ukáže, jak vytvořit jednoduchý soubor RTF. Postupujte tedy dle jednotlivých instrukcí.

 Spusťte program Word 97. Ješte před začetím práce zvolte z menu Nástroje příkaz Možnosti a na kartě Zobrazení zaškrtněte políčka Konce odstavců a Skrytý text. Změny, které jste právě provedli vám poslouží k lehčí a přehlednejší práci se souborem.

 Na první řádek napište text “Nápověda” a stiskněte klávesu ENTER.

 Na druhý řádek pak napište “Témata nápovědy”.

 Umístěte kurzor před první slovo prvního řádku (tedy před “Nápověda”) a z menu Vložit zvolte příkaz Poznámka pod čarou… Objeví se dialogové okno s vícerými možnostmi. V textovém políčku pro vlastní značku zadejte symbol “#” (dosáhnete toho jednoduše stisknutím klávesy ALT a za jejího současného držení vyťukáním čísla 35 na numerické klávesnici) a aktivujte tlačítko OK.

 Všimněte jsi, že Vás Word automaticky přemístil do oblasti poznámky pod čarou. Nyní zadejte název, který představuje jedinečnou identifikaci tohoto tématu nápovědy.

Napište tedy “Napoveda" (bez uvozovek).

 Umístěte kurzor za poslední slovo druhého řádku.

 Z menu Vložit vyberte příkaz Konec… a pak Konec stránky.

 Na první řádek druhé stránky napište “Témata nápovědy jsou odstavce formátovány speciálními znaky” (samozřejmě sem můžete napsat libovolný text).

 Opět umístěte kurzor před první slovo tohoto textu a vložte poznámku pod čarou, ve které opět jednoznačně pojmenujete toto téma, např. jako “Temata”.

 Nyní se vraťte na první stránku a výraz ve druhém řádku vyberte do bloku. Pak z menu Formát vyberte Písmo, vyberte dvojité podtržení a stiskněte OK.

 Umístěte kurzor ihned za text s dvojitým podtržením a napište “Temata” (bez uvozovek).

 Vyberte do bloku právě napsaný text “Temata”, zvolte menu Formát, položku Písmo a zaškrtněte políčko Skryté. Výsledek pak vidíte na obrázku.

 Z menu Soubor zvolte Uložit jako, jako název zadejte “Nápověda” a jako typ souboru vyberte formát RTF.


Základní formátovací techniky

Při formátování jednotlivých témat souboru RTF jsme doposud využili jen znak “#”, za kterým následoval textový řetězec, jednoznačně definující název příslušného tématu nápovědy. Podobných symbolů však existuje více a bude dobré, když se s nimi obeznámíte a začněte je používat při tvorbě svých vlastních nápovědných souborech. Jejich použití je stejné, do dokumentu se vkládají jako poznámky pod čarou.

#	Kontextový řetězec - je jedinečné pojmenování tématu nápovědy. Tento symbol je povinný.

$	Název tématu - představuje výraz, který se objevuje ve vyhledávacím okně nápovědy. Tento symbol napíšete, když stiskněte klávesu ALT a za jejího držení vyťukáte na numerické klávesnici číslo 36.

K	Klíčové slovo nebo slova - používají se ve vyhledávacím okně, když se chceme odkázat na určité téma (pokud je jich víc, jsou oddělené znakem “;”).

+ 	Prohledávací sekvence - souvisí se sekvenčním pohybem po tématech nápovědy. Za symbolem následuje název, dvojtečka a číslo daného tématu nápovědy (tedy např. Napoveda:001 pro první téma, Napoveda:002 pro druhé téma atd.).


Sekvenční pohyb

Jde o pohyb po jednotlivých tématech nápovědy pomocí tlačítek se šipkami. Pokud chcete tyto tlačítka umístit do hlavního panelu nápovědy, udělejte následovní:

 Spusťte Help Workshop a otevřete Váš projekt nápovědy.

 Klepněte na tlačítko Windows.

 Pokud ješte není vytvořeno okno typu “main”, tak jej vytvořte.

 Na kartě Buttons okna Window Properties zaškrtněte políčko Browse.


Okno Main

 Jakmile Vás HCW vyzve k vytvoření nového primárního okna, jako jeho název zapište slovo “main” a klikněte na tlačítko OK, čímž bude nové okno vytvořeno.


Program HCW a kompilace souboru nápovědy

HCW nebo-li Help Workshop je samotný kompilátor nápovědy, tedy program, který ze souboru RTF vygeneruje platný soubor nápovědy s koncovkou HLP. HCW je velmi výkonný nástroj pro tvorbu nápovědy, s pomocí kterého můžete zkonstruovat opravdu obsáhlé a profesionálně vypadající soubory nápovědy.

Po spuštění programu vyberte z menu File příkaz New… a když se objeví dialogové okno, označte položku Help Project a výběr potvrďte tlačítkem OK.

Následně Vás HCW vyzve k zadaní jména pro právě vytvořený projekt. Napište tedy libovolné jméno a klikněte na tlačítko OK. Dále aktivujte tlačítko [image], pak tlačítko [image] a vyhledejte soubor RTF, který jste vytvořili dříve. Nakonec aktivujte tlačítko [image], na což program vygeneruje platný soubor nápovědy.

A to je vše! Prostě takhle jednoduše můžete vytvořit soubor nápovědy.


Další formátování souboru RTF

Při úpravě souboru RTF máte poměrně široké možnosti, které Vám poskytuje již samotný Word 97. Můžete využívat mnoho stylu písem, měnit jejich barvu, velikost a mnohé další atributy. Experimenty s textem jsou určitě užitečné, no když chcete mít opravdu atraktivní nápovědu, sáhněte nejspíš po obrázcích. Samozřejmě, že obrázky do nápovědy vkládat můžete. K dispozici jsou Vám dva způsoby a je jen na Vás, pro který z nich se rozhodnete.

Prvním způsobem je vložení požadovaného obrázku prostřednictvím schránky na příslušné místo. Hoci jde o nejjednodušší možnost, ne vždy se oplatí ji použít (zvláště tehdy, když potřebujete použít stejný obrázek na několika místech dokumentu, je vhodnější zvolit následující možnost).

Druhou variantou je využití odkazu na externí soubor s obrázkem podle syntaxe: {bmx jméno_souboru.bmp}, kde x může nabývat tyto hodnoty:

c – zarovná obrázek v jedné rovině s textem

l – zarovná obrázek na levou stranu

r – zarovná obrázek na pravou stranu

Dodatečná je hodnota t, která se používá jenom při práci se 16-barevnými obrázky a dovoluje nahradit bílou barvu pozadí obrázku barvou pozadí okna nápovědy (potom tedy syntaxe vypadá takhle {bmxt jméno_souboru.bmp}.

Dalším prvkem, který přispívá k zlepšení vzhledu nápovědy je definice statické oblasti. Pod tímto pojmem rozumíme text informačního charakteru, který se nachází vždy na vrchu tématu nápovědy a je od zbytku textu oddělen horizontální čarou. Takouto statickou oblastí je např. i text ”Další formátování souboru RTF” na vrchu tohoto tématu. Statické oblasti se používají obvykle tehdy, když samotné téma nápovědy je poměrně dlouhé a uživatel by mohl lehce ztratit orientaci při čtení nápovědného textu. To se však nestane, když na vrchu tématu bude vždy jeho stručný název. Tolik tedy k pojmu statická oblast a nyní si ukážeme jak ji můžeme nadefinovat.

Text statické oblasti formátujeme následujícím způsobem: zvolíme menu Formát, dále Odstavec a na kartě Tok textu zaškrtněme políčko Svázat s následujícím. Po uložení dokumentu a jeho rekompilaci se bude v tématu nápovědy nacházet i statická oblast.

Oblíbeným nástrojem tvůrců nápověd je definice termínu. Takouto definici získáte, když klepněte na slovní spojení “definice termínu” v předcházející větě. Postup při tvorbě definice je velice podobný vytvoření vazby (nebo-li odskoku) na jiné téma nápovědy. Nuže:

 Vytvořte téma, které bude obsahovat text samotné definice a jedinečně toto téma pojmenujte (pomocí vložení poznámky pod čarou se symbolem “#” a názvem tématu).

 Přejděte do toho tématu nápovědy, které obsahuje termín, který chcete navázat na definici.

 Vyberte tento termín do bloku a z menu Formát, zvolte Písmo a jednoduché podtržení.

 Ihned za podtržený text napište jedineční název tématu, které obsahuje text definice.

 Právě napsané jméno tématu vyberte do bloku, z menu Formát zvolte Písmo a zaškrtněte políčko Skryté.

Další, no již poněkud méně známou, je možnost umístit tlačítko kdekoli do obsahové oblasti nápovědy. Dosáhnete toho použitím zápisu [image], kde text je libovolný text, který se zobrazí na tlačítku a argument představuje libovolné makro podporované systémem WinHelp. Tak třeba, když jako text napíšete O nápovědě a jako makro zadáte About(), po stisknutí tlačítka se zobrazí informační okno o právě otevřeném nápovědním souboru. Rozměry tlačítka jsou automaticky upraveny podle textu, který se má na příslušném tlačítku zobrazit. Jestliže nezadáte žádný text, bude vytvořeno tlačítko o rozměrech 12x12 pixelů. Příklad tlačítka:

Na závěr této sekce ještě malý trik: Určite jste postřehli, že text, který představuje vazbu (odskok) na jiné téma je standardně formátován podtrženým písmem zelené barvy. Můžete sice změnit barvu tohoto textu například na modrou, no ve výsledném nápovědném souboru se tato změna nijak neprojeví. Mohlo by se zdát, že se jedná o složitý problém. Není to však úplně tak. Pomocí jednoduchého triku můžete nastavit libovolnou barvu textu, dokonce můžete odstranit i jednoduché podtržení.

Postupujte takto:

 Mezi text a název tématu vložte znak hvězdičky (*). Např.  .  Dávejte však pozor na to, aby samotný znak hvězdičky byl formátován jako skrytý.

 Vyberte text do bloku a aplikujte jinou barvu písma.

 Uložte soubor RTF a rekompilujte soubor nápovědy.

Pokud chcete odstranit i podtržení písma, postupujte přesne jako v předcházejícím příklade, jen medzi text a název tématu vložte namísto hvězdičky znak procent (%).


Definice termínu

Představuje stručnou charakteristiku či vysvětlení určitého pojmu.


Zdokonalení nápovědy pomocí HCW

Svůj nápovědný soubor můžete radikálně vylepšit i pomocí programu HCW. V této části si ukážeme základní techniky, které Vás uvedou do téhle problematiky.

Vytvoření primárního okna a nastavení jeho základních vlastností

Při první kompilaci nápovědného souboru jste si určitě všimli, že barevné schéma nápovědného okna není zrovna dvakrát uživatelsky přívětivé. Pozadí totiž tvoří jednolitá bílá barva a na ní se nachází černý text (tedy samozřejmě za předpokladu, že jste při tvorbě souboru RTF nezměnili danou barvu písma).  Aby jste mohli definovat barvu okna nápovědy a rovněž i další vlastnosti tohoto okna, musíte nejdříve vytvořit primární okno nebo-li okno typu “main”.  Postupujte následovně:

 Spusťte program HCW.

 Otevřete nápovědný projekt, který chcete editovat.

 Klepněte na tlačítko Windows.

 Jako jméno okna zadejte “main” (bez uvozovek).

Po vytvoření primárního okna Vám program zpřístupní  okno  Window Properties, které obsahuje 5 karet: General, Position, Buttons, Color a  Macros. Pro více informací klikněte kdekoli na obrázek.

Karta General

Karta Position

Karta Buttons

Karta Color

Karta Macros

Pomocí další metody si ukážeme, jak si můžete přidat vlastní tlačítko do panelu tlačítek nápovědy.

Využijeme k tomu makro CreateButton(), které má tři parametre:

 Jméno tlačítka – jednoznačné jméno, které identifikuje tlačítko.

 Text tlačítka – text, který se objeví na tlačítku.

 Makro – které se spustí po aktivaci tlačítka.

V programu HCW klepněte na tlačítko Config..., dále aktivujte tlačítko Add... a jako makro napište CreateButton(btnProgram, Spustit program, ExecFile(Notepad.exe)) a klepněte na OK. Tento zápis zabezpečí vytvoření tlačítka s nápisem “Spustit program” a po aktivaci tlačítka spustí příslušný program.


Seznam obsahuje jednotlivé okna nápovědného souboru (v našem případě jen okno main). Tlačítka slouží pro přidávaní, odstraňování a modifikaci.


Text, který se bude objevovat v titulním pruhu okna nápovědy.


Stručný komentář k vytvořenému typu okna.


Maximalizuje okno nápovědy.


Umístí okno nápovědy před všechny ostatní okna.


Uloží vykonané změny v nastavení okna nápovědy.


Odvolá vykonané změny v nastavení okna nápovědy.


Je-li políčko zaškrtnuté, okno nápovědy se automaticky přizpůsobí rozlišení obrazovky.


Jednotlivé atributy určují velikost okna nápovědy a jeho pozici na obrazovce monitoru.


Po stisknutí tohoto tlačítka si můžete sami určit velikost okna nápovědy a jeho pozici na obrazovce monitoru.


Aktivací tlačítka nastavíte standardní velikost a pozici okna nápovědy.


Kolekce zašktávácích políček představuje tlačítka, které se objeví v panelu tlačítek nápovědného okna.

Pozn.: Při výběru tlačítka Browse se předpokládá, že chcete do nápovědy implementovat tzv. sekvenční pohyb po tématech a tedy musíte tyto témata formátovat příslušným způsobem.


Zruší standardní nastavení tlačítek v panelu tlačítek nápovědného okna a poskytne Vám možnost výběru jednotlivých kombinací tlačítek.


Změní barvu pozadí statické oblasti okna nápovědy.


Změní barvu pozadí obsahové oblasti okna nápovědy.


Seznam obsahuje makra, která se spouštějí v uvedeném pořadí vždy při aktivaci určitého typu okna. V našem případe s oknem typu “main” se tyto makra aktivují vždy při spuštění nápovědného souboru.


Použití programu Hotspot Editor

Program Hotspot Editor (nebo-li SHED) je určen pro tvorbu tzv. “hotspotů”, lépe řečeno aktivních oblastí na obrazovce, na které může uživatel kliknout. Lepší asi bude názorný příklad. Představte si, že máte v aplikaci panel nástrojů a v nápovědě programu chcete uživatele, co možná nejjednodušeji, obeznámit s významem jednotlivých tlačítek. Úlohu můžete vyřešit takhle:

Vytvoření hotspotu je podobné jako tvorba definice termínu, jenomže se realizuje z programu Hotspot Editor. Ten spustíte ze samotného HCW, z nabídky Tools.

Vytvoření hotspotu a souboru SHG

 Zvolte menu File, Open... a otevřete jeden z podporovaných souborů (*.bmp;*.dib;*.wmf, *.shg).

 Myší vyberte obdélník, který představuje aktivní oblast.

 Z nabídky Edit vyberte Attributes...

 V okně Attributes zadejte jedineční název tématu, na které se vztahuje aktivní oblast, dále definujte typ vazby (Jump – odskok, Pop-up – definice termínu nebo Macro – spuštění makra) a atribut viditelnosti. Potom klepněte na tlačítko OK a soubor uložte.

Implementace souboru SHG do souboru RTF

 Umístěte kurzor na to místo, kde chcete vložit hotspot.

 Zadejte příkaz, podobně jako při vkládání obrázků {bmx jméno_souboru.shg}, kde x může nabývat tyto hodnoty:

c – zarovná obrázek v jedné rovině s textem

l – zarovná obrázek na levou stranu

r – zarovná obrázek na pravou stranu

Dodatečná je hodnota t, která se používá jenom při práci se 16-barevnými obrázky a dovoluje nahradit bílou barvu pozadí obrázku barvou pozadí okna nápovědy (potom tedy syntaxe vypadá takhle {bmxt jméno_souboru.shg}

Po uskutečnění všech úprav, soubor RTF uložte a znovu vytvořte nápovědný soubor. Ten pak již bude obsahovat i aktivní oblast v podobě hotspotu.


Vytvořit soubor

Vytvoří nový textový soubor a standardně jej pojmenuje.


Otevřít soubor

Otevře vybraný textový soubor.


Uložit soubor

Uloží soubor buď do formátu TXT nebo do formátu RTF.


Tisk

Vytiskne celý dokument.


Vyjmout

Vyjme vybraný text do schránky.


Kopírovat

Zkopíruje vybraný text do schránky.


Vložit

Vloží text ze schránky do dokumentu.


Tučné písmo

Změní formát vybraného textu na tučné.


Kurzíva

Změní formát vybraného textu na kurzívu.


Podtržení

Podtrhne vybraný text.


Zarovnání doleva

Zarovná vybraný text doleva.


Zarovnání na střed

Zarovná vybraný text na střed.


Zarovnat doprava

Zarovná vybraný text doprava.


Nápověda a Visual Basic

Gratuluji Vám! Právě jste vytvořili svoji první nápovědu. Nyní Vám již nic nebrání v tom, aby jste začali experimentovat s dalšími prvkami a vlastnostmi nápovědného souboru a tvořili tak stále lepší a lepší soubory nápověd, ze kterých budou mít uživatelé radost.

Nyní, když máte hotový soubor nápovědy, je nejpříhodnější čas začlenit jej do aplikace Visual Basicu. Spusťte tedy VB a otevřete projekt Vaší aplikace. Z nabídky Project vyberte Jméno_projektu Properties..., na kartě General vyberte nápovědný soubor a klepněte na tlačítko OK.

Když spustíte aplikaci a aktivujete klávesu F1, objeví se nápověda.

Nápovědu je samozřejmě možné vyvolat i pomocí kódu, asi takto:

 přidejte do projektu ovladač CommonDialog a pojmenujte jej jako cdl1

 do události click tlačítka nebo položky menu, která má vyvolat nápovědu zapište:

cdl1.HelpFile = app.path & “\Nápověda.hlp” ' určení plné cesty k souboru nápovědy

cdl1.HelpCommand = cdlHelpContents ' nastavení typu zobrazení nápovědy

cdl1.ShowHelp ' zobrazení nápovědy


Autor

Autor tohoto nápovědného souboru se zabývá programováním ve Visual Basicu a problematikou nápovědných souborů. Můžete ho zastihnout na následující e-mailové adrese: hanja@se.psg.sk

Vypracoval Ján Hanák, 2001