Prise en charge de l'activité

org.eclipse.help.base.activitySupport

3.1

Ce point d'extension est utilisé par des plug-ins de produit afin de configurer le comportement du système d'aide lorsque les activités sont utilisées. Il permet de configurer les aspects suivants :

Ce point d'extension est expérimental et est susceptible d'être modifié dans les versions futures en fonction de l'évolution de la prise en charge de l'activité.

<!ELEMENT extension (support+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT support (localScopeCheckbox , documentMessage , showAllMessage)>

<!ATTLIST support

productId CDATA #REQUIRED>


<!ELEMENT showAllMessage (#PCDATA)>

message sous forme de texte sans mise en forme qui s'affichera dans la boîte de dialogue lorsque le filtrage de l'activité est désactivé. L'objectif du message est de mettre en garde sur le fait que sans le filtre, certains documents peuvent faire référence à des éléments de l'interface qui ne sont pas visibles.



<!ELEMENT localScopeCheckbox (#PCDATA)>

intitulé d'une case à cocher dans la page de préférences d'une portée de recherche. Lorsque la case est cochée, les occurrences trouvées dans des documents appartenant à des activités désactivées sont incluses dans les résultats de la recherche.



<!ELEMENT documentMessage EMPTY>

<!ATTLIST documentMessage

class    CDATA #IMPLIED

pluginId CDATA #REQUIRED>

fragment de code HTML qui sera injecté dans la partie supérieure de la rubrique d'aide appartenant à l'activité désactivée. L'objectif du message est d'avertir l'utilisateur sur le fait que la rubrique peut contenir des références à des éléments de l'interface qui ne sont pas visibles. Dans la mesure où le texte du message se trouve au sein d'un fichier XML, les balises HTML doivent être ignorées et les entitées XML standard utilisées pour les caractères spéciaux.

Le message peut contenir un hyperlien qui permettra à l'utilisateur d'accéder à l'éditeur d'activité afin de modifier l'état d'activation de l'activité. L'attribut class doit être utilisé dans ce cas.



L'exemple suivant illustre l'utilisation du point d'extension de la prise en charge de l'activité :

 

<extension point=

"org.eclipse.help.base.activitySupport"

>

<support productId=

"com.example.xyzProduct"

>

<showAllMessage>

Cette action affichera toutes les rubriques dans la table des matières.

</showAllMessage>

<documentMessage class=

"com.example.xyz.OpenRolePreference"

>

Cette rubrique appartient au rôle actuellement désactivé. &lt;p&gt; Pour activer le rôle, ouvrez &lt;a href="ACTIVITY_EDITOR"&gt;Role Preference Page.&lt;/a&gt;

</documentMessage>

</support>

</extension>

L'attribut class de l'élément documentMessage doit implémenter l'interface org.eclipse.help.ILiveHelpAction.

Eclipse SDK offre une prise en charge de l'activité par défaut utilisant le terme 'capacité' et ouvre la page de préférence des capacités à partir de l'hyperlien dans les rubriques désactivées. Lors d'un remplacement, assurez-vous que les modifications et la terminologie correspondent à celles de l'interface de la plateforme.