Help Content Producer

org.eclipse.help.contentProducer

3.0

For providing dynamic, generated at run time, help content. Content producers are registered per plug-in and only work within the plug-in scope. In order to reuse a content producer in another plug-in, binding element should be used. This strategy prevents plug-ins from highjacking content producing for all the plug-ins. By binding to a content producer, a plug-in gives it permission to control content producing for all the documents in the granting plug-in.

<!ELEMENT extension (contentProducer | binding)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contentProducer (producer)>

<!ATTLIST contentProducer

producer CDATA #IMPLIED>


<!ELEMENT producer (parameter*)>

<!ATTLIST producer

class CDATA #REQUIRED>


<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>


<!ELEMENT binding EMPTY>

<!ATTLIST binding

producerId CDATA #REQUIRED>


The following is a sample usage of the content producer extension point:

  

<extension point=

"org.eclipse.help.contentProducer"

id=

"org.eclipse.myPlugin.myDynamicHelpProducer"

name=

"My Dynamic Help Content"

>

<contentProducer producer=

"org.eclipse.myPlugin.myPackage.Myproducer"

/>

</extension>

The supplied content producer class must implement the org.eclipse.help.IHelpContentProducer interface. The producer is responsible for providing content for dynamic help resources from a plug-in. The method of content producer is called by help for every help resource obtained from the plug-in.

None. If a documentation plug-in does not provide help content producer or a call to it results in null, help system searches doc.zip and file system in the plug-in install location for a static document and displays its content.