Nota: il sistema della guida è ancora in fase di sviluppo e potrebbe subire delle modifiche prima di diventare stabile. È stato reso disponibile in questo stadio per sollecitare commenti e suggerimenti dai primi utenti, nella convinzione che possano fornire apporti decisivi al suo sviluppo.

Contexts

Identificativo: org.eclipse.help.contexts

Descrizione: per definire la guida sensibile al contesto di un plug-in individuale.

Tag di configurazione:

   <!ELEMENT contexts EMPTY>
   <!ATTLIST contexts name CDATA #REQUIRED>

Tag di configurazione dell'estensione contexts (contenuto nel file manifest dell'estensione contexts):

    <!ELEMENT contexts (context)* ) >

    <!ELEMENT context (description?,topic*) >
    <!ATTLIST context id  ID #REQUIRED >

    <!ELEMENT description (#PCDATA)>

    <!ELEMENT topic (topic)* >
    <!ATTLIST topic id ID #IMPLIED >
    <!ATTLIST topic label CDATA #REQUIRED >
    <!ATTLIST topic href  CDATA #IMPLIED >

I file manifest dell'estensione contexts forniscono tutte le informazioni necessarie quando la guida sensibile al contesto viene richiesta dall'utente. L'id viene trasferito dalla piattaforma in modo da identificare il contesto correntemente attivo e viene richiamata la definizione di contesto che abbia un id corrispondente. Questo elemento di contesto comprende, oltre alla breve descrizione che sarà visualizzata all'utente, argomenti correlati che potrebbero rivelarsi utili per comprendere il contesto corrente.
 

Esempi:

di seguito viene riportato un esempio di utilizzo del punto di estensione contexts,

(nel file plugin.xml).

   <extension point="org.eclipse.help.contexts">
      <contexts name="xyzContexts.xml"/>
   </extension>
 

(in file xyzContexts.xml)

    <contexts>
      <context  id="generalContextId">
        <description> This is a sample F1 help string.</description>
        <topic href="contexts/RelatedContext1.html"  label="Help Related Topic 1"/>
        <topic href="contexts/RelatedContext2.html"  label="Help Related Topic 2"/>
      </context>
    </contexts>
 

Esternalizzazione delle stringhe

I file manifest di contesto esternalizzano le proprie stringhe sostituendole con una chiave (ad esempio, %fooWidget) e creando una voce nel file context.properties del form:
    fooWidget = "Builds the project "
Le etichette di argomento correlate vengono esternalizzate mediante un approccio simile. Per esternalizzare <topic href="fooHelp.html" label="Building Projects">, sostituirne l'etichetta con una chiave %buildingProjects . L'argomento avrà il seguente aspetto:
    <topic href="fooHelp.html" label="%buildingProjects">
Creare una voce nel file context.properties che contiene la voce:
    buildingProjects = Building Projects
Il sistema della guida utilizzerà context.properties durante la ricerca di stringhe esternalizzate dai contributi della guida di contesto.
 

Informazione API: per utilizzare questo punto di estensione non è necessario alcun codice. Occorre soltanto fornire il file manifest appropriato, menzionato nel file plugin.xml.
 

Implementazione fornita: l'opzionale implementazione predefinita dell'interfaccia utente del sistema della guida, in dotazione con la piattaforma Eclipse, supporta completamente il punto di estensione contexts.
 
 
 

Copyright IBM Corp. 2000, 2001. Tutti i diritti riservati.