Import/export de modules

Depuis Automne 4.1 vous pouvez exporter et importer des modules crées avec le Polymod. Ainsi vous pouvez ajouter rapidement des fonctionnalités à vos sites ou choisir de partager les modules que vous avez développé. Nous allons voir ensemble comment utiliser cette fonctionnalité.

Automne est un CMS qui a la particularité de fournir un assistant de création de module, accessible aux intégrateurs web : le Polymod (pour module polymorphique).

Le Polymod c'est à la fois une interface graphique pour créer en quelques clics la structure de vos modules et une série de balises XML qui vont simplifier la création de rangées pour afficher les données stockées dans vos modules.

Depuis la version 4.1, Automne permet en plus d'exporter et d'importer des modules d'un site à un autre. Certains se sont empressé de nous soumettre plusieurs modules pour les partager avec la communauté.

Si vous voulez en faire de même, voici comment procéder.

Exporter un module Polymod

Pour exporter un module, il faut se rendre dans la gestion des modules, sélectionner un module Polymod dans la liste, puis cliquer sur le bouton Exporter.

La fenêtre de dialogue de l'export de module Polymod vous propose alors plusieurs options :

  • Format : patch, XML ou PHP ;
  • Options :
    • Inclure la définition des objets ;
    • Inclure les catégories ;
    • Inclure les rangées ;
    • Inclure les feuilles de styles CSS ;
    • Inclure les fichiers Javascript.

Export d'un module polymod

Sauf si vous savez ce que vous faîtes et que vous souhaitez pouvoir modifier l'export en éditant le fichier XML ou PHP généré, nous vous conseillons d'utiliser le format patch.

Les autres options sont à choisir en fonction du contexte. On peut vouloir un export complet ou partiel, pour par exemple ne de pas inclure les feuilles de style.

Pour le moment Automne ne permet d'exporter que la structure du module, ses éventuelles catégories et rangées, l'import/export de données sera disponible dans une prochaine version, surveillez la feuille de route.

Nous vous conseillons d'inclure une description complète dans le champ prévu à cet effet des fonctionnalités et des spécificités de votre module afin que les autres utilisateurs puissent appréhender au mieux son fonctionnement.

Exemple :

Description : Module de gestion des actualités classées par catégories.
Rangées : Dernières actualités d'une catégorie donnée, résultats paginés de toutes les actualités avec recherche en AJAX.
Javascript : gestion de la recherche en AJAX (nécessite jQuery)

Une fois les options et la description renseignées, il ne reste qu'à exporter le module et à télécharger le fichier de patch généré.

 L'import/export ne prend pas en compte les modules natifs écrits en PHP.

Import de module

Nous mettons à votre disposition différents modules pour enrichir les fonctionnalités de vos sites sous Automne.

Nous allons voir comment installer/d'importer un module Polymod.

Dans cet exemple je vais prendre un le module adresses proposé par automne4you un contributeur Automne, qui permet d'afficher des adresses sur une carte Goolgle Maps.

La première chose à faire est donc de télécharger le module disponible sous forme d'archive au format tgz.

Installation

  1. Rendez-vous dans la gestion des modules et cliquez sur le bouton importer.
  2. Cochez les options désirées et cliquez sur le bouton choisir le fichier du champ Fichier Patch et sélectionnez l'archive téléchargée.
  3. Automne procède à l'installation du module et affiche un rapport d'installation.

Import de module Polymod

4. Rafraichissez l'affichage de votre navigateur pour voir apparaître le nouveau module dans le panneau latéral de l'administration d'Automne.

Le module est installé et prêt à l'emploi puisque les rangées, les feuilles de style et les fichiers javascript.

Ajoutons quelques villes françaises dans le module :

Module adresses

Ajoutons une des rangées fournies avec le module dans une page et nous obtenons bien la carte de nos villes de France avec la recherche AJAX fonctionnelle :

Rangée du module adresses

Maintenant que vous savez exporter et importer des modules Polymod, on attend donc vos contributions ;)

Derniers commentaires

Posté par Automne4you

Merci, ça fait toujours plaisir de voir son travail reconnu.

Posté par Frank

Merci pour tes contributions, tes modules sont simples et didactiques, parfait pour s'initier au développement de modules avec le Polymod ;)
Laissez un commentaire