PODSTAWY

PROGRAMOWANIA

Andrzej Marciniak

Prezentacja multimedialna przygotowana za pomoc¹ systemu Corel® Presentations 11 i X3
Copyright © 2003-2011 by Andrzej Marciniak

PP-12(1 z 76)

Na poprzednim wyk³adzie ...

podstawowe modu³y biblioteki RTL

< modu³ System
< modu³ SysUtils
< modu³ Math
< wywo³anie innego programu z programu paskalowego

informacje o bibliotece VCL

< okienka z komunikatami

PP-12(2 z 76)

Na tym wyk³adzie ...

przygotowanie systemu pomocy dla programu
okienkowego

< wyœwietlanie wskazówek
< do³¹czanie zbiorów pomocy i ich obs³uga w jêzyku

Delphi Pascal

< przygotowanie zbiorów pomocy w edytorach tekstów

w formacie RTF (skr. ang. Rich Text Format )

< kompilacja zbiorów pomocy do postaci .HLP (program

Microsoft Help Workshop)

PP-12(3 z 76)

Przygotowanie systemu pomocy

Wyœwietlanie wskazówek

we w³asnoœci Hint wpisaæ odpowiedni tekst,

we w³asnoœci ShowHint ustaliæ wartoœæ True
(domyœlnie jest False).

Przy aktywnoœci komponentu:

PP-12(4 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

w³asnoœæ HelpFile ,

metoda HelpCommand,

metoda HelpContext,

metoda HelpJump,

zdarzenie OnHelp.

Elementy typu TApplication (z modu³u Forms):

PP-12(5 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

W³asnoœæ HelpFile

property HelpFile : string

S³u¿y do okreœlenia nazwy domyœlnego zbioru
pomocy (podczas wykonywania programu), który
bêdzie u¿ywany przez program okienkowy do
wyœwietlania informacji (w okienku Help).
Domyœlnie wartoœæ tej w³asnoœci jest ³añcuchem
pustym, co oznacza brak zbioru pomocy skojarzonego
z programem.

PP-12(6 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Przyk³ad

Application.HelpFile:=’ENC_HELP.HLP’;

Alternatywny sposób (

statyczny

okreœlenie Help File na stronie Application polecenia
Project6Options w œrodowisku Delphi.

W³asnoœæ HelpFile

PP-12(7 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Metoda HelpCommand

function HelpCommand (Command : Word;

Data : Longint): Boolean;

Umo¿liwia szybki dostêp do dowolnego polecenia
funkcji WinHelp œrodowiska Windows (jest to funkcja
API, która wyœwietla okienko Help).
Polecenie okreœla siê za pomoc¹ parametru Command,
a parametr Data s³u¿y do przekazania dodatkowych
informacji (w zale¿noœci od wartosci parametru
Command).

PP-12(8 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Metoda HelpCommand

Uwaga:

Przed przes³aniem polecenia do funkcji  WinHelp
metoda  HelpCommand generuje zdarzenie  OnHelp.
Funkcja API  WinHelp zostanie wywo³ana tylko
wówczas, gdy nie okreœlono metody obs³ugi tego
zdarzenia lub w metodzie obs³ugi nast¹pi jej
wywo³anie.

Wartoœæ funkcji równa False oznacza, ¿e
z programem nie skojarzono ¿adnego zbioru pomocy.

PP-12(9 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Metoda HelpCommand

Wa¿niejsze wartoœci parametru Command (okreœla siê je za
pomoc¹ predefiniowanych sta³ych):

HELP_CONTEXT
– wyœwietlenie tematu pomocy okreœlonego przez

identyfikator kontekstu (wartoœæ parametru Data);
konteksty s¹ zdefiniowane w sekcji [MAP] zbioru .HPJ

HELP_CONTEXTPOPUP
– jw., tyle ¿e w okienku zstêpuj¹cym (ang. pop-up window)

PP-12(10 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

HELP_FORCEFILE
– sprawdzenie, czy jest wyœwietlany w³aœciwy zbiór pomocy

(skojarzony z danym programem) i jeœli nie, to wyœwietlenie
tego zbioru (wartoœæ parametru Data jest ignorowana)

Metoda HelpCommand

Wa¿niejsze wartoœci parametru Command (okreœla siê je za
pomoc¹ predefiniowanych sta³ych):

HELP_HELPONHELP
– wyœwietlenie informacji na temat u¿ywania systemu

pomocy w œrodowisku Windows, o ile jest w nim dostêpny
WINHELP.HLP (wartoœæ parametru Data jest ignorowana)

PP-12(11 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

HELP_FINDER
– wyœwietlenie skorowidza (indeksu) w okienku Help

(wartoœæ parametru Data jest ignorowana)

Metoda HelpCommand

Wa¿niejsze wartoœci parametru Command (okreœla siê je za
pomoc¹ predefiniowanych sta³ych):

HELP_QUIT
– „poinformowanie” systemu pomocy, ¿e nie jest dalej

potrzebny – œrodowisko Windows zamknie system pomocy
(wartoœæ parametru Data jest ignorowana)

PP-12(12 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Przyk³ad

Application.HelpCommand (HELP_FINDER, 0);

Metoda HelpCommand

PP-12(13 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Metoda HelpContext

function HelpContext (Context : THelpContext)

: Boolean;

Typ THelpContext jest zdefiniowany w module Classes:

type THelpContext = !MaxLongint .. MaxLongint;

Sta³a MaxLongint jest zdefiniowana w module System:

const MaxLongint = High(Longint);

Metoda ta wyœwietla temat pomocy o identyfikatorze
okreœlonym parametrem Context.

PP-12(14 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Metoda HelpContext

Uwaga:

Przed przes³aniem polecenia do funkcji WinHelp metoda

HelpContext generuje zdarzenie OnHelp. Funkcja API WinHelp zostanie
wywo³ana tylko wówczas, gdy nie okreœlono metody obs³ugi tego
zdarzenia lub w metodzie obs³ugi nast¹pi jej wywo³anie.

Wartoœæ funkcji równa False oznacza, ¿e z programem
nie skojarzono ¿adnego zbioru pomocy (wartoœci¹
w³asnoœci CurrentHelpFile jest ³añcuch pusty).

Uwaga:

W³asnoœæ CurrentHelpFile okreœla zbiór pomocy skojarzony

z aktywn¹ formatk¹. W programach z jedn¹ formatk¹ wartoœæ w³asnoœci
CurrentHelpFile jest równa wartoœci w³asnoœci HelpFile.

PP-12(15 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Przyk³ad

Metoda HelpContext

const DATANOTFOUND = 714;
...
Application.HelpContext (DATANOTFOUND);

PP-12(16 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Metoda HelpJump

function HelpJump (const JumpID : string)

: Boolean;

Metoda ta wyœwietla temat pomocy identyfikawany
przez swoj¹ symboliczn¹ nazwê.

Uwaga:

Przed przes³aniem polecenia do funkcji WinHelp

metoda HelpJump generuje zdarzenie OnHelp. Funkcja API
WinHelp zostanie wywo³ana tylko wówczas, gdy nie
okreœlono metody obs³ugi tego zdarzenia lub w metodzie
obs³ugi nast¹pi jej wywo³anie.

PP-12(17 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Wartoœæ funkcji równa False oznacza, ¿e z programem
nie skojarzono ¿adnego zbioru pomocy. Dok³adniej:
wartoœci¹ w³asnoœci CurrentHelpFile jest ³añcuch
pusty.

Metoda HelpJump

Przyk³ad

Application.HelpJump (’metoda_abstrakcyjna’);

PP-12(18 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Zdarzenie OnHelp

property OnHelp : THelpEvent
read FOnHelp write FOnHelp;

Typ THelpEvent jest zdefiniowany w module Forms:

type THelpEvent = function (Command : Word; Data : Longint;

var CallHelp : Boolean) : Boolean of object;

Wszystkie metody wywo³uj¹ce pomoc powoduj¹
najpierw wygenerowanie zdarzenia OnHelp.

Wartoœæ False metody obs³ugi zdarzenia OnHelp
oznacza, ¿e podczas jej wykonywania wyst¹pi³ b³¹d.

PP-12(19 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Programista mo¿e napisaæ w³asn¹ metodê obs³ugi
zdarzenia OnHelp.

Zdarzenie OnHelp

Jeœli wartoœci¹ parametru CallHelp bêdzie True, to po
wyst¹pieniu zdarzenia OnHelp nast¹pi wywo³anie
funkcji API WinHelp (dzia³anie jest wówczas takie
same, jak domyœlne, tj. przy braku metody
programisty obs³ugi tego zdarzenia).

PP-12(20 z 76)

Przygotowanie systemu pomocy

Do³¹czanie zbiorów pomocy i ich obs³uga

Zdarzenie OnHelp

Przyk³ad (zmiana zbioru pomocy dla aktywnej formatki przed wywo³aniem funkcji WinHelp)

function TForml.AppHelp (Command : Word;
Data : Longint;

var CallHelp : Boolean) : Boolean;

begin
Application.HelpFile:=Screen.ActiveForm.Name

+’.HLP’;

CallHelp:=True
end;
function TForml.FormCreate (Sender : TObject);
begin
Application.OnHelp:=AppHelp
end;

Zmienna globalna Screen (typu TScreen)
opisuje stan ekranu. Jej w³asnoœæ
ActiveForm (typu TForm) zawiera
informacjê o aktualnie aktywnej formatce,
a w³asnoœæ Name zawiera nazwê formatki.

Metoda AppHelp jest przypisana do obs³ugi zdarzenia
OnHelp podczas obs³ugi zdarzenia OnCreate dla formatki

PP-12(21 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy

tematy (ang. topics) pomocy nie musz¹ byæ zawarte w jednym
zbiorze pomocy (ang. help file),

zawartoœæ (ang.  contents) systemu pomocy jest przechowywana
w oddzielnym zbiorze, zwanym zbiorem zawartoœci (ang.  contents
file); przez do³¹czenie odpowiednich informacji do tego zbioru
mo¿na automatycznie dodaæ nowe rozdzia³y na stronie  Zawartoœæ
i nowe has³a na stronie  Indeks,

w zbiorze zawartoœci mo¿na okreœliæ skoki do tematów zawartych
w ró¿nych zbiorach pomocy,

w celu zabezpieczenia przed niekonsekwencjami w indeksie
(czasami, przypadkami, liczb¹ mnog¹, wielkimi literami itp.)
nale¿y w programie Help Workshop stosowaæ polecenie Report.

Planowanie systemu pomocy – uwagi:

PP-12(22 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy

rozmiar zbioru pomocy – 2 GB,

liczba tematów (hase³) w jednym zbiorze hase³ (.RTF)
– praktycznie bez ograniczeñ,

liczba tematów (hase³) w jednym zbiorze pomocy (.HLP)
– praktycznie bez, ograniczeñ,

liczba tematów (hase³) skojarzonych z jednym s³owem kluczowym
(ang. keyword) – 800,

d³ugoœæ przypisu dla jednego has³a – 16 383 znaki,

d³ugoœæ s³owa kluczowego – 255 znaków,

d³ugoœæ ukrytego tekstu wyœwietlanego po wyborze „punktów
zapalnych” (ang. hotspot) – 4 095 znaków,

Ograniczenia systemu pomocy:

PP-12(23 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy

d³ugoœæ tytu³u pomocy – 127 znaków,

d³ugoœæ tytu³u tematu (has³a) – 127 znaków (;),

d³ugoœæ ³añcucha „copyright” – 255 znaków,

liczba odwo³añ do rysunków (map bitowych) – 65 535 w jednym
zbiorze pomocy,

liczba elementów (ang. entries) w zbiorze zawartoœci
– praktycznie bez ograniczeñ,

liczba poziomów zag³êbienia nag³ówków zawartoœci – 9,

d³ugoœæ ³añcucha tematu zawartoœci – 255 znaków,

d³ugoœæ tekstu zawartoœci – praktycznie bez ograniczeñ.

Ograniczenia systemu pomocy:

PP-12(24 z 76)

Przygotowanie systemu pomocy

rzygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

otworzyæ nowy plik w dowolnym edytorze tekstów
(czytaj: w MS Word-zie ), który obs³uguje format RTF,

napisaæ poszczególne tematy, oddzielaj¹c je od siebie
sztywnym zakoñczeniem strony (ang. hard page break),

dodaæ odpowiednie przypisy na pocz¹tku ka¿dego
tematu,

zapisac plik w formacie RTF (zbiór dyskowy powinien
mieæ rozszerzenie nazwy .rtf).

Podstawowe czynnoœci:

PP-12(25 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

identyfikator tematu (#) – musi byc unikatowy i

jest

wymagany dla ka¿dego tematu

tytu³ tematu ($) – okreœla tytu³, który bêdzie wypisywany
dla danego tematu w okienkach Znalezione tematy
(Topics Found), Zak³adka (Bookmark) i Historia
(History),

s³owo kluczowe (K) – okreœla s³owo kluczowe (lub
s³owa), które bêdzie (bêd¹) wyœwietlane dla danego
tematu na stronie Indeks (Index) i u¿ywane
w makroinstrukcji KLink,

Przypisy (znaki identyfikuj¹ce) i ich znaczenia:

PP-12(26 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

A-s³owo kluczowe (A) – okreœla s³owo kluczowe
identyfikuj¹ce dany temat w makroinstrukcji ALink,

kod dla przegl¹darki (+) – definiuje lokalizacjê tematu
w sekwencji tematów przegl¹darki,

makroinstrukcja (!) – okreœla makroinstrukcjê, która
bêdzie wykonana, gdy u¿ytkownik spróbuje wyœwietliæ
dany temat,

Przypisy (znaki identyfikuj¹ce) i ich znaczenia:

PP-12(27 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

znacznik do³¹czenia (*) – okreœla dany temat jako
mo¿liwy do wy³¹czenia lub do³¹czenia do zbioru
pomocy,

rodzaj okienka (>) – okreœla domyœlny rodzaj okienka do
wyœwietlenia tematu.

Przypisy (znaki identyfikuj¹ce) i ich znaczenia:

PP-12(28 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu,

wprowadziæ znak # (symbol numeru) jako znak przypisu
(MS Word:W

staw 6Przypis6Znak niestandardowy),

wpisaæ identyfikator jako tekst przypisu uwzglêdniaj¹c,
¿e

< mo¿e on zawieraæ odstêpy, ale nie na pocz¹tku i nie na koñcu,
< nie mo¿e zawieraæ znaków #, =, +, @, *, % i !,
< maksymalna d³ugoœæ – 255 znaków,
< nie mo¿e rozpoczynaæ siê od liczby, jeœli bêdzie u¿ywany

w sekcji [MAP] zbioru projektowego.

Do³¹czenie identyfikatora tematu:

PP-12(29 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Do³¹czenie identyfikatora tematu:

Uwagi:

1) Program Help Workshop identyfikuje b³êdy

wystêpuj¹ce w tematach, jeœli ich identyfikatory
rozpoczynaj¹ siê od przedrostka IDH_ .

2) Jeœli wyœwietlenie tematu ma rozpocz¹æ siê od

pewnego miejsca (nie od pocz¹tku), nale¿y w tym
miejscu umieœciæ identyfikator.

PP-12(30 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu,

wprowadziæ znak $ (symbol dolara) jako znak
przypisu (MS Word: Wstaw6Przypis6Znak
niestandardowy),

wpisaæ tytu³ jako tekst przypisu.

Do³¹czenie tytu³u tematu:

Uwaga: Tytu³ mo¿e mieæ do 255 znaków (³¹cznie

z ewentualnymi odstêpami).

PP-12(31 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu,

wprowadziæ literê A jako znak przypisu (MS Word:
Wstaw6Przypis6Znakn iestandardowy),

wpisaæ jedno lub wiêksz¹ liczbê s³ów kluczowych jako
tekst przypisu uwzglêdniaj¹c, ¿e

< s³owa te powinny byæ oddzielone œrednikami,
< odstêpy przed i za tymi s³owami s¹ usuwane,
< maksymalna d³ugoœæ jednego s³owa – 255 znaków,
< ¿adne s³owo nie mo¿e zawieraæ znaku CR (znak steruj¹cy

– powrót karetki).

Zaznaczenie tematu jako obiektu ALink:

PP-12(32 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Zaznaczenie tematu jako obiektu ALink:

Uwagi:

1) Tematy, dla których okreœlono przypis A s¹

uwzglêdniane przez makroinstrukcjê ALink.

2) W s³owach kluczowych ma³e i wielkie litery s¹

rozró¿nialne, ale program Help Workshop traktuje
dwa s³owa kluczowe rozni¹ce siê tylko ma³ymi
i wielkimi literami jako identyczne i sygnalizuje
b³¹d typu ostrze¿enia.

PP-12(33 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu,

wprowadziæ literê K jako znak przypisu (MS Word:
Wstaw6Przypis6Znakn iestandardowy),

wpisaæ jedno lub kilka s³ów jako tekst przypisu
uwzglêdniaj¹c, ¿e

< s³owa powinny byæ oddzielone œrednikami,
< odstêpy przed i za s³owami s¹ usuwane,
< maksymalna d³ugoœæ pojedynczego s³owa – 255 znaków,
< ¿adne s³owo nie mo¿e zawieraæ znaku CR (znak steruj¹cy

– powrót karetki).

Okreœlenie s³owa kluczowego dla indeksu:

PP-12(34 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Okreœlenie s³owa kluczowego dla indeksu:

Uwagi:

1) S³owa kluczowe podane w przypisie K s¹ te¿

uwzglêdniane przez makroinstrukcjê KLink.

2) W s³owach kluczowych ma³e i wielkie litery s¹

rozro¿nialne, ale program Help Workshop traktuje
dwa s³owa kluczowe ró¿ni¹ce siê tylko ma³ymi
i wielkimi literami jako identyczne i sygnalizuje
b³¹d typu ostrze¿enia.

PP-12(35 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

w przypisie K dla danego tematu napisaæ s³owo
kluczowe dla pierwszego poziomu zakoñczone
œrednikiem (;),

po œredniku napisaæ jeszcze raz to s³owo, a nastêpnie
przecinek (,) lub dwukropek (:), po czym odstêp, s³owo
kluczowe dla drugiego poziomu i œrednik.

Utworzenie drugiego poziomu indeksu:

Uwagi: 1) W indeksie s³owa kluczowe na drugim poziomie

s¹ zawsze wyœwietlane alfabetycznie (bez
wzglêdu na ich kolejnoœæ w przypisie).

2) Odstêpy przed i po s³owach s¹ usuwane.

PP-12(36 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Utworzenie drugiego poziomu indeksu:

Przyk³ad

Postac przypisu:

jêzyk; jêzyk, Pascal; jêzyk, C++; jêzyk, Basic; jêzyk, Java

Postaæ w indeksie:

jêzyk
    Basic
    C++
    Java
    Pascal

PP-12(37 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu,

wprowadziæ znak + (plus) jako znak przypisu (MS Word:
Wstaw6Przypis6Znakn iestandardowy),

wpisaæ kod jako tekst przypisu uwzglqdniaj¹c, ¿e

< kod nie mo¿e zawieraæ odstêpów i znaków #, =, +, @, *-, % i !,
< maksymalna d³ugoœæ kodu – 50 znaków.

Lokalizacja tematu w przegl¹darce:

PP-12(38 z 76)

Przygotowanie systemu pomocy

rzygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Lokalizacja tematu w przegl¹darce:

Uwagi:

1) U¿ycie sekwencji wymaga okreœlenia aktywnoœci przycisku

przegl¹darki w zbiorze projektowym.

2) Funkcja WinHelp tworzy automatycznie sekwencjê przegl¹dania, jeœli

tylko dla danego tematu okreœlono przypis +, choæ nie podanego
¿adnego kodu.

3) Jeœli kody okreœla siê za pomoc¹ liczb, to nale¿y uwzglêdniaæ

nieznacz¹ce zera (np. 001, 002 itd.).

4) U¿ycie takich samych nazw (ale nie liczb) dla oznaczenia kodu

w ka¿dym przypisie + powoduje automatyczne utworzenie sekwencji
przegl¹dania w takiej samej kolejnoœci, w jakiej tematy wystêpuj¹
w zbiorze .rtf.

PP-12(39 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu i

przed

wszystkimi innymi znakami przypisów

wprowadziæ znak * (plus) jako znak przypisu (MS Word:
Wstaw6Przypis6Znakn iestandardowy),

wpisaæ znacznik (ci¹g znaków) lub znaczniki
(oddzielone œrednikami) jako tekst przypisu.

Zaznaczenie tematu do ewentualnego usuniêcia:

PP-12(40 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Zaznaczenie tematu do ewentualnego usuniêcia:

Uwagi:

1) W znacznikach ma³e i wielkie litery nie s¹ rozró¿nialne.

2) Tematy do usuniêcia okreœla siê w zbiorze projektowym

(.hpj).

3) Tematy bez znaczników ewentulnego usuniêcia oraz tematy

z takimi znacznikami, ale nie wymienione w zbiorze .hpj s¹
zawsze uwzglêdniane w zbiorze pomocy.

PP-12(41 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu,

wprowadziæ znak > (znak wiêkszoœci) jako znak przypisu
(MS Word: Wstaw6Przypis6Znakn iestandardowy),

wpisaæ nazwê rodzaju okienka (jak w zbiorze
projektowym).

Okreœlenie domyœlnego rodzaju okienka
do wyœwietlenia tematu:

Uwagi:

1) Przypis okreœla rodzaj okienka u¿ywany przy wyœwietlaniu

tematu po jego wyborze na stronie Indeks, ZnajdŸ i za
pomoc¹ makroinstrukcji ALink i KLink.

2) Rodzaj okienka musi byæ okreœlony w zbiorze .hpj.

PP-12(42 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor na pocz¹tku tematu,

wprowadziæ znak! (wykrzyknik) jako znak przypisu (MS
Word: Wstaw6Przypis6Znakn iestandardowy),

wpisaæ identyfikator makroinstrukcji (w przypadku kilku
makroinstrukcji oddzielamy je œrednikami).

Okreœlenie makroinstrukcji
wykonywanej przed wyœwietleniem tematu:

PP-12(43 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

upewniæ siê, ¿e akapity, które nie maj¹ byæ przesuwane
znajduj¹ siê na pocz¹tku tekstu tematu,

zaznaczyæ akapity nieprzesuwalne i zastosowaæ do nich
styl Razem z nastêpnym (Keep with next) (MS Word:
Format6Akapit i na stronie Podzia³ wiersza i strony
w³¹czyæ opcjê Razem z nastêpnym – zob. rysunek).

Okreœlenie nieprzesuwalnego obszaru tekstu tematu
(wykorzystywane, gdy tekst tematu ma swój tytu³):

PP-12(44 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Okreœlenie
nieprzesuwalnego
obszaru tekstu tematu
(wykorzystywane,
gdy tekst tematu
ma swój tytu³):

ten parametr

nale¿y w³¹czyæ

warto te¿ w³¹czyæ

ten parametr

PP-12(45 z 76)

Przygotowanie systemu pomocy

rzygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

Okreœlenie nieprzesuwalnego obszaru tekstu tematu
(wykorzystywane, gdy tekst tematu ma swój tytu³):

Uwagi:

1) U¿ytkownik ma mo¿liwoœæ skopiowania lub wydrukowania albo

obszaru przesuwalnego, albo nieprzesuwalnego (ale nie obydwu).
Jeœli jednak przy wyborze tematu zostanie nacisniêty prawy klawisz
myszki i wybrane (w wyœwietlonym menu kontekstowym) polecenie
Kopiuj, to zostan¹ skopiowane obydwa obszary.

2) Obszarów przesuwalnych i nieprzesuwalnych nie wolno okreœlaæ dla

tematów, które bêd¹ wyœwietlane w okienkach pop-up.

3) Obszary przesuwalne i nieprzesuwalne mog¹ mieæ ró¿ne kolory t³a

(okreœla siê to w zbiorze projektowym).

PP-12(46 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – tworzenie zbioru tematów (hase³)

umiejscowiæ kursor w dowolnym miejscu akapitu, którego
wiersze nie maj¹ byæ przenoszone do nastêpnych wierszy,

zastosowaæ do tego akapitu styl Wiersze akapitu razem
(Keep lines together) (MS Word: Format6Akapit i na
stronie Podzia³ wiersza i strony w³¹czyæ opcjê Wiersze
akapitu razem).

Zabezpieczenie przed przenoszeniem tekstu
do nastêpnego wiersza:

Uwaga: Jeœli tekst akapitu jest za szeroki do wyœwietlenia

w okienku, funkcja WinHelp spowoduje dodanie
poziomej poprzeczki do przesuwania zawartoœci.

PP-12(47 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie tematów

umiejscowiæ kursor bezpoœrednio za tekstem lub map¹
bitow¹, która ma byæ miejscem wyboru („punktem
zapalnym” – ang. hotspot) i napisaæ identyfikator tematu,
do którego ma nast¹piæ skok,

zaznaczyæ dany tekst lub mapê bitow¹, po czym zastosowaæ
do tego elementu:

< styl podwójnego podkreœlenia znaków (MS Word:

Format6Czcionka i na stronie Czcionka w okienku listowym
Podkreœlenie wybraæ element Podwójne – zob. rysunek),

Skok do tematu wyœwietlonego w zwyk³ym okienku
lub okienku pop-up:

PP-12(48 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie tematów

Skok do tematu
wyœwietlonego
w zwyk³ym okienku
lub okienku pop- up:

tu wybraæ styl

podkreœlenia

PP-12(49 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie temtów

< styl pojedynczego podkreœlenia znaków (MS Word:

Format6Czcionka i na stronie Czcionka w okienku listowym
Podkreœlenie wybraæ element Pojedyncze),

zaznaczyæ identyfikator tematu i wybraæ dla niego styl
ukrycia znaków (MS Word: Format6Czcionka i na stronie
Czcionka zaznaczyæ opcjê Ukrycie – zob. rysunek).

Skok do tematu wyœwietlonego w zwyk³ym okienku
lub okienku pop-up:

PP-12(50 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie tematów

Skok do tematu
wyœwietlonego
w zwyk³ym okienku
lub okienku pop- up:

ten parametr

nale¿y w³¹czyæ

PP-12(51 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie tematów

Skok do tematu wyœwietlonego w zwyk³ym okienku
lub okienku pop-up:

Przyk³ad

Object Pascal IDH_0981

Uwagi:

Wyœwietlenie hotspot w domyœlnym kolorze (ró¿nym od zielonego)
– wpisac * na pocz¹tku identyfikatora tematu: *IDH_0981

Wyœwietlenie hotspot w domyœlnym kolorze (ró¿nym od zielonego) bez
podkreœlenia – wpisac % na pocz¹tku identyfikatora tematu: %IDH_0981

3) Skok do tematu w innym zbiorze pomocy – wpisac @ i nazwê zbioru na

koñcu identyfikatora tematu: IDH_0981@INNYPLIK.HLP

4) Wyœwietlenie tematu, do którego nastêpuje skok w innym rodzaju

okienka – wpisac > i nazwê rodzaju okienka na koñcu identyfikatora
tematu: IDH_0981>okienko2

PP-12(52 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie tematów

umiejscowiæ kursor bezpoœrednio za tekstem lub map¹
bitow¹, która ma byæ miejscem wyboru („punktem
zapalnym” – ang. hotspot) i napisaæ ! (wykrzyknik),

po wykrzykniku napisaæ makroinstrukcjê (jeœli
specyfikuje siê kilka instrukcji, to ka¿de dwie pownny
byæ oddzielone dwukropkiem lub œrednikiem),

zaznaczyæ hotspot i zastosowaæ do niego styl
podwójnego podkreœlenia znaków (MS Word:
Format6Czcionka i na stronie Czcionka w okienku
listowym Podkreœlenie wybraæ element Podwójne),

Dodanie hotspot wykonuj¹cego makroinstrukcjê:

PP-12(53 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie tematów

zaznaczyæ wykrzyknik i makropolecenie oraz
zastosowaæ do nich styl ukrytych znaków (MS Word:
Format6Czcionka i na stronie Czcionka zaznaczyæ opcjê
Ukrycie).

Dodanie hotspot wykonuj¹cego makroinstrukcjê:

Przyk³ad

jêzyk programowania !ALink(Pascal;Basic;C)

(generowanie listy tematów zawieraj¹cych A-s³owa kluczowe)

PP-12(54 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – do³¹czanie rysunków

umiejscowiæ kursor w miejscu, w którym ma wyst¹piæ rysunek,

jeœli rysunek ma byæ do³¹czony tylko raz, to wykonaæ polecenia
Kopiuj i Wklej, a gdy wiele razy – utworzyæ po³¹czenie z rysunkiem
za pomoc¹ instrukcji

{bmx nazwa-zbioru.bmp}
gdzie x oznacza jedn¹ (lub dwie) z poni¿szych liter:
c – do³¹czenie rysunku w taki sam sposob, jak znaku,
l – do³¹czenie rysunku przy lewym marginesie,
r – do³¹czenie rysunku przy prawym marginesie,
t – mo¿e byæ u¿yte z ka¿d¹ z powy¿szych liter i oznacza

przekszta³cenie bia³ych pikseli rysunku w kolor najbli¿szy
kolorowi t³a okienka (mo¿e byæ zastosowane tylko dla map
bitowych o 16 kolorach).

Do³¹czenie rysunku (mapy bitowej) do tematu:

PP-12(55 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – do³¹czenie filmu wideo

umiejscowiæ kursor w miejscu, w którym ma wyst¹piæ
zbiór mulimedialny,

utworzyæ po³¹czenie ze zbiorem za pomoc¹ instrukcji

{mci nazwa-zbioru}
gdzie nazwa-zbioru oznacza pe³n¹ nazwê
(z rozszerzeniem) dodawanego zbioru.

Do³¹czenie filmu wideo lub animacji:

Uwagi: 1) Ogólna postaæ instrukcji mci

{mci[_left | _right] [ opcje,] nazwa-zbioru}

2) Do³¹czane zbiory multimedialne powinny byæ
zapisane w formacie AVI (.avi).

PP-12(56 z 76)

Przygotowanie systemu pomocy

Przygotowanie zbiorów pomocy – ³¹czenie tematów

Do³¹czenie filmu wideo lub animacji:

Parametr opcje okreœla opcje tworzonego okienka multimedialnego
(poszczególne opcje oddziela siê odstêpami):

EXTERNAL

– zewnêtrzny zbiór multimedialny (nie bêdzie

do³¹czony do zbioru pomocy),

NOPLAYBAR

– brak wyœwietlania panelu steruj¹cego odtwarzaniem

(u¿yteczne przy autoodtwarzaniu i powtarzaniu
odtwarzañ),

NOMENU

– brak przycisku Menu w panelu steruj¹cym,

REPEAT

– automatyczne powtarzanie odtwarzania,

PLAY

– rozpoczêcie odtwarzania zaraz po wyœwietleniu

tematu.

Przyk³ad

{mci PLAY, demo.avi}

PP-12(57 z 76)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

uruchomiæ program Help Workshop (po
standardowej instalacji pakietu Delphi: katalog
Help 6 katalog Tools 6 hcw)

zainicjowaæ polecenie File6New i w wyœwietlonym
okienku wybraæ rodzaj zbioru Help Project ,

w kolejnym okienku wpisaæ nazwê zbioru (.hpj)
i wybraæ przycisk Zapisz (OK).

Podstawowe czynnoœci:

PP-12(58 z 76)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

Uwagi:

1) Program Help Workshop domyœlnie przyjmuje

minimalne ustalenia wymagane do utworzenia
zbioru pomocy. U¿ytkownik musi jednak okreœliæ
co najmniej jeden zbiór tematów (.rtf).

2) W celu ponownego zredagowania istniej¹cego

zbioru projektowego nale¿y zainicjowaæ polecenie
File6Open.

PP-12(59 z 76)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Bitmaps,

w wyœwietlonym okienku wybraæ przycisk Add
i wpisaæ nazwê katalogu z rysunkami.

Okreœlenie lokalizacji rysunków:

Uwaga:

Domyœlnie przyjmuje siê, ¿e rysunki znajduj¹ siê
w katalogu, w którym jest zapisany zbior
projektowy.
Nastêpnie poszukuje siê ich w katalogu bie¿¹cego
zbioru tematów, po czym w katalogach z innymi
zbiorami .rtf do³¹czonymi do projektu.

PP-12(60 z 76)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Options,

w wyœwietlonym okienku na stronie General
w podokienku wejœciowym Help title wpisaæ tytu³.

Okreœlenie tytu³u zbioru pomocy
(jest on wyœwietlany na poprzeczce z tytu³em okienka po
napisie Tematy Pomocy: lub Help Topics:):

Uwaga:

Tytu³ mo¿e mieæ do 127 znaków.

PP-12(61 z 76)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Options,

w wyœwietlonym okienku na stronie Compression
w³¹czyæ parametr Maximum.

Okreœlenie sposobu kompresji:

Uwaga:

Pozostawienie domyœlnego ustalenia (w³¹czony

            parametr  None) powoduje, ¿e w okienkach
            systemu pomocy nie bêd¹ wyœwietlane polskie
            litery.

PP-12(62 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Options i w wyœwietlonym okienku
przejœæ na stronê Macros,

na stronie tej wybraæ przycisk Add i w trzech podokienkach
wyœwietlonego okienka wpisaæ odpowiednie ustalenia.

Wykonanie makroinstrukcji
wskutek wyboru tematu do wyœwietlenia:

PP-12(63 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Windows,

w wyœwietlonym okienku przejœæ na stronê Buttons,

w podokienku listowym Window type wybraæ rodzaj
okienka,

w³¹czyæ opcjê Browse w zbiorze opcji Buttons.

Dodanie przycisków przegl¹dania
w okienku do wyœwietlania tekstów tematów:

PP-12(64 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Options,

w wyœwietlonym okienku na stronie Files w podokienku
wejœciowym Contents file wpisaæ nazwê zbioru .cnt.

Skojarzenie zbioru zawartoœci (.cnt) ze zbiorem pomocy:

PP-12(65 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Windows,

jeœli w wyœwietlonym okienku ( Window Properties) na
stronie General w podokienku listowym Windows type nie
ma elementu main, to wybraæ przycisk Add na tej stronie,

po wyœwietleniu kolejnego okienka wpisaæ w nim main,
po czym wybrac przycisk OK,

na ró¿nych stronach (General, Position, Buttons, Color
i Macros) okienka Window Properties ustaliæ ró¿ne
specyfikacje wed³ug w³asnych wymagañ.

Zmiana charakterystyk g³ównego okienka systemu pomocy:

PP-12(66 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Windows,

w wyœwietlonym okienku na stronie General w podokienku
wejœciowym Window type wybraæ rodzaj okienka,

w zestawie parametrów opcjonalnych Window attributes
zaznaczyæ opcjê Keep Help window on top.

Domyœlne pozostawienie okienka pomocy na wierzchu:

Uwaga:

U¿ytkownik systemu pomocy mo¿e zmieniæ to ustalenie
naciskaj¹c prawy klawisz myszki (podczas wyœwietlania
okienka pomocy) i wy³¹czaj¹c w wyœwietlonym menu
kontekstowym opcjê Keep Help On Top.

PP-12(67 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Options,

w wyœwietlonym okienku na stronie Sorting wybraæ
w³aœciwy jêzyk w podokienku listowym Language of Help
file.

Okreœlenie jêzyka zbioru pomocy:

PP-12(68 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

wybraæ przycisk Options,

w wyœwietlonym okienku na stronie General w obszarze
Copyrighti nformation wpisaæ odpowiednie informacje
w dwóch podokienkach wejœciowych:

< pierwsze podokienko dotyczy informacji wyœwietlanej w okienku

Wersja (Version), które ukazuje siê na ekranie po wyborze przez
u¿ytkownika polecenia Pomoc6Wersja (Help6Version) w menu
okienka pomocy,

< drugie podokienko dotyczy tekstu dodawanego przy kopiowaniu

lub drukowaniu tekstu z systemu pomocy.

Do³¹czenie informacji o prawie „copyright”:

PP-12(69 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru projektowego

Do³¹czenie informacji o prawie „copyright”:

Uwagi:

1) Dla okienka Wersja tekst mo¿e sk³adaæ siê maksymalnie

z 255 znakow.

2) Dla tekstu dodawanego przy kopiowaniu lub drukowaniu

tekstu z systemu pomocy nie ma ograniczen d³ugoœci.

3) Wyst¹pienie napisu %date na koñcu tekstu przeznaczonego

dla okienka Wersja powoduje podstawienie w tym miejscu
daty kompilacji zbioru pomocy.

PP-12(70 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru zawartoœci

zainicjowaæ polecenie File6New i w wyœwietlonym
okienku wybraæ rodzaj zbioru Help Contents (okno
programu Help Workshop przyjmie postaæ przedstawion¹
na rysunku),

w okienku wejœciowym Default filename wpisaæ nazwê
zbioru pomocy (jeœli zbiór zawartoœci obejmuje kilka
zbiorów pomocy, to nale¿y wpisaæ nazwê jednego z nich
– zwykle podaje siê nazwê zbioru z najwiêksz¹ liczb¹
tematów),

Podstawowe czynnoœci:

PP-12(71 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru zawartoœci

w okienku wejœciowym Default title wpisaæ tytu³, który ma
byæ wyœwietlany na poprzeczce z tytu³em okienka pomocy
– po napisie Tematy Pomocy: (Help Topics:),

wybraæ przycisk Add Above lub Add Below w celu dodania
nag³ówka (tytu³ rozdzia³u) lub tutu³u tematu, który bêdzie
wyœwietlany na stronie Zawartoœæ (Contents) okienka
systemu pomocy.

Podstawowe czynnoœci:

Uwaga:

Jeœli w okienku pomocy na stronie Indeks (Index) maj¹ byæ
wyœwietlane tematy (has³a) z kilku zbiorów pomocy, to nale¿y
wybraæ przycisk Index Files i wpisaæ wszystkie dodatkowe
zbiory.

PP-12(73 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru zawartoœci

dodanie nowego nag³ówka

< zaznaczyæ element (nag³ówek lub tytu³ tematu), nad którym lub pod którym

zamierzamy dodaæ nowy nag³ówek,

< wybraæ przycisk Add Above lub Add Below,
< w wyœwietlonym okienku w³¹czyæ parametr Heading,
< w podokienku Title wpisaæ tekst nag³ówka,

ustalenie poziomu nag³ówka

< zaznaczyæ nag³ówek,
< wybraæ przycisk Move Right lub Move Left (mo¿na ustaliæ do 9 poziomów),

usuniêcie nag³ówka

< zaznaczyæ nag³ówek,
< wybraæ przycisk Remove.

Redagowanie nag³ówków:

PP-12(74 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru zawartoœci

dodanie nowego tytu³u

< zaznaczyæ element (nag³ówek lub tytu³ tematu), nad którym lub pod którym

zamierzamy dodaæ nowy tytu³,

< wybraæ przycisk  Add Above lub Add Below,
< w wyœwietlonym okienku w³¹czyæ parametr  Topic,
< w podokienku  Title wpisaæ tekst tytu³u,
< w podokienku  Topic ID wpisaæ identyfikator tytu³u,
< gdy w podokienkach  Help file i Window type  nie wpisze siê informacji,

zak³ada siê domyœlny zbiór pomocy i rodzaj okienka okreœlony w tym
zbiorze,

ustalenie poziomu tytu³u i jego usuniêcie – jak w przypadku
nag³ówka.

Redagowanie tytu³ów tematów:

PP-12(75 z 77)

Przygotowanie systemu pomocy

Tworzenie zbioru zawartoœci

wybraæ przycisk Tabs,

w wyœwietlonym okienku wybrac przycisk Add,

w kolejnym wyœwietlonym okienku wpisaæ

< tytu³ strony w podokienku wejsciowym Tab name,
< nazwê zbioru z bibliotek¹ DLL zawieraj¹c¹ procedurê

obs³ugi strony (zob. Writing DLLs for WinHelp
w systemie pomocy programu Help Workshop).

Dodanie nowej strony do okienka pomocy:

PP-12(76 z 77)

Document Outline