Környezetérzékeny súgó szerkesztő

A környezetérzékeny súgó egy olyan mechanizmus, amely lehetővé teszi a felhasználói felület egy részének összekötését egy adott súgó témakörrel. Amikor a felhasználó aktiválja a társított felhasználói felület részt, a dinamikus súgó területen megjelenik a súgó oldal. A felhasználói felület és a súgó oldalak kétféleképpen társíthatók egymással: statikus XML fájl vagy egy dinamikus környezetszolgáltató által. Az oldalak statikus társításához létre kell hoznia egy környezetérzékeny súgó xml fájlt. A környezetérzékeny súgó szerkesztő segít létrehozni ezeket az oldalakat.

A szerkesztő Meghatározás oldala az XML fájl grafikus nézetét biztosítja, két oszlopra osztva. A baloldali oszlop címe Környezetérzékeny súgó, és fa formájában jeleníti meg az XML elemeket a hozzáadásukra, áthelyezésükre és eltávolításukra szolgáló műveletekkel együtt. A másik oszlop részletesebb információkat biztosít a baloldali oszlopban kijelölt elemről, és lehetővé teszi a részletek szerkesztését.

A szerkesztő Forrás oldala az xml fájl szöveges nézetét biztosítja. Az xml fájl közvetlenül szerkeszthető, és a módosítások (ha érvényesek) tükröződnek a grafikus Meghatározás oldalon is.

Új súgó környezetek hozzáadása

Súgó környezet szerkesztő kitöltött mezőkkel

Egy új környezet hozzáadásához kattintson a Kontextus hozzáadása gombra. Ez hozzáad egy új környezet (context) bejegyzést az xml fájlhoz, és az megjelenik a Meghatározás oldalon lévő fában. Az új környezet ki lesz jelölve, és megnyílik egy Részletek szakasz a szerkesztő jobb oszlopában. A Részletek részben további részletes információkat adhat meg a környezettel kapcsolatban, többek között:

Súgó témakörök és parancsok hozzáadása

Ha hozzáad a fájlhoz egy kontextust, akkor a felhasználó számára megjelenítendő alapvető leírást tartalmazó dinamikus súgót eredményez. Célszerű további hivatkozásokat biztosítani a súgórendszer kapcsolódó témaköreire is. Ehhez hozzá kell adnia a témaköröket és parancsokat az xml fájlhoz.

Súgó környezet szerkesztő kitöltött részletek mezőkkel

A Témakör hozzáadása gombra kattintva hozzáadhat egy új témakör (topic) bejegyzést az xml fájlhoz, az egyik súgókörnyezet alatt. A felhasználó számára a témakör egy hivatkozásként fog megjelenni. Ha már létrehozta az új témakört, akkor kijelölheti, hogy megnyissa a Meghatározás oldal jobb oldalán található Témakör szerkesztése részben. A Részletek részben módosíthatja a felhasználó számára megjelenítendő címkét, valamint a hivatkozott fájl helyét. Legtöbb esetben a hivatkozott fájl a súgórendszer egyik html oldala. A Tallózás... gombra kattintva megkeresheti a hivatkozáshoz tartozó fájlt.

A témakörök mellett parancsokat is hozzáadhat. A parancs ugyanúgy jelenik meg a felhasználó számára, mint egy témakör. A hivatkozás aktiválásakor azonban egy fájl megnyitása helyett egy kódparancs lesz végrehajtva. A parancsok beállítási oldalak megnyitására és egyéb műveletek végrehajtására használhatók.

Súgó környezet szerkesztő hozzáadás parancs

A Parancs hozzáadása gombra kattintva hozzáadhat egy új parancsot. A parancs részleteit ugyanúgy szerkesztheti, mint a témaköröket.

Eltávolítás, Fel és Le parancsok

A Meghatározás oldalon van még három gomb, amelyek lehetővé teszik a környezetlista elemeinek kezelését vagy az elemek törlését.

Súgó környezet kezelő gombokkal

Ezek a gombok a következők:

A környezetérzékeny súgó fájl regisztrálása

Ahhoz, hogy az Eclipse a környezetérzékeny súgó fájlt a dinamikus súgórendszer forrásaként ismerje fel, regisztrálni kell a fájlt az org.eclipse.help.contexts kiterjesztési ponton keresztül. A szerkesztő módot ad a környezetérzékeny súgó fájl automatikus regisztrálására. A szerkesztő jobb felső sarkában szerepel egy hivatkozás: "Környezetérzékeny súgó fájl regisztrálása". A hivatkozásra kattintva a megfelelő bejegyzés hozzá lesz adva a plugin.xml fájlhoz.