Productor de contenido de ayuda
Identificador:
org.eclipse.help.contentProducer
Desde:
3.0
Descripción:
Destinado a proporcionar contenido de ayuda dinámico generado
durante la ejecución. Los productores de contenido se registran por plug-in y solo funcionarán en el ámbito del
plug-in. Para reutilizar un productor de contenido en otro plug-in, debe utilizarse el elemento binding
. Esta estrategia impide que los plug-ins se adueñen de la generación de contenido para todos los plug-ins. Al enlazar
con un productor de contenido, un plug-in le otorga permiso para controlar la generación de contenido de todos los
documentos del plug-in otorgante.
Código de configuración:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer: clase de implementación del productor de contenido de ayuda. Esta clase debe implementar la interfaz
org.eclipse.help.IHelpContentProducer. Este atributo puede omitirse, y en su lugar puede suministrarse el elemento anidado producer.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class: clase de implementación del productor de contenido de ayuda. Esta clase debe implementar la interfaz
org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name: nombre de un parámetro pasado a la clase de implementación
- value: valor de un parámetro pasado a la clase de implementación
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId: nombre exclusivo de un productor de contenido definido en algún lugar utilizando el elemento
contentProducer. El enlace permite que un plug-in reutilice un productor de contenido registrado en otro
plug-in en lugar de definir el suyo propio.
Ejemplos:
A continuación figura un ejemplo de utilización del punto de extensión de productor de contenido:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"Mi contenido de ayuda dinámico"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
Información sobre la API:
La clase de productor de
contenido suministrada debe implementar la interfaz
org.eclipse.help.IHelpContentProducer.
El productor es responsable de suministrar contenido para los recursos de ayuda dinámicos de un plug-in. La ayuda llama al método de productor de contenido para cada recurso de ayuda obtenido del plug-in.
Implementación suministrada:
Ninguna. Si un plug-in de documentación no proporciona ningún productor de contenido de ayuda o una llamada a sus resultados es nula, el sistema de ayuda busca en el archivo doc.zip y en el sistema de archivos de la ubicación de instalación del plug-in un documento estático y visualiza su contenido.
Copyright (c) 2000, 2006 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 (Eclipse Public
License) v1.0 que acompaña a esta distribución, y está disponible en http://www.eclipse.org/legal/epl-v10.html