Súgó bekötése

Az Eclipse platform súgófunkciói biztosítják a nyers építőelemeket a dokumentáció platformhoz kialakításához és biztosításához. A dokumentáció struktúráját és finomságát nem írja elő. A dokumentációhoz kiválaszthatja az igényeinek megfelelő eszközöket és struktúrát. A súgó bedolgozó lehetővé teszi, hogy egy tartalomjegyzék (toc) fájl segítségével leírja a platform dokumentációstruktúráját.

A bedolgozó online súgója az org.eclipse.help.toc kiterjesztési pont segítségével kerül közreadásra. Az online súgó a kódbedolgozó részeként vagy külön kerül közreadásra a saját dokumentáció bedolgozóban.

A dokumentáció különálló bedolgozóra szeparálása akkor hasznos, amikor a kód- és dokumentációcsapat különböző csoport, vagy csökkenteni kívánja a dokumentáció és kód közötti kapcsolatot.

A súgórendszer speciális funkciói egy helyzetérzékeny súgót tartalmaznak referenciahivatkozásokkal és a platformkód meghívható a dokumentációból.  Egy súgóböngésző segítségével megjelenítheti, kinyomtathatja és megkeresheti a dokumentációt. A 3.1-es verzió óta az új súgónézet dinamikus súgót és egyesített információkeresési képességet tartalmaz.

A súgó bemutatásának legjobb módszere, ha létrehoz egy dokumentáció bedolgozót.