Začátečník	Pokročilý	Profesionál
Budete potřebovat přibližně 1 hodinu	Operační systém použitý v příspěvku: Windows XP Vývojové nástroje: Visual Studio .NET, VSHIK

Vážení čtenáři,

dovolte mi, abych vás přivítal při posledním dílu seriálu Průvodce tvorbou nápovědy. Když se tak ohlížím zpět, musím přiznat, že v začátcích tvorby tohoto seriálu jsem ani v nejmenším netušil, že se tento rozroste do tak obřích rozměrů. Informací, které seriál poskytnul, bylo opravdu hodně (dohromady přes 200 tisíc znaků bez mezer). Společně jsme probádali tajemná zákoutí nejen nápovědy stylu Windows 95 (WinHelp 4.0), nýbrž i pokročilejší HTML nápovědy. V dnešní části naší pouť ukončíme, no ještě před tím se podíváme na základní koncepci nápovědy „nové generace“, která je společností Microsoft zatím pracovně označována jako MS Help 2.0 (někde se můžete střetnout i s pojmem HTML Help 2.0). Po přelouskání nezbytné teorie se dostaneme i k vytvoření jednoduchého souboru nápovědy typu MS Help 2.0.

Obsah

Co budete potřebovat

Přehled některých změn, které přináší nový model nápovědy

Struktura projektu nápovědy MS Help 2.0

Tvorba nápovědy MS Help 2.0: Krok 1 – Vytvoření nového typu projektu (.HWProj)

Tvorba nápovědy MS Help 2.0: Krok 2 – Přidání souborů s tématy (.HTM)

Tvorba nápovědy MS Help 2.0: Krok 3 – Přidání souboru s obsahem (.HxT)

Tvorba nápovědy MS Help 2.0: Krok 4 – Přidání souboru s rejstříkem (.HxK)

Co budete potřebovat

Budete-li chtít vytvářet projekty a ostatní součásti nové nápovědy, bude potřebovat tzv. VSHIK, což je zkratka pro Visual Studio .NET Help Integration Kit. Jde o sadu nástrojů, které se nainstalují do prostředí Visual Studia a dovolí vám vytvářet projekty nápovědy. Nejdůležitějším nástrojem je Help Workshop, jenž vám zpřístupňuje možnost vizuální editace nápovědy přímo ve Visual Studiu .NET. Protože program důsledně naplňuje myšlenku komplexní integrace, od chvíle nainstalování se stane standardní součástí Visual Studia, a tedy již nebudete muset nápovědu vytvářet v externím prostředí, jak to bylo dříve. Místo toho můžete využít všech pozitivních vlastností, které přináší jednotné integrované prostředí.

V prozatímní (pre-release) verzi VSHIK Microsoft nástroj na tvorbu nápovědy stylu MS Help 2.0 pojmenoval jako Help Workshop. Nepleťte si prosím uvedený název se starším programem pro generování nápovědy stylu Windows 95 (jde také o Help Workshop).

Přehled některých změn, které přináší nový model nápovědy

Program Help Workshop, podobně jako celý systém nové nápovědy, přináší mnoho nových prvků a vlastností. Zde jsou vyjmenovány alespoň některé z nich:

Projektové soubory jsou od nynějška založeny na standardu jazyka XML.

Nápovědu lze vytvářet se „vším všudy pod jednou střechou“. Dovoluje to silná integrace nástrojů do IDE Visual Studia .NET.

Do nápovědy se zavádějí prostory jmen (namespaces) a protokol ms-help. Už tedy nebude nutné, abyste při volání souboru nápovědy museli znát plnou cestu k souboru, bude stačit, když použijete platný protokol a cílový jmenný prostor.

Došlo k vylepšení technologie informačních typů. Tématům nápovědy lze přiřadit identifikaci na základě různých atributů, a tyto pak filtrovat libovolným způsobem. Filtrování informací je nyní mnohem účinnější, jako tomu bylo u HTML nápovědy. Uživatelé můžou dynamicky určovat obsah a rozsah požadovaných informací.

Jsou podporovány mnohonásobné rejstříky (multiple indexes). Pokud budete chtít, můžete vytvořit tolik instancí rejstříku, kolik budete potřebovat.

Byl vylepšen i proces dekompilace, při kterém jsou vám programem Help Workshop poskytnuty všechny nezbytné zdrojové soubory.

Struktura projektu nápovědy MS Help 2.0

Projektový soubor (.HWProj) nové nápovědy obsahuje tyto typy souborů:

1. XML soubory, popisující samotnou strukturu projektu (.HxC a .HxF).
2. Soubory sloužící pro navigaci v prostředí systému nápovědy. Zde patří soubor s obsahovou strukturou nápovědy (.HxT) a soubor s rejstříkem (.HxK).
3. Soubory s tématy nápovědy (.HTM), grafické soubory (.JPEG, .GIF, .AVI, .WAV a další, které jsou kompatibilní s prohlížečem Internet Explorer verze 5.0), soubory se skripty a soubory s kaskádovými styly (.CSS).

Při procesu kompilace (obr. 1) program zpracuje všechny vstupné soubory a vygeneruje z nich kompilovaný soubor nápovědy MS Help 2.0. Tento soubor má koncovku HxS.

Obr. 1 – Proces kompilace souboru nápovědy MS Help 2.0

Tvorba nápovědy MS Help 2.0

Krok 1: Vytvoření nového typu projektu (.HWProj)

Abyste vytvořili projekt nápovědy stylu MS Help 2.0, udělejte následovní:

1. Z nabídky File vyberte položku New a klepněte na Project. V dialogovém okně, v sekci Project Types, poklepejte na položku Other Projects.
2. Pokračujte vybráním složky Help Projects.
3. V sekci Templates vyberte položku New Help Project.
4. Zadejte jméno pro nový projekt a aktivujte volbu Create directory for Solution. Okno by mělo nyní vypadat jako na obr. 2.

Obr. 2 – Výběr nového projektu pro tvorbu nápovědy

5. Když jste se všemi náležitostmi spokojeni, aktivujte tlačítko OK.

Help Workshop vytvoří základní strukturu projektu nápovědy. Okno Průzkumníka řešení (Solution Explorer) by mělo mít tuto podobu (obr. 3).

Obr. 3 – Podoba Průzkumníka řešení po vytvoření projektu

Jak si můžete všimnout, program vygeneroval dva soubory, Nápověda_02.HxC a Nápověda_02.HxF. První soubor (.HxC) obsahuje odkazy na všechny projektové součásti nápovědy, zatímco druhý soubor (.HxF) sdružuje informace o souborech s tématy, grafikou, rejstříkem či obsahem.

Uvedené soubory jsou automaticky aktualizovány vždy, když uložíte projekt s nápovědou nebo provedete kompilaci nápovědného souboru.

Tvorba nápovědy MS Help 2.0

Krok 2: Přidání souborů s tématy (.HTM)

Budeme pokračovat přidáním několika .HTM souborů, které budou představovat jednotlivá témata nápovědy. Pro přidání nové součásti do stávajícího projektu postupujte takto:

1. Vyberte nabídku Project a klepněte na položku Add New Item. Okamžitě se objeví dialogové okno, které vám dovolí vybrat typ součásti, kterou si přejete přidat do projektu.
2. V části Categories vyberte položku Help Workshop Topic Items.
3. V sekci Templates označte ikonu HTMLFile a zadejte jméno pro vytvářený soubor.
4. Příklad dialogového okna můžete vidět na obr. 4.

Obr. 4 – Přidání .HTM souboru do projektu s nápovědou

5. Klikněte na tlačítko Open.

Vytvořený soubor se následně otevře v integrovaném vývojovém prostředí, kde jej můžete podle libosti dále upravovat jak v režimu WYSIWYG, tak i pomocí přímé změny HTML kódu. Zkuste přidat do projektu nápovědy ještě dva .HTM soubory. Okno Průzkumníka řešení by mělo mít podobu, která je zobrazena na obr. 5.

Obr. 5 – Obsah Průzkumníka řešení po přidaní několika .HTM souborů

Pokud jste hotovi, můžeme přikročit k tvorbě obsahové struktury (angl. TOC, Table Of Contents) nápovědy.

Tvorba nápovědy MS Help 2.0

Krok 3: Přidání souboru s obsahem (.HxT)

1. Z nabídky Project vyberte položku Add New Item.
2. V dialogovém okně vyberte složku Help Workshop Project Items.
3. V sekci Templates vyberte ikonu Table of Contents (obr. 6).

Obr. 6 – Tvorba souboru s obsahem (HxT)

4. Soubor pojmenujte a klepněte na tlačítko Open.

Help Workshop vytvoří soubor s obsahovou strukturou a ihned jej otevře pro editaci (obr. 7).

Obr. 7 – Podoba TOC po vytvoření souboru s obsahem

V obsahové struktuře se nacházejí jenom jeden uzel s názvem Global TOC. Tento definuje vlastnosti pro celou stromovou strukturu obsahu. Přístup k těmto vlastnostem získáte, když klepněte na položku Global TOC pravým tlačítkem myši a z kontextové nabídky vyberete položku Properties. V okně Properties se záhy objeví vlastnosti, které můžete modifikovat. Jde o tyto vlastnosti: Font, FontSize, CharacterSet, IconFile, IconScheme, ID, Language a Version.

Abyste mohli vytvořit položky obsahu pro jednotlivé soubory s tématy, proveďte toto:

1. Označte položku New Topic a přejmenujte ji na „Obsah“. Položku snadno přejmenujete tak, že v okně Properties změníte její vlastnost Title.
2. Otevřete nabídku TOC a klepněte na položku Add Blank Node.
3. Novou položku pojmenujte jako „Téma1“.
4. Do vlastnosti URL položky Téma1 zadejte název souboru s tématy (.HTM), který se později bude zobrazovat vždy, když uživatel klepne na tuto položku.

Při zadávaní jména souboru s tématy (.HTM) do vlastnosti URL položky obsahu musíte za jménem souboru zapsat i tečku a platnou souborovou příponu, tedy např. Soubor_01.htm.

5. Zopakujte uvedený postup pro přidání dalších položek do obsahové struktury nápovědy. Po skončení by měl mít obsah nápovědy podobu uvedenou na obr. 8.

Obr. 8 – Ukázka TOC po přidání dodatečných položek

6. Klepněte na položku s názvem Téma1 pravým tlačítkem myši a z kontextové nabídky vyberte příkaz Move Node Right. Po provedení příkazu si můžete všimnout, že se odehrálo několik událostí. Předem, položka se posunula směrem doprava a došlo tak k vytvoření samostatní hierarchické úrovně stromové struktury. Další důležitou skutečností je, že k položce Obsah se přidala ikona knihy a z této položky se stal tematický celek. Výsledkem je tedy vytvoření samostatného tematického celku Obsah, jenž obsahuje jedno téma (Téma1). Situaci lze pozorovat na obr. 9.

Obr. 9 – Posun položky obsahu a vytvoření tematického celku

Abyste mohli rychleji posouvat položky obsahové struktury, použijte tlačítko se šipkou , které se nachází na panelu nástrojů TOC Editor. Nevidíte-li tento panel, vyberte nabídku View, ukažte na položku Toolbars a zaškrtněte volbu TOC Editor.

7. Pokračujte tím, že posunete i položky Téma2 a Téma3 směrem doprava, čímž je také zařadíte do vytvořeného tematického celku.
8. Uložte projekt, proveďte jeho sestavení a spusťte jej (obr. 10).

Obr. 10 – Nápověda MS Help 2.0 v akci

Po úspěšné kompilaci projektu nápovědy a všech ostatních nezbytných součástí je vytvořen jediný soubor nápovědy (HxS), nápověda je zaregistrována v systému a zobrazena v integrovaném prohlížeči. Jestliže poklepete na položku Obsah, zpřístupní se všechna témata, která jste vytvořili. Kliknete-li na název tématu, jeho informační obsah se zobrazí v pravé části okna prohlížeče. Výborně, právě jste vytvořili svou první nápovědu nové generace.

Tvorba nápovědy MS Help 2.0

Krok 4: Přidání souboru s rejstříkem (.HxK)

Sestavení rejstříku je, ve srovnání s tvorbou obsahové struktury, o něco složitější. V následujícím příkladu se pokusíme stávající projekt nápovědy opatřit jednoduchým rejstříkem. Postupujte dle uvedených instrukcí.

1. Otevřete nabídku Project a klepněte na položku Add New Item.
2. Vyberte ikonu Keyword Index, zadejte jméno pro rejstřík a aktivujte tlačítko Open. Inicializační podobu XML dokumentu pro rejstřík zobrazuje obr. 11.

Obr. 11 – Počáteční schéma XML podoby rejstříku

3. Aby rejstřík obsahoval klíčová slova pro tři témata, upravte jeho podobu tak, jak ji vidíte na obr. 12.

Obr. 12 – Výslední XML podoba rejstříku

Pokud provedete rekompilaci souboru nápovědy, uvidíte, že rejstřík plní svou funkci znamenitě (obr. 13).

Obr. 13 – Výslední podoba rejstříku nápovědy

Na závěr bych rád připomenul, že výsledný soubor nápovědy MS Help 2.0 lze v době psaní tohoto článku prohlížet jenom integrovaným prohlížečem Visual Studia (abstrahuji od různých sharewarových či jiných utilit podobného typu). Ostré verze nové nápovědy, příslušných nástrojů, exekuční knižnice a dalších softwarových součástí, které budou dovolovat spouštět nápovědu MS Help 2.0 odkudkoliv, by měly být (alespoň podle redmonštích vývojářů) dostupné někdy v roce 2003.

Věřím, že seriál o nápovědě vám byl v mnoha ohledech užitečný a pomohl vám vyřešit, když už ne všechny, tak alespoň většinu vašich „nápovědních“ problémů.

Ján Hanák