Descripción: permite definir ayuda contextual para un conector individual.
Códigos XML de configuración:
<!ELEMENT extension (contexts*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED
>
<!ELEMENT contexts EMPTY>
<!ATTLIST contexts
file CDATA #REQUIRED
plugin CDATA #IMPLIED
>
Códigos XML de configuración para el contenido del archivo de manifiesto de contextos):
<!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 >
Los archivos de manifiesto de los contextos proporcionan toda la información que se necesita cuando el usuario solicita ayuda contextual. La plataforma pasa el ID para identificar el contexto que se halla activo. Luego se recuperan las definiciones de contexto cuyos ID sean coincidentes. Después, el sistema de ayuda crea el objeto IContext, que contiene descripciones y temas de todas las definiciones de contexto de un ID dado. La descripción está destinada a la visualización por parte del usuario, y los temas relacionados podrían ser de utilidad para el usuario, porque ayudan a comprender el contexto actual. Los temas relacionados son archivos html empaquetados en doc.zip, además de los temas que forman parte de la ayuda en línea.
Si un conector define algún ID de contexto, puede ampliarse la descripción o los enlaces relacionados de un contexto declarando otro contexto con el mismo ID.
<extension point="org.eclipse.help.contexts"> <contexts file="xyzContexts.xml"/> </extension>
(en el archivo xyzContexts.xml)
<contexts>
<context id="generalContextId">
<description> Esta es una serie de ayuda F1 de ejemplo.</description>
<topic href="contexts/RelatedContext1.html"
label="Tema 1 relacionado con la ayuda"/>
<topic href="contexts/RelatedContext2.html"
label="Tema 2 relacionado con la ayuda"/>
</context>
</contexts>
Los temas relacionados
que hay en un archivo doc.zip se pueden adaptar al entorno local creando un
archivo doc.zip que tenga la versión traducida de los documentos y colocando el
archivo doc.zip en
el directorio nl/<idioma>/<país> o nl/<idioma>. El sistema de
ayuda buscará los archivos en estos directorios antes de tomar por omisión el
directorio plugin (de conectores).
Información sobre las API: no se necesita código adicional para utilizar este punto de extensión. Tan solo hay que suministrar los archivos de manifiesto apropiados que se mencionan en el archivo plugin.xml.
Implementación suministrada: el punto de extensión contexts está totalmente soportado por la implementación opcional por omisión de la UI del sistema de ayuda que se proporciona con la plataforma Eclipse.
Copyright (c) 2000, 2003 IBM Corporation y otros.
Reservados todos los derechos. Este programa y sus materiales adjuntos están disponibles
bajo los términos de la licencia pública común (Common Public License) v1.0 que acompaña a
esta distribución, y está disponible en
http://www.eclipse.org/legal/cpl-v10.html