Tutorial Plugin : 2 - Fichiers Plugin

De Wiki Francophone de Maxthon
Aller à : navigation, rechercher

Les Plugins sont rangés dans le dossier "Maxthon\plugin\NOM_PLUGIN", par exemple "Maxthon\plugin\Viewpage" correspond au plugin ayant pour nom "viewpage" rangé dans le dossier Plugin de Maxthon.

Chaque plugin a son propre dossier.


Il y a, au minimum, 3 fichiers nécessaires pour un plugin, tous stockés dans le dossier portant le nom du plugin :

  • plugin.ini
  • nom_icon.ini
  • Fichier.html


Les noms de l'icône et du fichier doivent être définis dans le fichier plugin.ini.


Plugins de barre d'outils

Le fichier plugin.ini ressemble à ceci, pour un plugin de barre d'outil :


[General] 
Name=TesterLe nom du plugin
Author=neo101L'auteur du plugin
Version=2.1bLe numéro de version
ModuleType=SCRIPTLe type de plugin. Doit être COM, EXE ou SCRIPT
FileName=test.htmlNom du fichier de script qui sera lancer si vous appuyez le bouton
Comments=Test PluginCes commentaires seront visibles dans "Options de Maxthon -> Plugin -> Plugin de Maxthon"
Type=M2Plugin_BUTTONType de plugin, peut être M2Plugin_BUTTON ou M2Plugin_SIDEBAR (pas sensible à la casse)
HotIcon=testhot.icoIcône qui sera visible lors du survol du bouton par la souris
Icon=test.icoIcône qui sera toujours visible dans la barre de plugins (Peut être le même que HotIcon)
[MyIE2Buttons]Le menu déroulant (pas requis si vous n'en avez pas besoin)
Count=3Nombre d'éléments visibles dans le menu déroulant
Name1=Test1Nom du 1er élément du menu déroulant
FileName1=test1.htmlNom de fichier du 1er élément (Peut être le même que FileName dans General)
Name2=Test2 
FileName2=scripts/test2.htmlSi le fichier est dans le sous-répertoire 'scripts'
Name3=Settings...  
FileName3=Config_caller.html 
[Settings]Vous pouvez ajouter vos propres paramètres dans ce fichier (utile pour la configuration mais pas obligatoire)
NewWindow=true 
Neo101IsNice=true 


Vous pouvez télécharger un fichier "plugin.ini" de barre d'outils ici

Plugins de barre latérale

Le fichier "plugin.ini" ressemble à ce qui suit, pour un plugin de barre latérale :


[General] 
Name=TesterLe nom du plugin
Author=neo101L'auteur du plugin
Version=2.1bLe numéro de version
ModuleType=SCRIPTLe type de plugin. Doit être COM, EXE ou SCRIPT
FileName=test.htmlNom du fichier de script qui sera lancer si vous appuyez le bouton
Comments=Test PluginCes commentaires seront visibles dans "Options de Maxthon -> Plugin -> Plugin de Maxthon"
Type=M2Plugin_SIDEBARType de plugin, peut être M2Plugin_BUTTON ou M2Plugin_SIDEBAR (pas sensible à la casse)
HotIcon=testhot.icoIcône qui sera visible lors du survol du bouton par la souris
Icon=test.icoIcône qui sera toujours visible dans la barre de plugins (Peut être le même que HotIcon)
[Settings]Vous pouvez ajouter vos propres paramètres dans ce fichier (utile pour la configuration mais pas obligatoire)
NewWindow=true 
Neo101IsNice=true 


Vous pouvez télécharger un fichier "plugin.ini" pour la barre latérale ici


Fenêtre de configuration

Depuis la version 1.1.090 [du 9/12/2004], les plugins de script peuvent utiliser la fenêtre de configuration :


Chat.png


  • Pour les Plugins de barre d'outils :

Vous pouvez appeler cette fenêtre si vous ajoutez un article d'appel dans le fichier plugin.ini qui crée un lien vers un fichier avec le code suivant :

<script language="JavaScript">
external.max_showConfig(%max_security_id,'PLUGINNAME')
</script>

PLUGINNAME représente le nom de votre plugin.


  • Pour les plugins de barre latérale :

Vous pouvez appeler la fenêtre si vous ajoutez le code suivant à votre plugin :

<a title="Montrer la fenêtre de configuration" 
href="javascript:external.max_showConfig(max_security_id,'PLUGINNAME')">
Config</a>

PLUGINNAME représente le nom de votre plugin.


NOTE : Vous pouvez accéder aussi à la fenêtre de configuration par le menu Options -> Options de Maxthon -> Plugin [sélectionner le plugin visé] et cliquer sur le bouton "Configurer" [s'il est accessible pour ce plugin].


Maxthon essayera d'ouvrir le fichier "config.html" se trouvant dans le dossier de ce plugin.


Un fichier "max.src" sera créé avec le "security_id" (aller voir la 3ème partie pour plus d'informations sur le "security_id").

Le fichier "config.html" doit être une page HTML normale. Vous pouvez changer les hauteur/largeur de la fenêtre avec ce code :

<meta name="Dialog-Width" content="110">
<meta name="Dialog-Height" content="120">

Ce code doit être placé à l'intérieur de l'élément <head>.

Télécharger un fichier "config.html" de base ici (clic droit -> enregistrer la cible sous ...).

Installation d'un plugin

Si vous mettez le fichier plugin.ini de votre plugin dans un répertoire dans le dossier Maxthon\plugin et que vous redémarrez Maxthon, alors Maxthon reconnaîtra automatiquement la présence de ce nouveau plugin. Le nom et la version du plugin seront ajoutés dans le fichier Maxthon\config\plugins.ini lors de la fermeture de Maxthon.


Chaque fois que Maxthon démarre, il teste la présence du fichier Maxthon\config\plugins.ini, vérifie si le numéro de version a changé et si le plugin existe encore.


Si le numéro de version, l'auteur, le type de plugin ou le nom du plugin ont changé, vous pourrez voir la boîte de dialogue suivante :


Plugtut4.png

Ceci n'arrive pas si vous modifiez le contenu d'autres fichiers/éléments.


NOTE : Les modifications de nom, de numéro de version, d'icône, de nom de fichier et de menu contextuel (pour les plugins de barre d'outils) ne prendront effet qu'après un redémarrage de Maxthon. Les modifications du contenu des fichiers plugins sont prises en compte immédiatement. Les plugins de barre latérale doivent être réactualisés pour que les modifications prennent effet (clic droit -> Actualiser).


< Partie 1: Introduction | Sommaire Plugin | Partie 3: Commandes de Maxthon >