Průvodce tvorbou nápovědy – 11. díl

 

 

Vážení čtenáři,

 

vítám vás u dalšího dílu nápovědného seriálu. Na naší dnešní virtuální výpravě se podíváme na možnosti a dovednosti informačních typů a koncepci modulární nápovědy pro modulární software.

 

 

V souvislosti s novou grafickou úpravou bych vás rád upozornil na nové grafické ikony a jejich charakteristiku.

 

 

 

Informační typy

 

Co jsou to informační typy?

 

V prostředí HTML nápovědy se můžeme setkat s novým pojmem, který se v nápovědném světě doposud nevyskytoval. Ano, jde o tzv. informační typy, hlavním úkolem kterých je poskytovat analytičtější pohled na systém nápovědy jako takový. Za pomoci informačních typů mohou autoři nápověd vytvářet systémy, které se dovedou lépe přizpůsobit potřebám koncových uživatelů. Aplikací informačních typů lze filtrovat informace nápovědy a uživatelům doručit jenom ty, které je opravdu zajímají. Představte si, že pracujete na nápovědném systému, jenž bude obsahovat informace pro tři cílové skupiny uživatelů: začátečníky, pokročilé uživatele a experty. Pokud využijete schopností informačních typů, budou si moci uživatelé zvolit některý z nabízených „profilů“ a zobrazit jenom relevantní informace pro vybraný profil. Lépe pravděpodobně poslouží vizuální ztvárnění problematiky na obr. 1.

 

 

Obr. 1 – Schematické zobrazení aplikace informačních typů

 

Pochopitelně, že použití informačních typů je daleko rozsáhlejší, můžete např. definovat informační typy pro různé osoby organizační skupiny (vedoucí projektu, analytik, programátor, grafik), nebo třeba pro různé softwarové produkty. V následující části si ukážeme, jak lze opatřit HTML nápovědu informačními typy.

 

 

Tvorba informačních typů

Krok 1: Plánování

 

Pokud se rozhodnete pro implementaci informačních typů, měli byste co možná nejvhodněji naplánovat i jejich použití. Především musíte vědět, jaké typy hodláte vytvořit, definovat jejich názvy, počet a význam v nápovědě. V našem případě budeme definovat tři informační typy podle skupin uživatelů (začátečníci, pokročilí, experti).

Rovněž se doporučuje, abyste ze svého projektu nápovědy vytvořili záložní kopie, protože případné odstraňování informačních typů z projektu nápovědy je poněkud zdlouhavé a pracné. Uděláte-li chybu, máte vždy možnost vrátit se ke zálohovaným údajům.

 

 

Tvorba informačních typů

Krok 2: Příprava obsahového souboru nápovědy (TOC)    

 

V této etapě vývoje společně vytvoříme položky obsahového souboru, na které později aplikujeme informační typy.

 

 

Postupujte dle následujících instrukcí:

 

1. Otevřete přiložený projektový soubor nápovědy (Inf_typy.HHP) a zvolte záložku Contents.
2. Klepněte na tlačítko Insert a heading a do pole Entry title zadejte text „Obsah“. Dále klepněte na tlačítko Add, ze seznamu vyberte položku s názvem „Použití informačních typů“, klikněte na OK a zbylé okno zavřete opět stisknutím tlačítka OK.
3. Pokračujte aktivací tlačítka Insert a page a když se vás program zeptá, zda chcete položku umístit na začátek obsahové struktury, zvolte zápornou odpověď. Do pole Entry title zadejte text „Informace pro začátečníky“, klepněte na tlačítko Add, ze seznamu vyberte stejnojmennou položku a změny uložte kliknutím na OK.
4. Opakujte 3. krok pro přidání obsahových položek pro pokročilé uživatele a experty.
5. Nakonec obsahový soubor uložte.

 

 

Tvorba informačních typů

Krok 3: Definice informačních typů

 

V tomto kroku budeme definovat jednotlivé typy informací. Postupujte takto:

 

1. V projektovém souboru nápovědy aktivujte záložku Contents, klepněte na tlačítko Contents properties a posléze aktivujte záložku Information Types.
2. Klikněte na tlačítko Add, dialogové okno upravte do podoby znázorněné na obr. 2 a poté stiskněte tlačítko OK.

 

 

Obr. 2 – Definice informačních typů

 

 

 

 

 

3. Neopouštějte okno Table of Contents Properties a opakujte 2. krok pro definici dvou dalších informačních typů pro pokročilé uživatele a experty. V obou případech definujte typy informací jako Inclusive.
4. Po uskutečněných změnách klepněte na OK a obsahový soubor uložte.

 

 

Tvorba informačních typů

Krok 4: Přiřazení informačních typů položkám TOC

 

Poslední krok představuje asociování informačních typů jednotlivým položkám stromové struktury obsahového souboru.

 

1. Na záložce Contents klepněte na položku „Informace pro začátečníky“ a aktivujte tlačítko Edit selection.
2. V sekci Available information types zatrhněte první pole „Začátečník“, jak zobrazuje obr. 3. Poté změny uložte aktivací tlačítka OK.

 

 

Obr. 3 – Přiřazení informačních typů položkám TOC

 

 

3. Opakujte kroky 1 a 2 pro položky „Informace pro pokročilé“ a „Informace pro experty“.
4. Obsahový soubor uložte a proveďte kompilaci souboru nápovědy.

 

 

Testování informačních typů

 

Spusťte soubor nápovědy a v oblasti stromové struktury témat aktivujte pravé tlačítko myši. Z kontextové nabídky vyberte příkaz Customize (Přizpůsobit).

 

 

Obr. 4 – Přizpůsobení souboru HTML nápovědy (Krok 1)

 

Na obrazovce se objeví průvodce, který vám dovolí nakonfigurovat informační typy podle vašich požadavků. Ve druhém kroku vyberte možnost vlastního nastavení (Custom) a klepněte na tlačítko Další (Next).

 

 

Obr. 5 – Přizpůsobení souboru HTML nápovědy (Krok 2)

 

Ve třetím kroku specifikujte typy informací, které si přejete zobrazit. Všimněte si, že lze vybrat jeden, nebo i několik typů informací současně.

 

 

Obr. 6 – Přizpůsobení souboru HTML nápovědy (Krok 3)

 

Následujte rady průvodce až do koneční fáze a nechte si zobrazit „přefiltrovaný“ soubor nápovědy. Uvidíte, že se objeví pouze ta témata, která odpovídají dříve vybraným informačním typům.

 

 

 

Další charakteristiky informačních typů

 

Když budete pracovat s informačními typy, měli byste rovněž poznat i další významné fakty, které se s danou problematikou pojí.

 

 

 

Modulární systémy HTML nápovědy

 

Koncepce modulárních systémů HTML nápovědy

 

Koncepce modulárních nápovědních systémů vychází ze samotné podstaty modulárního softwaru. Pod pojmem „modulární software“ se rozumí software, který je složen z několika modulů nebo částí. Obvyklou charakteristikou softwarových modulů je na jedné straně jejich vzájemná nezávislost a na straně druhé potom společná závislost na určitém základním prvku, základní programové části. Pro lepší pochopení tématiky si uveďme příklad.

 

Mějme tedy standardní grafickou aplikaci. Tato aplikace představuje již zmíněný základní modul, který poskytuje „zázemí“ pro další přídavné moduly. Aplikace je rovněž opatřena systémem HTML nápovědy. Jde tedy o plnohodnotnou aplikaci, která se může na softwarovém trhu samostatně a zcela regulérně prodávat. Pokračujme v našich úvahách a představme si, že vývojáři vytvoří jisté „rozšíření“ aplikace v podobě modulu speciálních efektů, který bude s aplikací spolupracovat a dále rozšiřovat její možnosti. Je ovšem potřebné napsat nápovědu i pro nový modul a tuto „dynamicky“ přidat do nápovědného systému, jenž se již nachází na počítači koncového uživatele. Z pohledu uživatele se v stromové struktuře témat a rejstříku objeví nové položky, které se budou vztahovat na právě nainstalovaný modul.

 

Nuže a právě nyní se dostáváme k samotné koncepci modulární nápovědy. Hlavním úkolem modulárního systému nápovědy je poskytovat uživatelům informace o různých částech aplikace, a to v jednotné, syntetické podobě. I když bude mít uživatel nainstalováno více modulů aplikace, vždy bude pracovat jenom s jedním (modulárním) systémem HTML nápovědy. Ve skutečnosti by uživatel ani neměl postřehnout, že nepracuje s jednolitým systémem nápovědy, nýbrž s dynamicky „poskládaným“ systémem, který v sobě absorbuje informace ze všech dostupných modulů.

 

 

Jak pracuje modulární systém HTML nápovědy    

 

První a snad nejdůležitější skutečností je, že ke generování finálního modulárního systému HTML nápovědy dochází za běhu programu, lépe řečeno po spuštění hlavního souboru nápovědy. V této chvíli se nápovědní soubor „podívá“, zda-li nejsou „na blízku“ (t.j. ve stejné složce) další „přátelské“ soubory nápověd, které mají tvořit modulární systém. Jestliže jsou, jejich obsah je dynamicky vložen do hlavního souboru nápovědy. V opačném případě, když soubor nápovědy nenalezne žádné „příbuzné“ soubory nápověd, bude zobrazena standardní nabídka hlavního souboru nápovědy.

 

Dále je velmi důležité vědět, že toto dynamické propojování nápovědních souborů je zcela kompletní, to znamená, že se propojují jednak položky obsahové struktury nápovědy, rejstříku i fulltextového vyhledávání. Ilustrace postupu je uvedena na obr. 7.

 

 

Obr. 7 – Ilustrace pracovního principu modulárního systému HTML nápovědy

 

V následující kapitole si ukážeme, jak sestrojit jednoduchý modulární systém HTML nápovědy.

 

 

Tvorba modulárního systému HTML nápovědy

Krok 1: Plánování

 

Plánovací fáze je v tomto případě obzvlášť důležitá, a to z jednoho podstatného důvodu. Vy, jako autoři nápovědy, musíte totiž již do základního souboru nápovědy vložit příslušné reference, které budou ukazovat na externí soubory nápověd. Bez těchto informací by pak hlavní soubor nápovědy nebyl schopen „navázat spojení“ s přídavnými soubory nápověd. Obecně vzato, tvorba modulárního systému nápovědy probíhá od samého počátku vývoje hlavní aplikace a ne až po jejím dokončení, jak se ostatně mnozí mylně domnívají. Pokud se rozhodnete pro modulární systémy, je také důležitá velmi úzká spolupráce vás (autorů nápověd) a dalších členů vývojářského týmu (zejména programátorů). Samozřejmě, že plánování nápovědy se odvíjí od prvotních požadavků, které jsou na programovou aplikaci kladeny.

 

 

Tvorba modulárního systému HTML nápovědy

Krok 2: Vkládání odkazů na externí soubory nápověd

 

Do hlavního souboru nápovědy (resp. do odpovídajícího projektového souboru) se vkládají informace o externích souborech HTML nápovědy (.CHM). V našem případě budeme pracovat pouze s jedním externím souborem nápovědy.

 

 

Postupujte dle instrukcí:

 

1. Otevřete přiložený projektový soubor Mod_01.HHP (jde o projektový soubor hlavní části modulárního systému HTML nápovědy).
2. Na záložce Project klepněte na tlačítko Change project options.
3. V dialogovém okně Options zvolte poslední záložku Merge Files.
4. Nyní aktivujte tlačítko Add a v dialogovém okně specifikujte jméno externího souboru nápovědy (v našem případě Mod_02.CHM). Po klepnutí na OK by obrazovka měla vypadat jako na spodním obrázku.

 

 

Obr. 8 – Vkládání odkazu na externí soubor nápovědy

 

5. Zavřete otevřené okno kliknutím na tlačítko OK a uložte projektový soubor nápovědy.

 

 

Tvorba modulárního systému HTML nápovědy

Krok 3: Začlenění odkazů do TOC hlavního souboru nápovědy

 

Jestliže jste zdárně absolvovali druhý krok, můžete přikročit ke začlenění odkazu na externí soubor nápovědy do obsahové struktury témat hlavní části nápovědy. Postup je zde:

 

1. Aktivujte záložku Contents, čímž se vám zpřístupní obsahová struktura hlavní nápovědy programové aplikace.
2. Označte položku s názvem „Téma 1“ a stiskněte pravé tlačítko myši. Objeví se kontextové menu, ve kterém klikněte na položku Insert File.

 

 

Obr. 9 – Začlenění odkazu do TOC

 

3. V dialogovém okně Include File zadejte do textového pole řetězec Mod_02.CHM::/TOC_02.HHC

Podívejme se nyní na tento zápis podrobněji.

 

Obr. 10 – Textový řetězec pod drobnohledem

 

První část popisuje název externího souboru HTML nápovědy (Mod_02.CHM), dále následuje dvojice dvojteček, lomítko a nakonec je specifikován název obsahového souboru externí nápovědy (TOC_02.HHC).

4. Po stisknutí tlačítka OK se vás HHW zeptá, jestliže chcete daný soubor určitě použít i když ho nelze najít. Ihned po zadání kladné odpovědi se okno uzavře.
5. Dále upravte pozici vytvořené položky a posuňte ji směrem doleva aktivací tlačítka se šipkou (Move selection left). Finální obraz obsahové struktury by měl vypadat takto:

 

 

Obr. 11 – Finální podoba TOC hlavního souboru nápovědy

 

6. Uložte obsahový soubor a proveďte kompilaci souboru nápovědy.

 

 

Testování modulárního systému HTML nápovědy

 

Abyste mohli spolehlivě otestovat váš první modulární nápovědní systém, je nevyhnutné zkopírovat soubor nápovědy Mod_02.CHM (ze složky Nap_externi) do složky hlavního nápovědného souboru (Mod_01.CHM). Jakmile to uděláte, spusťte hlavní soubor nápovědy a podívejte se na výsledek.

 

 

Obr. 12 – Modulární systém nápovědy v akci

 

 

 

 

Věřím, že probraná problematika vás zaujala a že ji jistě využijete i v praxi.

 

Na shledanou za měsíc.

 

 Ján Hanák