Différences entre les versions de « Tutorial Plugin : 2 - Fichiers Plugin »

De Wiki Francophone de Maxthon
Aller à la navigation Aller à la recherche
m
 
(35 versions intermédiaires par 4 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
Partie 2: Fichier Plugin
__TOC__


Plugins are stored in the Maxthon/Plugin/PLUGINNAME folder. Every plugin has it's own folder.
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.


There are at least 3 files for every plugin necessary, all stored in the PLUGINNAME folder:
Chaque plugin a son propre dossier.


* plugin.ini
* ICONNAME.ico
* FILE.html


ICONNAME and FILE need to be defined in the plugin.ini file.
Il y a, au minimum, 3 fichiers nécessaires pour un plugin, tous stockés dans le dossier portant le nom du plugin :


=Toolbar Plugins=
* plugin.ini
* nom_icon.ini
* Fichier.html


The plugin.ini file looks like this for a toolbar plugin:


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


'''Name=Tester''' the pluginname


'''Author=neo101''' the author of the plugin
= Plugins de barre d'outils =


'''Version=2.1b''' version number
Le fichier plugin.ini ressemble à ceci, pour un plugin de barre d'outil :


'''ModuleType=SCRIPT''' plugintype. Could be COM,EXE or SCRIPT


'''FileName=test.html''' filename of the script that will be run if you press the button
<table width="95%" border=0 style="text-align:left">
<tr><th>[General]</th><td>&nbsp;</td></tr>
<tr><th>Name=Tester</th><td>Le nom du plugin</td></tr>
<tr><th>Author=neo101</th><td>L'auteur du plugin</td></tr>
<tr><th>Version=2.1b</th><td>Le numéro de version</td></tr>
<tr><th>ModuleType=SCRIPT</th><td>Le type de plugin. Doit être COM, EXE ou SCRIPT</td></tr>
<tr><th>FileName=test.html</th><td>Nom du fichier de script qui sera lancer si vous appuyez le bouton</td></tr>
<tr><th>Comments=Test Plugin</th><td>Ces commentaires seront visibles dans "Options de Maxthon -> Plugin -> Plugin de Maxthon"</td></tr>
<tr><th>Type=M2Plugin_BUTTON</th><td>Type de plugin, peut être M2Plugin_BUTTON ou M2Plugin_SIDEBAR (pas sensible à la casse)</td></tr>
<tr><th>HotIcon=testhot.ico</th><td>Icône qui sera visible lors du survol du bouton par la souris</td></tr>
<tr><th>Icon=test.ico</th><td>Icône qui sera toujours visible dans la barre de plugins (Peut être le même que HotIcon)</td></tr>
<tr><th>[MyIE2Buttons]</th><td>Le menu déroulant (pas requis si vous n'en avez pas besoin)</td></tr><tr><th>Count=3</th><td>Nombre d'éléments visibles dans le menu déroulant</td></tr>
<tr><th>Name1=Test1</th><td>Nom du 1er élément du menu déroulant</td></tr>
<tr><th>FileName1=test1.html</th><td>Nom de fichier du 1er élément (Peut être le même que FileName dans General)</td></tr>
<tr><th>Name2=Test2</th><td>&nbsp;</td></tr>
<tr><th>FileName2=scripts/test2.html</th><td>Si le fichier est dans le sous-répertoire 'scripts'</td></tr>
<tr><th>Name3=Settings...</th><td> &nbsp;</td></tr>
<tr><th>FileName3=Config_caller.html</th><td>&nbsp;</td></tr>
<tr><th>[Settings]</th><td>Vous pouvez ajouter vos propres paramètres dans ce fichier (utile pour la configuration mais pas obligatoire)</td></tr>
<tr><th> NewWindow=true</th><td>&nbsp;</td></tr>
<tr><th> Neo101IsNice=true</th><td>&nbsp;</td></tr>
</table>


'''Comments=Test Plugin''' These comments are visible in Maxthon Options->Plugin->Maxthon Plugin


Type=M2Plugin_BUTTON script type, could be M2Plugin_BUTTON or M2Plugin_SIDEBAR (not case sensitive)
Vous pouvez télécharger un fichier "plugin.ini" de barre d'outils
[http://maxthon.neo101.nl/tutorial/plugin.ini ici]


HotIcon=testhot.ico Icon that is visible if the user moves the mouse over the plugin button
= Plugins de barre latérale =


Icon=test.ico Icon that is always visible on the plugin toolbar (can be the same as HotIcon)
Le fichier "plugin.ini" ressemble à ce qui suit, pour un plugin de barre latérale :


[MyIE2Buttons] The dropdown menu (not required if you don't need a dropdown menu)


Count=3 Number of visible dropdown items
<table width="95%" border=0 style="text-align:left">
<tr><th>[General]</th><td>&nbsp;</td></tr>
<tr><th>Name=Tester</th><td>Le nom du plugin</td></tr>
<tr><th>Author=neo101</th><td>L'auteur du plugin</td></tr>
<tr><th>Version=2.1b</th><td>Le numéro de version</td></tr>
<tr><th>ModuleType=SCRIPT</th><td>Le type de plugin. Doit être COM, EXE ou SCRIPT</td></tr>
<tr><th>FileName=test.html</th><td>Nom du fichier de script qui sera lancer si vous appuyez le bouton</td></tr>
<tr><th>Comments=Test Plugin</th><td>Ces commentaires seront visibles dans "Options de Maxthon -> Plugin -> Plugin de Maxthon"</td></tr>
<tr><th>Type=M2Plugin_SIDEBAR</th><td>Type de plugin, peut être M2Plugin_BUTTON ou M2Plugin_SIDEBAR (pas sensible à la casse)</td></tr>
<tr><th>HotIcon=testhot.ico</th><td>Icône qui sera visible lors du survol du bouton par la souris</td></tr>
<tr><th>Icon=test.ico</th><td>Icône qui sera toujours visible dans la barre de plugins (Peut être le même que HotIcon)</td></tr>
<tr><th>[Settings]</th><td>Vous pouvez ajouter vos propres paramètres dans ce fichier (utile pour la configuration mais pas obligatoire)</td></tr>
<tr><th> NewWindow=true</th><td>&nbsp;</td></tr>
<tr><th> Neo101IsNice=true</th><td>&nbsp;</td></tr>
</table>


Name1=Test2 Name of dropdown item 1


FileName1=test2.html Filename of item 1 (can be the same as FileName under General)
Vous pouvez télécharger un fichier "plugin.ini" pour la barre latérale
[http://maxthon.neo101.nl/tutorial/files/plugin.ini ici]


Name2=Test3 


FileName2=scripts/test3.html If the file is in a subdirectory called 'scripts'
= Fenêtre de configuration =


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


FileName3=Config_caller.html 


[Settings] You can add your own items in the file (useful for settings) (not required)
[[image:chat.png]]


NewWindow=true 


Neo101IsNice=true 
* '''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 :


Download a basic plugin.ini file for a Toolbar Plugin [http://maxthon.neo101.nl/tutorial/plugin.ini here].
&lt;script language="JavaScript"&gt;<br> external.max_showConfig(%max_security_id,'PLUGINNAME')<br> &lt;/script&gt;


PLUGINNAME représente le nom de votre plugin.


=Sidebar Plugins=


The plugin.ini file looks like this for a sidebar plugin:  
* '''Pour les plugins de barre latérale :'''


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


Name=Tester the pluginname
&lt;a title="Montrer la fenêtre de configuration" <br>  href="javascript:external.max_showConfig(max_security_id,'PLUGINNAME')"&gt;<br>  Config&lt;/a&gt;


Author=neo101 the author of the plugin  
PLUGINNAME représente le nom de votre plugin.


Version=2.1b version number


ModuleType=SCRIPT plugintype. Could be COM,EXE or SCRIPT
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].


FileName=test.html filename of the script that will be run if you press the button


Comments=Test Plugin These comments are visible in Maxthon Options->Plugin->Maxthon Plugin
Maxthon essayera d'ouvrir le fichier "config.html" se trouvant dans le dossier de ce plugin.


Type=M2Plugin_SIDEBAR script type, could be M2Plugin_BUTTON or M2Plugin_SIDEBAR (not case sensitive)


HotIcon=testhot.ico Icon that is visible if the user moves the mouse over the plugin button
Un fichier "max.src" sera créé avec le "security_id" (aller voir la 3ème partie pour plus d'informations sur le "security_id").


Icon=test.ico Icon that is always visible on the plugin toolbar (can be the same as HotIcon)
Le fichier "config.html" doit être une page HTML normale. Vous pouvez changer les hauteur/largeur de la fenêtre avec ce code :


[Settings] You can add your own items in the file (useful for settings) (not required)
&lt;meta name=&quot;Dialog-'''Width'''&quot; content=&quot;'''110'''&quot;&gt;<br>  &lt;meta name=&quot;Dialog-'''Height'''&quot; content=&quot;'''120'''&quot;&gt;<br>
Ce code doit être placé à l'intérieur de l'élément &lt;head&gt;.


NewWindow=true 
Télécharger un fichier "config.html" de base [http://maxthon.neo101.nl/tutorial/files/config.html ici] (clic droit -> enregistrer la cible sous ...).


Neo101IsNice=true 
=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.


Download a basic plugin.ini file for a Sidebar Plugin [http://maxthon.neo101.nl/tutorial/files/plugin.ini here].


=Config Window=
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.


Since Maxthon v1.1.090 [2004-12-09] script plugins can use the configuration window.


Example:
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 :


[[image:chat.png]]


For Toolbar Plugins: You can call the window if you add a dropdown item in the plugin.ini file that links to a file with this code:
[[image:plugtut4.png]]
  <script language="JavaScript">
  external.max_showConfig(%max_security_id,'PLUGINNAME')
  </script>
 
PLUGINNAME is the name of your plugin.
 
For Sidebar Plugins: You can call the window if you add this code to your plugin:
  <a title="Show the configuration window"
    href="javascript:external.max_showConfig(max_security_id,'PLUGINNAME')">
    Config</a>
 
NOTE: You can also access the configuration window if you open Maxthon Options->Plugin->Maxthon Plugin and press the 'config' button.
 
Maxthon will try to open config.html from your pluginfolder.
A 'max.src' will be created with the security_id (see part 3 for more info about the security_id).


The config.html should be a normal HTML page. You can change the height/width of the window with this code:
Ceci n'arrive pas si vous modifiez le contenu d'autres fichiers/éléments.
    <meta name="Dialog-Width" content="110">
    <meta name="Dialog-Height" content="120">
This code should be inside the element.


Download a basic config.html file [http://maxthon.neo101.nl/tutorial/files/config.html here] (Right Click->Save Target As...)


=Install=
<b>NOTE :</b> 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).
If you put the plugin.ini file from your plugin in a directory in the maxthon/plugin folder and restart Maxthon, then Maxthon will automatically recognize your plugin.
The pluginname and versionnumber are written into the Maxthon/config/plugins.ini file if you close Maxthon.
Every time Maxthon starts it will check the Maxthon/config/plugins.ini file and check if the versionnumber has changed and if the plugin still exists.
If the versionnumber, author, plugin type or pluginname changes than you will see the following dialog:
 
[[image:plugtut4.png]]


This does not happen if you modify any other file/item.


NOTE: changes to the name, versionnumber, icon, filenames and the dropdown menu (for toolbar plugins) are only effective after a restart of Maxthon.
<center> '''<''' [[Tutorial Plugin : 1 - Introduction|Partie 1: Introduction]] | [[Tutorial Plugin|Sommaire Plugin]] | [[Tutorial Plugin : 3 - Commandes de Maxthon|Partie 3: Commandes de Maxthon]] '''>''' </center>
Changes to the content of plugin files are effective immediately.
Sidebar plugin need to be refreshed for the changes to take effect (right click->refresh).

Version actuelle datée du 2 juillet 2008 à 14:43

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 >