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 file 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 EMPTY >
    <!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, Le definizioni del contesto vengono quindi recuperate insieme agli ID corrispondenti. L'oggetto IContext viene quindi creato dal sistema della guida che contiene descrizioni e argomenti di tutte le definizioni di contesto per un determinato ID.  La descrizione deve essere visualizzata dall'utente e gli argomenti correlati possono essere utili per comprendere il contesto corrente.  Gli argomenti correlati sono costituiti da file HTML in pacchetti doc.zip forniti insieme agli argomenti che fanno parte della Guida in linea.
 

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 file="xyzContexts.xml"/>
   </extension>
 

(nel 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

E possibile convertire i file Context XML e posizionare la copia risultante (con conversione delle etichette descrittive) nella directory nl/<language>/<country> o nl/<language>.  Per <language> e <country> si intendono i codici a due lettere relativi alla lingua e ai paesi utilizzati nei codici di impostazione internazionale.  Ad esempio, le conversioni dal cinese mandarino dovrebbero essere poste nella directory nl/zh/TW.  La directory nl/<language>/<country> ha una priorità più elevata della directory nl/<language>.  I file posizionati in nl/<language> saranno utilizzati soltanto se non viene trovato alcun file in nl/<language>/<country>.  Infine sarà ricercata la directory principale di un plug-in.

E possibile localizzare gli argomenti correlati contenuti nel pacchetto doc.zip mediante la creazione di un file doc.zip con la versione convertita dei documenti da posizionare nella directory
nl/<lingua>/<paese> o nl/<lingua>. Il sistema della Guida ricercherà i file in queste directory prima di impostare come predefinita la directory plugin.

 
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'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. e altri 2000, 2002. Tutti i diritti riservati.