Design and Implementation of a Context-Sensitive Help System for a Qt Application

Työn tavoitteena on suunnitella kontekstisensitiivinen ohjejärjestelmä automaatiojärjestelmän konfigurointiin ja ohjaamiseen käytettävään PC-työpöytäsovellukseen. Kontekstisensitiivinen ohjejärjestelmä tarjoaa ohjeita käyttäjälle sovelluksen tilaan perustuen. Ohjejärjestelmän perimmäisenä tavoitteena on auttaa sovelluksen käyttäjiä suoriutumaan työstään mahdollisimman helposti ja tehokkaasti. Kohdesovellus on toteutettu Qt-ohjelmistokehystä käyttäen ja samoin toteutettava ohjejärjestelmä käyttää Qt-ohjelmistokehystä. Työhön liittyy oleelliselta osalta myös kohdeympäristöön määritelty ohjeprosessi, jossa ohjemateriaali lähdemuodostaan prosessoidaan Qt-ohjelmistokehyksen tukemaksi ohjepaketiksi. Ohjeprosessissa ohjemateriaalin lähdemuotona toimii DITA XML -merkkauskieli, jota käytetään teknisen dokumentaation tuottamiseen. Aluksi työssä tarkastellaan olemassa olevia ohjejärjestelmän toteutuksia ja niiden määrittelyjä yleisesti. Taustatutkimuksen jälkeen eritellään ohjejärjestelmän vaatimukset kohdeympäristössään ja suunnitellaan niiden mukainen ohjejärjestelmä. Suunnittelutyössä käytetään hyödyksi olio-ohjelmoinnin menetelmiä sekä UML-kaavioita. Lopputuloksena on vaatimusten mukainen ohjejärjestelmä, jonka työn tilaaja hyväksyi ja on ottanut sisäisesti koekäyttöön. Ohjejärjestelmän perustoteutus on valmis. Perustoteutuksen lisäksi työssä esitellään myös jatkokehitysideoita. Ohjejärjestelmän, ja siihen liittyvän ohjeprosessin, laaja käyttöönotto kohdesovelluksen todellisessa ympäristössä vaatii ohjejärjestelmän jatkokehitystä.Purpose of this thesis is to design a context sensitive help system. The help system is designed for a Qt framework based PC desktop application that is used to configure and monitor an automation system. The context sensitive help system will provide help for users based on the application's current state and assist users in doing their work easily and efficiently. There is also a related help process defined for the automation system that will largely affect the design of the help system. The help process defines how source material is processed into a Qt help package. The used source format is DITA XML which is a markup language used to produce technical documentation. The thesis firstly takes a look at some existing implementations and defines help systems in general terms. After the background study, requirements are specified and the help system is designed based on those requirements. Object oriented programming methods and UML diagrams are used as design tools. Finally the design process will lead to a completed help system that fulfils its requirements. In the end of the thesis some further development options are presented. The completed help system has been taken into internal test use. Large scale deployment of the help system, and its related help process, in a real world environment requires further development