Réalisation Plugin

P
Pr ro oj je et t G Ge en nD Di ia ap po o
Rédacteurs FLAMENT Alexandre le 23/08/2001
QUAY-THEVENON Christophe
Responsable DAVID Jean-Pierre
Réalisation d’un Plugin
Version II.1.0
Statut Final
Disponibilité Livrable
Site : http://gendiapo.sourceforge.net/

SOMMAIRE
Historique __________________________________ 4
1. Introduction ______________________________ 5
2. Plugin DTD _______________________________ 6
2.1. Présentation __________________________________ 6
2.2. Description ___________________________________ 8
2.2.1. Actions possibles __________________________________ 8
2.2.2. Détail des classes _________________________________ 10
2.2.2.1. Classe org.gendiapo.editor.GenericGenDiapoEditor ___________ 10
2.2.2.2. Classe org.gendiapo.editor.GenericGenDiapoEditPanel ________ 11
2.2.2.3. Classe javax.swing.text.ViewFactory ______________________ 12
2.3. Construction & Intégration ______________________15
2.3.1. Paramètres d’un plugin DTD _________________________ 16
2.3.1.1. Dtd-plugin ___________________________________________ 16
2.3.1.2. Name _______________________________________________ 16
2.3.1.3. LongName ___________________________________________ 16
2.3.1.4. Version _____________________________________________ 16
2.3.1.5. Author ______________________________________________ 16
2.3.1.6. Url _________________________________________________ 17
2.3.1.7. Dtd ________________________________________________ 17
2.3.1.8. Editor _______________________________________________ 17
2.3.1.9. Icon ________________________________________________ 18
2.3.2. Utilisation du squelette _____________________________ 18
3. Plugin Action _____________________________ 22
3.1. Présentation _________________________________22
3.2. Description __________________________________22
3.2.1. Actions possibles _________________________________ 22
3.2.2. Détail des classes _________________________________ 22
3.2.2.1. Interface org.merlotxml.merlot.plugin.Action ________________ 22
3.2.2.2. Classe org.merlotxml.util.xml.XpathUtil ____________________ 23
3.2.2.3. Classe org.gendiapo.publisher.Publisher ___________________ 24
3.3. Construction & Intégration ______________________24
3.3.1. Paramètres d’un plugin Action _______________________ 25
3.3.1.1. Action ______________________________________________ 25
3.3.2. Utilisation du squelette _____________________________ 26

Glossaire __________________________________ 28
Annexe ____________________________________ 29
DTD des Plugins __________________________________29
DTD du Plugin DTD ______________________________________ 29
DTD du Plugin Action _____________________________________ 30
URL utiles _______________________________________30
Ant __________________________________________________ 30
DOM (Document Object Model) - Package org.w3c.dom ________ 30
Package javax.swing.text _________________________________ 31
Merlot Plugin development guide ___________________________ 31

Projet GenDiapo 4 / 31 CLIPS / SYNERGIE3R
Historique
Version
Date
Publication
Causes Changement
II.0.1
16/08/2001
Version initiale
II.0.2
21/08/2001
Mise en place du squelette
Ajout de liens vers la documentation
II.1.0
23/08/2001
Correction d’après les remarques de Cécile Guilloux

Projet GenDiapo 5 / 31 CLIPS / SYNERGIE3R
1. Introduction
Le but de ce document est de décrire les différents éléments à mettre en place pour
créer un plugin : ce dernier correspond à un ensemble de classes Java permettant
de mettre en place un nouveau traitement dans GenDiapo.
Son but principal est de faire évoluer l’outil auteur GenDiapo en lui ajoutant de
nouveaux traitements. En effet, l’outil auteur GenDiapo étant le plus générique
possible avec des traitements par défaut, les plugins permettront de modifier ces
derniers.
Un plugin peut être de deux types bien distincts :
 Plugin DTD : ce plugin va permettre d’adapter l’outil auteur de GenDiapo à
une DTD bien précise, adaptation concernant les différents aspects visuels de
l’outil auteur
 Plugin Action : ce plugin va permettre d’ajouter un traitement bien précis à
l’outil auteur
Pour ces deux types de plugins, nous donnerons une brève présentation de leurs
buts, puis des explications sur les différentes classes permettant de les construire et
enfin la manière de les intégrer dans l’outil auteur GenDiapo.
REMARQUE Même si les différents types de plugin ne sont pas particulièrement
compliqués à réaliser, certaines parties (comme la modification de la vue
stylée) requièrent un niveau assez bon en Java