Facoltativo: aggiunta della guida al nodo

  1. Aggiungere la guida in linea al nodo. E' possibile creare un file help.html all'interno del progetto per contenere la guida in linea che spiega la funzione del nodo e il relativo utilizzo. Se si dispone di diversi file, potrebbe essere necessario considerare la creazione di una sottodirectory di documentazione separata nel progetto plugin e di memorizzarvi i file della guida in linea. E' possibile fare in modo che la guida in linea del nodo risulti integrata con le informazioni fornite del prodotto. Nelle informazioni del prodotto WebSphere Message Broker, in Riferimento > Flussi di messaggi, è presente un nodo foglia denominato "Nodi definiti dall'utente". Per fa sì che la guida in linea del nodo venga visualizzata in questo punto, è necessario:
    1. Modificare il file plugin.xml per includere il seguente punto di estensione nella documentazione del prodotto WebSphere Message Broker:
      <extension point="org.eclipse.help.toc">
      	<toc file="toc.xml"/>
      </extension>
    2. Creare un file toc.xml nel progetto del nodo di plugin e modificare l'attributo link_to per eseguire il collegamento all'ancora "UDNodes" che è già definita nel sommario della documentazione WebSphere Message Broker, come riportato di seguito:
      <toc label="My Plugin Node" topic="my_node.htm"
      											 link_to="../com.ibm.etools.mft.doc/toc.xml#UDNodes">
      	<topic label="Mytopic 1" href="topic1.htm>
      </toc>
      È possibile quindi visualizzare l'argomento della guida in Riferimento > Flussi di messaggi > Nodi definiti dall'utente, nel sommario.

      I nodi di esempio forniti con il prodotto mostrano questa funzione.

      Per ulteriori spiegazioni sui punti di estensione e su come utilizzarli, fare riferimento a PDE Guide.

  2. Aggiungere la guida (F1) sensibile al contesto al nodo. Questa è la guida che viene visualizzata quando si fa clic su un nodo nella Prospettiva Sviluppo dell'applicazione broker e si preme F1.

    Quando viene creato un nodo, viene creato un file HelpContexts.xml. Questo assegna un ID di contesto sul nome del nodo. E' possibile modificare il file HelpContexts.xml relativo al nodo modificando il testo nel campo di descrizione. Il nome del file HelpContexts.xml deve essere univoco nell'ambito del progetto, ma può contenere più voci di contesto; ad esempio, se si hanno diversi nodi all'interno di un unico progetto, ciascun nodo può avere nel file la relativa guida sensibile al contesto.

    La guida sensibile al contesto è limitata in lunghezza. Un modo utile per fornire una guida ulteriore all'utente consiste nell'eseguire un link tra la guida F1 ed un file HTML contenente ulteriori informazioni; ad esempio, alla guida in linea del nodo, descritta in precedenza. Il link deve essere codificato come segue:
    <topic href"../plugin directory/html file" label="Link title">
  3. Aggiungere la guida al nodo. Quando viene creato un nodo, viene creato un file palette.properties. E' possibile modificare tale file in modo da contenere la guida per il nodo; viene utilizzato per mostrare il nome del nodo quando la tavolozza non è sufficientemente grande per visualizzarlo completamente.

Se non si desidera aggiungere le funzioni facoltative, è possibile verificare il nodo in questo punto. A tal fine è necessario avviare un'altra istanza del workbenchInizio modifica, consultare Abilitazione delle funzioni di runtime PDEFine modifica e selezionare Esegui > Esegui come > Workbench di runtime. Per ulteriori informazioni sull'esecuzione della verifica mediante il workbench di runtime, fare riferimento a PDE Guide.

Concetti correlati
Nodi di input definiti dall'utente
Nodi di elaborazione dei messaggi definiti dall'utente
Nodi di output definiti dall'utente
Attività correlate
Sviluppo di estensioni definite dall'utente
Implementazione degli esempi forniti
Verifica di un nodo definito dall'utente
Distribuzione di un'estensione definita dall'utente
Riferimenti correlati
Estensioni definite dall'utente
Informazioni particolari | Marchi | Download | Libreria | Supporto | Commenti
Copyright IBM Corporation 1999, 2006 Ultimo aggiornamento: ago 17, 2006
as04497_