Help Content Producer

Identifier:

org.eclipse.help.contentProducer

Since:

3.0

Description:

For providing dynamic, generated at run time, help content.

Configuration Markup:

<!ELEMENT extension (contentProducer?)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

<!ELEMENT contentProducer (producer)>

<!ATTLIST contentProducer

producer CDATA #IMPLIED>

• producer - the implementation class for the help content producer. This class must implement the org.eclipse.help.IHelpContentProducer interface. This attribute may be omitted, and the nested producer element may be provided instead.

<!ELEMENT producer (parameter*)>

<!ATTLIST producer

class CDATA #REQUIRED>

• class - the implementation class for the help content producer. This class must implement the org.eclipse.help.IHelpContentProducer interface.

<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>

• name - name of a parameter passed to the implementation class

• value - value of a parameter passed to the implementation class

Examples:

The following is a sample usage of the browser 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>

API Information:

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.

Supplied Implementation:

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.

Copyright (c) 2000, 2003 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html