Nota: El sistema de ayuda se halla todavía en proceso de desarrollo y es previsible que se efectúen cambios hasta que se consiga la plena estabilidad. Se ha puesto a disposición en esta etapa para solicitar la opinión de los primeros en utilizarlo, bien entendido que los detalles de los mecanismos de contribución podrían cambiar de forma sustancial. |
Descripción: Definición de ayuda según contexto para un plug-in individual.
Códigos de configuración:
<!ELEMENT contexts EMPTY>
<!ATTLIST contexts name CDATA #REQUIRED>
<!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
>
Los archivos manifiestos de los contextos proporcionan toda la información necesaria cuando el usuario solicita ayuda según contexto. La plataforma comprueba el identificador para identificar el contexto que se halla activo. Entonces se recupera la definición de contexto con el identificador que coincida. Este elemento de contexto contiene los temas que el usuario pueda considerar útiles para entender el contexto actual.
Ejemplos:
A continuación podemos observar un ejemplo de utilización del punto de extensión contextos.
(in 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="Ayuda relacionada con el Tema 1"/>
<topic href="contexts/RelatedContext2.html"
label="Ayuda relacionaca con el Tema 2"/>
</context>
</contexts>
Información del API: No es necesario ningún código para utilizar este punto de extensión. Únicamente se requiere proporcionar el/los archivo/s de manifiesto apropiados, mencionados en el archivo plugin.xml.
Implementación suministrada: La implementación opcional por defecto del UI del sistema de ayuda proporcionado con la plataforma Eclipse da soporte completo al punto de extensión contextos.