Plug-in della guida

Il sistema della guida della piattaforma consente all'utente di fornire la propria guida in linea del plug-in utilizzando il punto di estensione org.eclipse.help.contributions. È 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 di guida della piattaforma forniscono blocchi di creazione base per strutturare e fornire la Guida. La struttura o la granularità della documentazione non sono dettate dalla piattaforma. Quest'ultima, tuttavia, fornisce e controlla i visualizzatori della guida integrata, assicurando la stessa integrazione della documentazione.

Il punto di estensione org.eclipse.help.contributions fornisce quattro elementi attraverso i quali l'utente può contribuire alla Guida:

I contributi di argomenti, infoset e azioni specificano tutti un file .xml associato che contiene i dettagli del contributo. Il modo migliore per dimostrare questi elementi consiste nel creare un plug-in di documentazione che ne fa uso.