Úprava nápovedy systému CP a CW

Systém Control Panel a Control Web má skvele vybudovanú nápovedu. Žiadna nápoveda, i tá sebelepšia, však neobsahuje úplne všetky poznatky k systému. Každý užívateľ nejakého softu, zvlášť vývojového, nadobúda postupom času nejaké vlastné znalosti, postupy a skúsenosti, ktoré v nápovede nie sú obsiahnuté. Čím viac ich je, tým je väčší problém s ich spravovaním - rozumej vybavením z pamäti (hlavne po dlhšej dobe).
Ak by sme chceli mať vlastné poznámky "po ruke", riešením by mohlo byť ich dopĺňanie priamo do nápovedy systému. Bežné aplikácie (napr. vo Win) používajú nápovedu v tvare HLP a tam si bez špecializovaného softu ani neškrtnete. Systém Control Panel a Control Web však používa nápovedu v tvare HTML - a tu si vystačíte i s ASCII textovým editorom obsiahnutým v systéme.

Keď si kliknete v CP a CW na záložku NÁPOVEDA, zobrazí sa vám plocha rozdelená na dve časti - vpravo vlastná textová časť a vľavo stromová štruktúra nápovedy. Rozbaľovacia stromová štruktúra nápovedy obsahuje vlastne členenie nápovedy na jednotlivé kapitoly. Po kliknutí na niektorú z kapitol v ľavej časti, sa zobrazí v pravej časti príslušný HTML súbor. Ak si chceme doplniť do nápovedy vlastné poznámky, musíme si ich pripraviť v podobe HTML súboru a následne upraviť rozbaľovaciu stromovú štruktúru nápovedy, aby sme si mohli tento súbor (súbory) i vyvolať. Tvorbou HTML sa v tomto príspevku zapodievať nebudem, na internete sú k tejto téme tony zdrojov. Zapodievať sa budem spôsobom, ako modifikovať ľavú - stromovú štruktúru nápovedy, aby sme si mohli pripravené vlastné poznámky i vyvolať priamo v nápovede systému.

Nápoveda tiež podlieha autorským právam, ale proti dopĺňaniu vlastných poznámok pre vlastnú potrebu hádam páni z Moravských přístrojov nebudú nič namietať.

Ak ste si nechali nápovedu inštalovať na disk a systém Control Panel ste nechali inštalovať napr. do adresára C:\CP, potom celá nápoveda sa nachádza v adresári C:\CP\DOC. Nápoveda k samotnému systému CP sa potom nachádza v podadresári C:\CP\DOC\CORE. Daľšie podadresáre obsahujú nápovedu k ďaľším rozširujúcim prístrojom a aplikáciam. Čo nás hlavne zaujíma, je podadresár C:\CP\DOC\MAN, ktorý obsahuje súbory definujúce samotnú rozbaľovaciu stromovú štruktúru nápovedy. Tieto súbory majú koncovku MAN (*.MAN) a ide o jednoduché ASCII súbory. Každý súbor typu MAN môže predstavovať jednu hlavnú kapitolu nápovedy a jeho obsahom je definícia štruktúry podkapitol a odkazy na príslušné HTML súbory. Poradie hlavných kapitol v nápovede je dané abecedným poradím jednotlivých súborov MAN. Súbory MAN je možné pridávať i odoberať, čím dosiahneme pridanie alebo odobratie jednotlivých hlavných kapitol z nápovedy. Akú formu musí mať súbor MAN, sa pokúsim vysvetliť na príklade - pripravil som všetky tipy&triky k CP z môjho webu do podoby nápovedy pre CP (môžte si stiahnuť a naištalovať podľa pokynov).

Keďže som nechcel akokoľvek zasahovať do existujúcej nápovedy systému CP, pripravil som si samostatný súbor MAN s definíciou štruktúry. Nazval som ho !!TIPY.MAN. Tie dva výkričníky v názve súboru nie sú povinné, ale zabezpečil som tým, že súbor sa v abecednom poradí nachádza na začiatku, čiže i kapitola s mojimi príspevkami bude v nápovede na začiatku. Obsah súboru vyzerá nasledovne:

Id OwnId Icon Name Font File
99900; x; 8453; Šlosarove tipy a triky; H12B; x;
x; 99900; x; Úvod; S10N; ..\tipy\uvod.htm;
99920; 99900; 5; Tipy a triky; S10B; x;
x; 99920; x; Úprava nápovedy systému CP a CW; S10N; ..\tipy\cp-cphlp.htm;
x; 99920; x; História činnosti obsluhy; S10N; ..\tipy\cp-his.htm;
x; 99920; x; Zmena časovania prístroja za behu; S10N; ..\tipy\cp-seq.htm;
x; 99920; x; Tvorba roletového menu; S10N; ..\tipy\cp-menu.htm;
x; 99920; x; Spôsoby tvorby systémových hodín; S10N; ..\tipy\cp-time.htm;
x; 99920; x; Použitie OCL metód; S10N; ..\tipy\cp-ocl.htm;
x; 99920; x; Ďalšie ikony do Control Panelu; S10N; ..\tipy\cp-ico.htm;
x; 99920; x; Vytvorte si vlastný spojitý regulátor; S10N; ..\tipy\cp-reg.htm;
x; 99920; x; Prevod analógového výstupu na pulzne šírkovú moduláciu; S10N; ..\tipy\cp-psm.htm;
x; 99920; x; Digitálny reálny čas so 7-segmentovkami; S10N; ..\tipy\cp-cas.htm;
x; 99920; x; Nápoveda vo vašich aplikáciach; S10N; ..\tipy\cp-hlp.htm;
x; 99920; x; Testovanie sieťových aplikácií; S10N; ..\tipy\cp-net.htm;
x; 99920; x; Plastické rámčeky a linky v paneloch; S10N; ..\tipy\cp-frm.htm;
x; 99920; x; Príprava bitmapových obrázkov mimo CP; S10N; ..\tipy\cp-obr.htm;
99930; 99900; 5; Ďaľšie články; S10B; x;
x; 99930; x; 16. 3. 2000 - Control Panel (Control Web) ako simulátor; S10N; ..\tipy\cp-simul.htm;
x; 99930; x; 13. 9. 1999 - Objavil som chybu v systéme CP 3.1 + SP2; S10N; ..\tipy\cp-chyba.htm;
x; 99930; x; 24. 5. 1999 - Odskúšal som si konečne Control Web - prvé dojmy; S10N; ..\tipy\cp-cw.htm;
x; 99930; x; 16. 12. 1998 - Skúsenosti so zapožičaným PLC automatom B&R 2003; S10N; ..\tipy\cp-b-r.htm;

A výsledok nasledovne:

Ako vidno, každý riadok súboru MAN predstavuje jednu položku štruktúry nápovedy, čiže jednotlivé kapitoly a podkapitoly. Každý riadok obsahuje povinne nasledovné údaje, vzájomne oddelené podkočiarkou:

Id;  OwnId;  Icon;  Name;  Font;  File

Id - identifikátor
OwnId - identifikátor vlastníka
Icon - ikona kapitoly
Name - názov kapitoly
Font - font použitý pre názov kapitoly
File - súbor, na ktorý odkazuje kapitola, teda to, čo sa zobrazí po kliknutí v pravej časti

Členenie kapitol a podkapitol definujú číselné hodnoty Id a OwnId. Každá kapitola (riadok) musí mať uvedenú číselnú hodnotu Id alebo OwnId. Ak je kapitola rozbaľovacia (obsahuje podkapitoly) vyplníme hodnotu Id. Táto hodnota sa ako Id už nesmie vyskytovať na inom mieste alebo v inom súbore MAN. Hodnota OwnId určuje, ktorá kapitola je nadradená, čiže vlastníka. Ak túto hodnotu nahradíme znakom "x", jedná sa o hlavnú kapitolu, pretože už nemá vlastníka. Znak "x" uvedieme ako Id i u kapitol, ktoré sa už ďalej nerozbaľujú, čiže neobsahujú žiadne podkapitoly. Podstatu definície štruktúry je možné vlastne vysledovať z predošlého výpisu a obrázku.
Ďalej máme číselnú hodnotu Icon, ktorá určuje, aká ikona bude použitá na začiatku názvu kapitoly a akú farbu bude mať text názvu kapitoly. Znak "x" alebo hodnoty v rozsahu 0 až 7 určujú ikonu. Ak budeme k tejto hodnote pričítavať násobky čísla 4096, budeme zároveň meniť farbu textu názvu kapitoly - viď. nasledujúci obrázok (zosnímané pri 16 farebnom režime):

Ak k hodnote Icon pričítame ešte číslo 256, bude príslušná kapitola po zobrazení nápovedy i okamžite "rozbalená".
Hodnota Name určuje samotný text názvu kapitoly - k tomu netreba nič dodávať.
Hodnota Font určuje typ písma, jeho veľkosť a rez, použitý pre text názvu kapitoly. Napr. hodnota "S10N" udáva, že bude použitý font "system" o veľkosti 10 bodov s rezom "normal".
A nakoniec hodnota File určuje, čo bude zobrazené v pravej časti nápovedy po kliknutí na príslušnú kapitolu. Znak "x" udáva, že sa nezobrazí nič. Ak chceme zobraziť súbor HTML s vlastnou nápovedou, zadáme sem jeho absolútnu alebo relatívnu cestu a názov súboru. Namiesto HTML súboru môže byť zobrazený i obrázok (napr. u hlavnej kapitoly).

Ako som uviedol vyššie, súbory typu MAN sa v systéme CP štandardne nachádzajú v adresári ..\DOC\MAN. Vlastnú nápovedu (súbory MAN a HTML) si môžte umiestniť i kdekoľvek inde na disk, ale potom nebude zobrazovaná spoločne so systémovou nápovedou a musíte si v CP určiť, kde sa vaša nápoveda nachádza. Buď ručne, cez menu "Súbor-Otvoriť" (pri zobrazenej nápovede) alebo úpravou súboru CP.INI.
Všetko, čo som v tomto príspevku popísal funguje pod CP3.X, ako i pod CW. Dúfam, že som spôsob úpravy nápovedy popísal dostatočne zrozumiteľne, ak nie, tak mailnite.

Môžte si stiahnuť všetky moje príspevky k systému CP a CW z môjho webu upravené do podoby nápovedy k týmto systémom. Zazipovaný súbor obsahuje súbor typu MAN a adresár TIPY. Súbor typu MAN skopírujete do adresára ..\DOC\MAN vašej inštalácie, adresár TIPY skopírujete do adresára ..\DOC vašej inštalácie. Keby náhodou niečo nefungovalo, tak mailnite.

download: cphlp.zip - s každým novým príspevkom bude súbor aktualizovaný