Plug-in della guida

Le funzioni di guida della piattaforma Eclipse forniscono blocchi di creazione per strutturare e fornire documentazione alla piattaforma. La struttura o la granularità della documentazione non sono dettate dalla piattaforma. E possibile scegliere gli strumenti e la struttura per la documentazione che meglio si adeguano alle proprie esigenze.  Il plug-in della guida consente di descrivere la struttura della documentazione alla piattaforma utilizzando un file toc (table of contents).

La guida in linea del plug-in viene fornita mediante il punto di estensione org.eclipse.help.toc. E possibile fornire la guida in linea come parte del plug-in di codice oppure fornirla separatamente in un proprio plug-in di documentazione.

La separazione della documentazione in un plug-in diverso è utile in quelle situazioni in cui i team della documentazione e del codice costituiscono gruppi di lavoro differenti oppure se si intende ridurre la relazione tra documentazione e codice.

Le funzioni avanzate del sistema della guida comprendono la guida sensibile al contesto con collegamenti di riferimento (denominati infopop) e la possibilità di richiamare il codice relativo alla piattaforma dalla documentazione.  Il browser della guida consente, inoltre, di visualizzare, stampare e ricercare la documentazione.  

Il modo migliore per dimostrare il contributo della guida consiste nel creare un plug-in di documentazione.

Copyright
IBM Corp. e altri 2000,2002.