Tvorba nápovědy
Pokud chceme vytvořit soubor .hlp (soubor nápovědy), musíme nejprve
vytvořit projektový soubor .hpj pro překladač nápovědy (např. HC.exe dodávaný
společně s Borland Pascalem). K psaní tohoto souboru nám postačí jednoduchý
textový editor. Po kompilaci překladač pomocí souboru *.hpj vytvoří soubor *.hlp.
Soubor .hpj spojuje dohromady všechny soubory nápovědy - textové soubory témat
.rtf, obrázky, ikony... Celý soubor je rozdělen do několika částí - všechny
ovšem nejsou povinné. Názvy všech sekcí musí být uzavřeny v hranatých závorkách.
Nejdůležitější částí je [FILES], obsahuje seznam všech souborů
témat .rtf. Další části už jsou nepovinné.
Struktura projektového souboru nápovědy:
| [OPTIONS] | všechna řídící nastavení při kompilaci. |
| BMROOT | adresář, ve kterém jsou obrázky k souboru témat. |
| BUILD | určuje, které důležité prvky budou při kompilaci použity. |
| CITATION | vloží váš text do dialogového okna About pod text copyrightu. |
| COMPRESS | velmi důležitý prvek, který určí typ komprese pro vaši nápovědu. |
| COPYRIGHT | vloží text uživatelské copyright značky do dialogového okna About. |
| ERRORLOG | uloží všechny chybové hlášky při překladu do zvoleného souboru. |
| FORCEFONT | vloží zvolený font do všech souborů témat .rtf. |
| ICON | soubor ikony, která se zobrazí při minimalizaci souboru nápovědy ve Windows. |
| LANGUAGE | nastaví pořadí třídění klíčových slov v dialogovém okně pro hledání. |
| MAPFONTSIZE | změní velikost fontů použitých v souborech témat .rtf. |
| MULTIKEY | zpřístupní footnote-znak, který má být použit pro alternativní tabulku klíčových slov v souborech témat .rtf. |
| OLDKEYPHRASE | určuje, zda má být použito existujícího souboru klíčových frází, nebo se má znovu vytvořit. |
| OPTCDROM | optimalizuje soubor helpu pro zobrazení na CD-ROM. |
| REPORT | během výstavby zobrazuje části, které překladač momentálně dělá. |
| ROOT | určí adresáře, kde překladač hledá soubory vypsané v souboru projektu .hpj. (např. ROOT=C:\HELP) |
| TITLE | nastaví titulek souboru .hlp. |
| WARNING | určí úroveň (důležitost) chybových zpráv, které má překladač zobrazovat. |
| [FILES] | výčet všech souborů témat. |
| [BUILDTAGS] | definuje stavební značky k určení témat, které mají být zahrnuty do souboru nápovědy. |
| [CONFIG] | obsahuje makra pro tlačítka prohlížení - zpět, up..., registrují funkce knihoven dll. |
| [BITMAPS] | jména a cesta k souborům bitmap použitých v souborech témat *.rtf. |
| [MAP] | propojí kontextový řetězec tématu s číslem. |
| [ALIAS] | jednomu tématu přidělí několik kontextových řetězců. |
| [WINDOWS] | velikost, vlastnosti, umístění a barvy pro primární i sekundární okna užívané v souboru nápovědy. |
| [BAGGAGE] | vypíše soubory, které jsou umístěny v interním souborovém systému. |
Příklad projektového souboru nápovědy hpj:
| [OPTIONS] BMROOT=C:\HELP\images CONTENTS=cont_idx_card TITLE=Cardfile Help ICON=help.ICO COMPRESS=TRUE WARNING=2 REPORT=ON ERRORLOG=CARD.BUG [FILES] TEMATA\TEMA1.RTF (adresář TEMATA je podadresář adresáře, ve kterém se) TEMATA\TEMA2.RTF (nachází soubor *.hpj a kompilátor nápovědy.) [CONFIG] CreateButton("btn_up", "&Up", "JumpContents(`HOME.HLP')") BrowseButtons() SetHelpOnFile("APPHELP.HLP") |
Vytváření souboru témat *.rtf:
Vytvářet soubory témat můžeme pomocí jednoduchého textového editoru nebo pomocí
editoru, který už umí se soubory rtf pracovat. Soubor by měl být uzavřen do
kulatých závorek:
| {\rtf1\ansi #{\footnote tema1} (deklarace tema1) $(DOLLAR_BRACE)\footnote Me prvni Tema} Toto je mé prvni tema. \par (konec odstavce) \page } |
