Extension de contenu d'aide

org.eclipse.help.contentExtension

Ce point d'extension est destiné à prendre en charge le contenu dynamique et réutilisable dans les pages du système d'aide. Il permet l'ajout de contenu dans une page existante du système d'aide. Une page XHTML dans le système d'aide peut "déclarer" qu'elle accepte les contributions de contenu en spécifiant de manière explicite ces points de contribution à l'aide d'un élément anchor. Les fragments XHTML peuvent ensuite être insérés de manière dynamique dans ces documents au moment de l'exécution.

<!ELEMENT extension (contentExtension+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contentExtension EMPTY>

<!ATTLIST contentExtension

file CDATA #REQUIRED>

Définit l'extension de contenu sur une ou plusieurs pages du système d'aide. L'emplacement du fichier d'extension du contenu est spécifié par l'attribut file.



L'exemple ci-dessous illustre l'utilisation du point d'extension contentExtension.

(dans le fichier plugin.xml)

 

<extension point=

"org.eclipse.help.contentExtension"

>

<contentExtension file=

"contentExtensionFile.xml"

/>

</extension>

(dans le fichier contentExtensionFile.xml)

<contentExtension>

<topicExtension content=

"xhtml/topicA.xhtml"

path=

"org.xxx.yyy.somePluginId/xhtml/someHelpPage.xhtml/topicAnchor"

/>

</contentExtension>

La contribution ci-dessus insère le contenu du fichier XHTML, topicA.xhtml, dans la page du système d'aide cible indiquée par l'attribut path. Dans ce cas, l'extension de contenu sera alors insérée dans l'emplacement d'un ancrage nommé topicAnchor dans la page someHelpPage.xhtml du plug-in org.xxx.yyy.somePluginId.

La contribution ci-dessus insère le contenu du fichier XHTML, topicA.xhtml, dans la page du système d'aide cible indiquée par l'attribut path. Dans ce cas, l'extension de contenu sera alors insérée dans l'emplacement d'un ancrage nommé topicAnchor dans la page someHelpPage.xhtml du plug-in org.xxx.yyy.somePluginId.

Aucun code n'est requis pour utiliser ce point d'extension. Il suffit de fournir les fichiers de contenu appropriés, mentionnés dans le fichier plugin.xml.

L'implémentation par défaut du système d'aide de base fournie avec la plateforme Eclipse supporte totalement le point d'extension contentExtension.