Tilannekohtaisen ohjeen muokkausohjelma

Tilannekohtainen ohjetoiminto on mekanismi, jonka avulla voit linkittää käyttöliittymän osaan tietyn ohjeaiheen. Kun käyttäjä ottaa tällaisen käyttöliittymän osan käyttöön, dynaamiselle ohjealueelle tulee näkyviin liitetty ohjesivu. Voit liittää käyttöliittymän ja ohjesivut toisiinsa staattisen XML-tiedoston tai dynaamisen kontekstitoimittajan avulla. Sivujen staattista liittämistä varten on luotava tilannekohtaisen ohjeen XML-tiedosto. Tilannekohtaisen ohjeen muokkausohjelma auttaa luomaan kyseiset sivut.

Muokkausohjelman Määritys-sivulla on XML-tiedoston graafinen näkymä, joka on jaettu kahteen sarakkeeseen. Vasemmanpuoleisessa Tilannekohtainen ohje -sarakkeessa ovat XML-elementit rakennemuodossa sekä elementtien lisäys-, siirto- ja poistotoiminnot. Toisessa sarakkeessa on vasemmasta sarakkeesta valitun elementin yksityiskohtaiset tiedot, joita voit muokata.

Muokkausohjelman Lähde-sivulla on XML-tiedoston tekstinäkymä. XML-tiedostoa voi muokata suoraan, ja kelvolliset muutokset näkyvät graafisella Määritys-sivulla.

Uusien ohjekontekstien lisäys

Tilannekohtaisen ohjeen muokkausohjelma, jonka kentät on täytetty

Lisää uusi konteksti napsauttamalla Lisää konteksti -painiketta. Tällöin XML-tiedostoon lisätään uusi kontekstimerkintä, joka näkyy Määritys-sivulla olevassa puussa. Uusi konteksti valitaan, ja muokkausohjelman oikeassa reunassa olevaan sarakkeeseen avautuu tieto-osio. Tieto-osioon voi lisätä tarkempia kontekstitietoja, joita ovat muun muassa seuraavat:

Ohjeaiheiden ja komentojen lisäys

Kun tiedostoon lisätään konteksti, dynaaminen ohje näyttää käyttäjälle peruskuvauksen. Tavallisesti on tarpeen antaa lisälinkkejä muihin ohjejärjestelmässä oleviin asiaankuuluviin aiheisiin. Voit tehdä tämän lisäämällä XML-tiedostoon aiheita ja komentoja.

Tilannekohtaisen ohjeen muokkausohjelma, jonka kentät on täytetty

Lisää aihe -painiketta napsauttamalla voit lisätä ohjekontekstin XML-tiedostoon uuden aihemerkinnän. Käyttäjä näkee aiheen linkkinä. Kun uusi aihe on luotu, valitsemalla sen voit avataMääritys-sivun oikealla palstalla olevan Ohjeaiheen tiedot -osion. Tieto-osiossa voit muuttaa käyttäjälle näkyvää nimiötä ja linkitettävän tiedoston sijaintia. Linkitetty tiedosto on useimmiten ohjejärjestelmässä sijaitseva HTML-sivu. Voit etsiä linkitettävän tiedoston napsauttamalla Selaa...-painiketta.

Aiheiden lisäksi voi olla tarpeen lisätä myös komento. Komento näytetään käyttäjälle samanlaisena kuin aihe. Kun linkki aktivoidaan, ei avata tiedostoa, vaan suoritetaan koodikomento. Komennoilla voidaan avata oletusasetussivuja ja suorittaa muita toimintoja.

Tilannekohtaisen ohjeen muokkausohjelman lisäyskomento

Napsauttamalla Lisää komento -painiketta voit lisätä uuden komennon. Komentojen tietoja muokataan samaan tapaan kuin aiheiden tietoja.

Poista-, Ylöspäin- ja Alaspäin-komennot

Voit käsitellä kontekstiluettelon merkintöjen järjestystä ja poistaa merkintöjä luettelosta kolmen Määritys-sivulla olevan lisäpainikkeen avulla.

Tilannekohtainen ohje ja käsittelypainikkeet

Painikkeet ovat seuraavat:

Tilannekohtaisen ohjetiedoston rekisteröinti

Jotta Eclipse tunnistaa tilannekohtaisen ohjeen XML-tiedoston dynaamisen ohjejärjestelmän lähteeksi, tiedosto on rekisteröitävä org.eclipse.help.contexts-laajennuspisteen kautta. Muokkausohjelman avulla tiedoston voi rekisteröidä automaattisesti. Ohjelman oikeassa yläreunassa on Rekisteröi tämä tilannekohtainen ohjetiedosto -linkki. Kun napsautat sitä, oikea merkintä lisätään plugin.xml-tiedostoon.