Le plugin spxplugindownloader permet de centraliser des dépôts de plugins.

Vous avez créé des plugins et vous voulez les faire partager dans un dépot via ce plugin.

Comment faire ?

Les différents dépôts doivent produire deux url qui permettent au plugin de connaitre le numéro de version du repository ainsi que la liste exacte des plugins de ce dépot.

Deux fichiers doivent être fournit appelé par une url:

Ces deux fichiers peuvent par exemple être mis dan un dossier de votre dépôt git ou ailleurs (/repository par exemple).

• https://github.com/mongit/repository/repository.version --> retourne le numero de version de ton repository
• https://github.com/mongit/repository/repository.xml --> liste le detail de tes différents plugins (voir formattage ci-joint)

le repository.xml se présente sous cette forme :

<?xml version="1.0" encoding="UTF-8"?>
<document>
   <plugin>
      <title><![CDATA[Titre du plugin]]></title>
      <author><![CDATA[Mon nom]]></author>
      <version>1.6</version>
      <date>01/10/2013</date>
      <site>http://www.monsite.net/</site>
      <description><![CDATA[Plugin x detail]]></description>
      <name>pluginname</name>
      <file>https://github.com/mongit/gutuma/pluginname.1.6.zip</file>
      <icon>https://github.com/mongit/gutuma/pluginname.png</icon>
   </plugin>
   <plugin>
      ...
   </plugin>
</document>

A noter :

• l'icône peut etre générée en base 64 et non appelée via une url
• le "file" représente l'url du zip
• le "name" correspond au nom du dossier du plugin dans le repertoire plugin de pluxml

Comme on le voit ci dessus, le détail des plugins permet la comparaison entre le plugin installé sur site et la version du repository. Un champs file permet de récupérer l'url du zip du plugin, un champs icon permet d'afficher l'icône du plugin.

Vouloir créer sont dépot reste finallement assez simple.

Il vous faudra donc fournir les informations liés au depôt. Construire vos deux fichiers (version + liste des plugins au format xml), les zip et les logos devront correspondre à l'intégrité du fichier xml de description des plugins.

En changeant votre numéro de version de repository le plugin mettra a jour votre dépôt de plugins mis en cache.

Avis aux amateurs ! Ne pas hésiter à me contacter pour que je vous rajoute dans la liste des dépôts.

C'est quoi ?

Le plugin spxplugindownloader permet d'installer ou de mettre à jour vos plugins pluxml directement depuis l'interface d'administration.

L'usage est simple.

Un nouveau menu apparait dans l'interface : Dépôts plugins

Ce menu donne accès a vos plugins installés et aux différents dépots de plugins.

• plugin en vert : tout va bien
• plugin en bleu : nouveau et non installé
• plugin en rouge : mise a jour nécessaire

Comment l'ensemble fonctionne ?

Le plugin va d'abord récupérer ou mettre en cache la dernière version des dépots.

Deux fichiers sont mis en cache comportant:

• le numéro de la dernière version des dépots
• la liste des différents dépots au format xml

Numéro de version du dépot :

5

La liste des dépots :

<?xml version="1.0" encoding="UTF-8"?>
<document>
 
<repository>
  <title><![CDATA[Pluxopolis]]></title>
  <author><![CDATA[Stephane F]]></author
  <repositoryurl>https://raw.githubusercontent.com/Pluxopolis/repository/master/repository.xml</repositoryurl
  <repositoryversionurl>https://raw.githubusercontent.com/Pluxopolis/repository/master/repository.version</repositoryversionurl>
  <site>http://www.pluxopolis.net</site>
  <description><![CDATA[Liste des dépots des plugins pluxopolis]]></description>
  <name>pluxopolis</name>
  <icon>http://pluxopolis.net/themes/defaut/img/favicon.png</icon>
 </repository>
 
<repository>
  <title><![CDATA[Spx]]></title>
  <author><![CDATA[je-evrard]]></author>
  <repositoryurl>http://www.secretsitebox.fr/spx/repository/repository.xml</repositoryurl>
  <repositoryversionurl>http://www.secretsitebox.fr/spx/repository/repository.version</repositoryversionurl
  <site>http://www.secretsitebox.fr</site>
  <description><![CDATA[Liste des dépots des plugins spx]]></description>
  <name>spx</name>
  <icon>http://secretsitebox.fr/site/themes/secretsitebox/images/favicon.ico</icon>
 </repository>
 
</document>

Comme on le voit ici la liste n'est pas exhaustive mais peut être complétée très simplement.

Les différents dépôt doivent donc produire deux url qui permettent au plugins de connaitre le numéro de version du repository ainsi que la liste exacte des plugins de ce dépot.

Deux fichiers sont mis en cache comportant:

• le numéro de la dernière version du repository
• la liste des différents plugins au format xml

Numéro de version du repository (ex: http://www.secretsitebox.fr/spx/repository/repository.version):

5

La liste des plugins (ex: http://www.secretsitebox.fr/spx/repository/repository.xml):

[PHP]
<?xml version="1.0" encoding="UTF-8"?>
<document>
<plugin>
  <title><![CDATA[spxprism]]></title>
  <author><![CDATA[je-evrard]]></author>
  <version>1.0</version>
  <date>28/07/2014</date>
  <site>http://www.secretsitebox.fr</site>
  <description><![CDATA[Lightweight, extensible syntax highlighter based on Prism with shortcode (spxshortcodes)]]></description>
  <name>spxprism</name>
  <file>http://www.secretsitebox.fr/spx/spxprism.1.0.zip</file>
  <icon>http://www.secretsitebox.fr/spx/spxprism.png</icon> 
</plugin>
<plugin>
  <title><![CDATA[spxdatas]]></title>
  <author><![CDATA[je-evrard]]></author>
  <version>1.69</version>
  <date>04/07/2014</date>
  <site>http://www.secretsitebox.fr</site>
  <description><![CDATA[Plugin de gestion de données.]]></description>
  <name>spxdatas</name>
  <file>http://www.secretsitebox.fr/spx/spxdatas.1.69.zip</file>
  <icon>http://www.secretsitebox.fr/spx/spxdatas.png</icon>
</plugin>
...
</document>

Comme on le voit ci dessus le détail des plugins permet la comparaison entre le plugin installé sur site et la version du repository. Un champs file permet de récupérer l'url du zip du plugin, un champs icon permet d'afficher l'icône du plugin.

Vouloir créer sont dépot reste finallement assez simple.

Il vous faudra donc fournir les informations liés au depôt. Construire vos deux fichiers (version + liste des plugins au format xml), les zip et les logos devront correspondre à l'intégrité du fichier xml de description des plugins.

En changeant votre numéro de version de repository le plugin mettra a jour votre dépôt de plugins mis en cache.

Avis aux amateurs !