Configuration des parties d'introduction
Identificateur :
org.eclipse.ui.intro.config
Depuis :
3.0
Description :
Ce point
d'extension sert à enregistrer une configuration de partie
d'introduction. Cette configuration fournit des implémentations
de présentation et un contenu pour une contribution d'introduction
donnée. Une introduction apparaît lorsque le plan de travail
est démarré pour la première fois et comme choix dans le menu
Aide. Elle sert généralement à présenter à l'utilisateur un produit
intégré à Eclipse.
Les introductions sont organisées en pages reflétant généralement
une catégorie spéciale du matériel d'introduction. Par exemple, la
page Nouveautés présente de nouveaux concepts ou fonctionnalités par
rapport aux versions antérieures. Le contenu défini par une
configuration d'introduction peut être référencé et étendu à partir
d'autres plug-ins à l'aide du point d'extension
org.eclipse.ui.intro.configExtension.
Marques de configuration :
<!ELEMENT extension (config+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - identificateur qualifié complet d'un point d'extension cible.
- id -identificateur facultatif de l'instance d'extension.
- name - nom facultatif de l'instance d'extension.
<!ELEMENT config (presentation)>
<!ATTLIST config
introId CDATA #REQUIRED
id CDATA #REQUIRED
content CDATA #REQUIRED>
Un élément de configuration peut être utilisé pour configurer une
partie d'introduction personnalisable. Il doit alors préciser un ID,
un ID d'introduction et un fichier de contenu.
Ce fichier XML
décrit les pages, les groupes et les liens dans l'introduction.
- introId - ID d'une contribution de partie d'introduction à
laquelle cette configuration sera associée.
- id - nom unique pouvant être utilisé pour identifier
cette configuration d'introduction.
- content - fichier de contenu d'introduction. Ce fichier
XML contient les caractéristiques d'une introduction
(spécification du format du
fichier de contenu d'introduction).
Le fichier de contenu est analysé au moment de l'exécution par la
structure d'introduction. En fonction des paramètres de ce
fichier, un certain nombre de pages, de groupes et de liens
sont présentés à l'utilisateur à l'ouverture de l'introduction.
<!ELEMENT presentation (implementation+)>
<!ATTLIST presentation
home-page-id CDATA #REQUIRED
standby-page-id CDATA #IMPLIED>
Elément de présentation définissant toutes les implémentations
possibles pour la présentation d'une partie d'introduction. Il peut inclure une ou plusieurs implémentations. Seule une sera toutefois choisie au démarrage en fonction des
attributs du système d'exploitation/système de fenêtrage des
implémentations. Sinon, la première sans attributs définis
est choisie.
- home-page-id - ID de la page d'accueil (racine) de l'introduction. Cette
page peut servir de point d'entrée pour les autres pages
principales composant l'introduction.
- standby-page-id - attribut facultatif définissant l'ID
de la page d'attente. Celle-ci s'affiche lorsque l'introduction est
en mode Pause.
<!ELEMENT implementation (head?)>
<!ATTLIST implementation
kind (swt|html)
style CDATA #IMPLIED
os CDATA #IMPLIED
ws CDATA #IMPLIED>
La présentation de l'expérience de la plateforme inclut deux
implémentations. L'une est basée sur le navigateur SWT, l'autre sur
des formulaires au sein de l'interface utilisateur. La partie d'introduction
personnalisable peut être configurée pour choisir l'une de ces
présentations en fonction du système d'exploitation et du système de
fenêtrage. Le type d'implémentation est swt ou html.
- kind - indique le type de cette implémentation. Le type
swt signale une implémentation basée sur des formulaires au sein de
l'interface utilisateur, le type html une implémentation basée sur le navigateur SWT.
- style - style partagé qui sera appliqué à toutes les pages
présentées par cette implémentation de présentation d'introduction.
- os - spécification facultative du système d'exploitation
utilisée au moment de choisir l'implémentation de la présentation. Il
peut s'agir de l'un des désignateurs de système d'exploitation définis
par Eclipse, tels que win32 ou linux (voir la Javadoc pour
org.eclipse.core.runtime.Platform
).
- ws - spécification facultative du système de
fenêtrage utilisée au moment de choisir l'implémentation de la
présentation. I peut s'agir de l'un des désignateurs de système de
fenêtrage définis par Eclipse (voir la Javadoc pour
org.eclipse.core.runtime.Platform
).
Exemples :
L'exemple
ci-dessous illustre l'utilisation du point d'extension config.
<extension id=
"intro"
point=
"org.eclipse.ui.intro.config"
>
<config
introId=
"com.org.xyz.intro"
id=
"com.org.xyz.introConfig"
content=
"introContent.xml"
>
<presentation
home-page-id=
"root"
title=
"%intro.title"
>
<implementation
ws=
"win32"
style=
"css/shared.css"
kind=
"html"
os=
"win32"
>
</implementation>
<implementation
style=
"css/shared_swt.properties"
kind=
"swt"
>
</implementation>
</presentation>
</config>
</extension>
Informations d'API :
Pour
en savoir plus, voir la spécification pour le package
d'API org.eclipse.ui.intro.config.
Implémentation fournie :
L'introduction
contribuée par le plug-in org.eclipse.platform est la seule
implémentation dans Eclipse.
Copyright (c) 2004 IBM Corporation and others.
All rights reserved. Ce
programme et les produits qui l'accompagnent sont fournis sous
licence v1.0 associée à cette distribution et disponibles à l'adresse
suivante : http://www.eclipse.org/legal/cpl-v10.html.