Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 1 Programowanie Wizualno Obiektowe Zajęcia 6, część 1 Temat: Zadanie:. Dołączanie plików pomocy do programu. Program umożliwia odczyt, edycję i zapis pliku tekstowego. Do programu utworzyć plik pomocy i umożliwić jego obsługę. Rysunek 5.1. Postać interfejsu użytkownika dla programu 5_1
Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 2 1. Otwieramy nowa aplikację File>NewApplication 2. Zapisujemy projekt przy pomocy File>Save All w katalogu gdzie będzie kompilowany nasz projekt 3. Dodajemy odpowiednie komponenty w kolejności Komponent głównego menu TMainMenu. Komponent wybierający plik do zapisu rysunku TSaveDialog. Komponent wybierający plik do odczytu rysunku TOpenDialog. Komponent z polem edycyjnym TRichEdit. Komponent paska statusu TStatusBar. 4. Do głównego menu dodać następujące opcje Plik o Otwórz o Zamknij Pomoc Koniec 5. Dodać jeden panel do paska statusu, na panelu należy wypisywać nazwę edytowanego pliku. 6. Tworzenie pliku pomocy Do tworzenia plików pomocy w systemie Windows można wykorzystać różnego typu edytory. Plik pomocy w systemie Windows ma rozszerzenie hlp. Oprogramowanie komercyjne Fore Help, firmy Fore Front, Inc. (http://www.ff.com/) Robo Help, firmy Blue Sky Software (http://www.blue-sky.com) Oprogramowanie darmowe: Microsoft Help Workshop, dostarczany z oprogramowaniem Borland C ++ Builder (katalog: C:\Project Files\Borland\CBuilder6\Help\Tools), shareware Help Scribble, firmy JG Soft (http://www.helpscribble.com), shareware Help Creator, firmy Breit Technologies (http://www.breittechnologies.com), freeware Na zajęciach zostanie omówione korzystanie z programu HelpCreator, który w zupełności wystarczy do stworzenia prostego pliku pomocy.
Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 3 6.1 Uruchomić program Help Creator. Rysunek 5.2. Postać interfejsu programu Windows Help Creator firmy Breit Technologies. Projekt pliku pomocy składa się z odpowiednich stron (ang. pages projektowanych w formacie.rtf), do których odnośniki znajdują się w spisie treści (ang. table of contents). Z każdą ze stron powiązane są odpowiednie rysunki wklejane następnie na stronę, oraz linki (do innych stron pomocy, do stron internetowych, do wysyłania e-maili). 6.2 Na początku należy utworzyć nowy projekt wybierając opcje Project -> Help File Name, i wpisać w pole edycyjne nazwę projektu pliku.hlp w którym będzie zapisany plik pomocy np. EdytorHlp.hlp Rysunek 5.2. Tworzenie nowego projektu. Ustawić opcje dotyczące piku pomocy, czyli położenie kolejnych stron pomocy na ekranie oraz ich rozmiar wybierając Project->Help Window Position / Size. Aby użytkownikowi było łatwo korzystać z pomocy najlepiej ustawić położenie lewego górnego rogu strony pomocy w lewym górnym rogu ekranu (left=0, top=0). Rozmiar okna najlepiej ustawić tak, aby mieściły się na im wszystkie rysunki dodawane do plików tekstowych (np. width=400, height=400).
Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 4 Rysunek 5.2. Ustawianie opcji stron pomocy. 6.3 Utworzyć kolejne strony pliku pomocy. Strony pomocy należy stworzyć zarówno do najważniejszych opcji programu, jak i do opisu w jaki sposób należy korzystać z programu. Stronę tworzy się wybierając opcje Page->Add, a następnie podając charakterystyczna nazwę dla strony pomocy. Rysunek 5.2. Tworzenie nowej strony pomocy Następnie korzystając z prostego edytora tekstu zawartego w programie Help Creator, należy utworzyć stronę pomocy. W przypadku opisywania opcji programu istotne jest oprócz podawania skrótu klawiszowego, podanie także skrótu z paska przycisków szybkiego dostępu (jeśli taki istnieje). Każda ze stron ma odpowiednie własności, które są wykorzystywane przez spis treści oraz przez program, do którego dodawany jest utworzony plik pomocy. Modyfikuje się te własności wybierając opcję Page->Properties dla każdej strony pliku pomocy. Własności te to: Name nazwa strony pliku pomocy, wykorzystywana przez projekt pliku pomocy. Context ID Jest to liczba tzw. identyfikator kontekstu, która może być wykorzystana do odnoszenia się do strony pomocy z programu, do którego ta pomoc jest dodana (wartość opcjonalna). Topic ID Jest to liczba tzw. Identyfikator tematu, który ma unikalna wartość i służy do odnoszenia się do danej strony z wewnątrz projektu (wartość wymagana). Topic title Tytuł strony wewnątrz pliku pomocy. Index Keywords Są to słowa kluczowe, lub frazy związane z dana stroną, które znajdą się w indeksie słów kluczowych. Słowa kluczowe należy oddzielać średnikiem.
Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 5 6.4 W tekst strony pomocy nie można bezpośrednio wklejać obrazków. Należy je najpierw dodać do zbioru obrazków związanych z dana stroną pomocy, a następnie dodać w tekście. Dodatkowo ograniczeniem jest format rysunków, muszą być to bitmapy z rozszerzeniem bmp. Rysunki (np. zrzuty okienek z ekranu) najlepiej tworzyć wykorzystując program Paint. Rysunki warto zapisywać w tym samym katalogu, w którym będzie tworzony plik pomocy. Dodawanie obrazków do danej strony pliku pomocy wykonuje się wybierając opcję Pictures->Add i wybierając odpowiedni rysunek. Rysunek jest wtedy dodawany do listy plików z rysunkami skojarzonymi z daną stroną pomocy. Dodawanie rysunków w tekście na stronie wykonuje się zaznaczając odpowiedni rysunek na liście rysunków skojarzonych ze stroną i wybierając opcję Pictures->Insert at Cursor. Jest on wtedy dodawany w miejscu gdzie aktualnie znajduje się kursor w tekście. 6.5 Dodawanie linków do danej strony pliku pomocy wykonuje się wybierając opcję Links->Add i wybierając odpowiedni rysunek. Rysunek jest wtedy dodawany do listy linków wykorzystywanych przez daną stroną pomocy. Dodawanie linków w tekście na stronie wykonuje się zaznaczając odpowiedni link na liście linków skojarzonych ze stroną i wybierając opcję Links->Insert at Cursor. Jest on wtedy dodawany w miejscu gdzie aktualnie znajduje się kursor w tekście. Istnieją trzy typy linków wykorzystywanych w pliku pomocy. Ich własności modyfikuje się zaznaczając link i wybierając opcję Links->Properties. Link To Topic In File Odsyłacz do określonego tematu w pliku, należy wtedy podać nazwę strony pliku pomocy która ma się otworzyć po kliknięciu na link. Open External URL Odsyłacz do strony internetowej. Należy wtedy podać adres URL. Open New External E-Mail Odsyłacz do poczty e-mail. Należy wtedy podać adres e- mail. Inne własności to Link Name nazwa linku wykorzystywana w liście linków. Link Text podświetlony tekst pokazujący się na stronie.
Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 6 Rysunek 5.2. Modyfikacja własności linków 6.6 Utworzenie spisu treści dla pliku pomocy i skojarzenie go z utworzonymi stronami pomocy należy wykonać używając opcji Project->Table of Contents. Spis treści podzielony jest na Grupy (ang. group) z daną grupą połączona jest lista grup i tematów, natomiast nie może być połączona strona pliku pomocy. Tematy (ang. topic) z danym tematem nie mogą być połączone inne tematy i grupy, ale może być połączona strona pliku pomocy. Rysunek 5.2. Okno do tworzenia spisu treści Aby dodać nową grupę do spisu treści należy wybrać opcję Item->Add New Group.
Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 7 Rysunek 5.2. Okno do tworzenia nowej grupy w spisie treści. Aby dodać nowy temat do spisu treści należy wybrać opcję Item->Add New Topic. Rysunek 5.2. Okno do tworzenia nowego tematu w spisie treści. Aby skasować grupę tematów lub temat należy wybrać opcję Item->Delete Group/Topic. Odpowiednie właściwości grupy określa się wybierając opcję Item->Properties i są to: Group Name - nazwa grupy Rysunek 5.2. Okno do modyfikacji własności grupy. Odpowiednie właściwości tematu określa się wybierając opcję Item->Properties i są to: Topic Name - nazwa tematu. Page To Link To nazwa strony, do której dana grupa/temat ma się odnosić. Rysunek 5.2. Okno do modyfikacji własności tematu. 6.7 Po utworzeniu wszystkich stron i spisu treści należy utworzyć plik pomocy. W tym celu należy wybrać opcję Project -> Make the Help File. Wtedy plik pomocy zapisany jest w pliku o rozszerzeniu.hlp. 7. Aby dodać plik pomocy do aplikacji tworzonej w środowisku Borland C++ Builder, należy wybrać następującą opcję: Project->Options->Application->Help File, i wpisać w pole edycyjne nazwę pliku pomocy. Najlepiej, żeby plik ten znajdował się w tym samym katalogu, co aplikacja. Wtedy nie trzeba podawać pełnej ścieżki dostępu a jedynie nazwę pliku, z rozszerzeniem hlp.
Programowanie Wizualno Obiektowe - zajęcia 6 (PWO_BCPP_6_1) 8 8. Aby wywołać plik pomocy z aplikacji najlepiej ustawić odpowiednia akcje i ją zaprogramować. W tym celu należy wykorzystać komponent TActionList i stworzyć nową akcję, tym razem wybierając ją z listy akcji standardowych np. HelpContents wywołując opcję Action List->New Standard Action->HelpContents. Kod do wyświetlania pliku pomocy jest następujący: void fastcall TForm1::HelpContents1Execute(TObject *Sender) { //wyswietlenie okna dialogowego pomocy const static int HELP_TAB = 15; //wyswietlenie spisu tresci const static int CONTENTS_ACTIVE = -3; Application->HelpCommand(HELP_TAB, CONTENTS_ACTIVE); } Akcję HelpContents należy następnie skojarzyć z odpowiednim przyciskiem na pasku skrótów, oraz w menu głównym programu, poprzez zmianę własności Action. 9. Oprócz wywoływania całego spisu treści pliku pomocy przy pomocy akcji, można też skojarzyć oddzielną stronę pliku pomocy z odpowiednią opcją/elementem programu. Przydaje się to tego identyfikator pomocy kontekstowej Context ID, którego wartość jest ustawiana w projekcie w programie Help Creator dla każdej strony. Aby skojarzyć element z odpowiednią stroną należy we własność HelpContext danego elementu wpisać wartość identyfikatora pomocy kontekstowej Context ID skojarzonej z nim strony.