Creazione di un plug-in della guida

In questo esempio, si presuppone che un autore di documentazione abbia già fornito all'utente la documentazione di base in formato file HTML. La granularità e la struttura di tali file non dipende dal team della documentazione. Una volta che la documentazione è stata distribuita, l'impostazione del plug-in e degli argomenti può avvenire in modo indipendente.

Si inizierà supponendo che la documentazione sia già stata fornita nella seguente struttura.

   html/
      concepts/
         concept1.html
         concept1_1.html
         concept1_2.html
      tasks/
         task1.html
         task2.html
         task3_1.html
         task3_2.html
      ref/
         ref1.html
         ref2.html

Si supporrà che il nome del plug-in sia com.example.helpexample.

Il primo passo consiste nella creazione di una directory di plug-in, com.example.helpexample, all'interno della directory plugins della piattaforma. La struttura secondaria doc\ illustrata in precedenza dovrebbe essere copiata nella directory.

I plug-in di documentazione devono disporre di un manifest proprio come avviene per i plug-in di codice. Il seguente codice definisce il plug-in di documentazione.

   <?xml version="1.0" ?>
   <plugin name="Online Help Sample"
      id="com.example.helpexample"
      version="1.0"
      provider-name="MyExample" />

Copyright IBM Corporation e altri 2000, 2003.