Structure du fichier plugin.xml : Différence entre versions

Version du 29 janvier 2013 à 19:04

Le fichier plugin.xml est le descripteur de votre plugin, il fournit à Thelia les informations permettant de l'installer. Il doit obligatoirement figurer dans le répertoire de votre plugin.

Pour que le fichier plugin.xml soit accepté par Thelia, il doit se conformer au schema XML disponible à l'adresse suivante : http://thelia.net/xsd/latest/plugin.xsd

Ci-dessous figure un exemple complet de fichier plugin.xml:

<?xml version="1.0" encoding="UTF-8"?>

  <plugin>

  <-- le descriptif complet, dans autant de langues que nécessaire. Le code de la langue doit être un code pays ISO 639 -->
  <descriptif lang="fr">
    <titre>Produits factices</titre>
    <chapo></chapo>
    <description>Insertion des produits dans votre site Thelia permettant d'avoir un Thelia de test vite opérationnel.</description>
    <postscriptum></postscriptum>
  </descriptif>

  <-- numéro de version du plugin -->
  <version>1.1</version>

  <-- Informations sur l'auteur (seul le nom est obligatoire) -->
  <auteur>
    <nom>Manuel Raynaud</nom>
    <societe>openstudio</societe> 
    <email>mraynaud@openstudio.fr</email>
    <web>http://thelia.net</web>
  </auteur>

  <-- Le type du plugin, à choisir entre: classique, transport, paiement, filtre -->
  <type>classique</type>

  <-- Les plugins dont ce plugin a besoin, et qui doivent être préalablement installés. -->
  <prerequis>
    <plugin version="1.0.0">unplugin</plugin>
    <plugin version="1.2">unautreplugin</plugin>
  </prerequis>

  <-- La version minimum requise de Thelia, au format 'dot' (1.2.3.4 par exemple) -->
  <thelia>1.5.0</thelia> 

  <-- Etat de finition, à choisir entre: alpha, beta, rc, production, autre -->
  <etat>production</etat> 
 
  <-- Le nom du fichier contenant la documentation. Ce fichier doit se trouver dans le répertoire du plugin. -->
  <documentation>README.TXT</documentation>

  <-- L'URL permettant de déterminer si une mise à jour est disponible -->
  <urlmiseajour></urlmiseajour>
</plugin>

Le fichier plugin.xml minimal est le suivant:

<?xml version="1.0" encoding="UTF-8"?>
  <plugin>
    <descriptif lang="fr">
      <titre>Produits factices</titre>
    </descriptif>
    <version>1.1</version>
    <auteur>
      <nom>Manuel Raynaud</nom>
    </auteur>
    <type>classique</type>
    <thelia>1.5.0</thelia> 
    <etat>production</etat> 
  </plugin>