RefGenerator, mon premier plugin WordPress

Attention: Les informations de ce billet sont susceptibles d'être obsolètes car vieux de plus 2 ans.

Warning: The information you are reading may be obsolete, this post was published more than 2 years ago.

Attention une nouvelle version du plugin est maintenant téléchargeable.

Après avoir créé un template quasiment from scratch pour mon blog, je me suis dis que je ne m’arrêterais pas en si bon chemin et j’ai donc écris mon premier plugin WordPress. En fait je pourrais faire facilement 5 articles pour expliquer comment RefGenerator a été écrit mais je n’ai pas le temps pour l’instant. Peut-être qu’un autre jour j’expliquerais ma démarche, mais pas aujourd’hui, pas maintenant.

La conception

Généralement, lorsque je code un script ou une application, je me demande toujours si

  1. cela vaut la peine ;
  2. cela n’a pas déjà était fait ;
  3. et finalement si j’ai les reins solides pour commencer et surtout finir ce que j’ai entamer 😉 ;

Pour ce script, il m’a fallu réellement 3 jours (pas à 100%) pour le coder mais près de 2 à 3 mois pour vraiment me mettre en condition pour le réaliser. Au début ce n’était qu’une extension de mon template, et maintenant c’est un plugin totalement indépendant de celui-ci et ça c’est cool. Cela veut dire qu’il est utilisable par n’importe qu’elle blog WordPress 2+.

RefGenerator

Bon trèves de bavardage, à quoi sert RefGenerator ? C’est un plugin 2 en 1 qui sert à lister en fin d’article tous les liens externes utilisés dans celui-ci. En fait, il génère la liste des réfèrences externes utilisées pour écrire votre article, et l’ajoute en fin d’article trier dans l’ordre d’apparition du lien dans l’article.

Pourquoi est-ce un plugin 2 en 1 ? Tous simplement par ce que RefGenerator peut être utilisé de 2 manière distinctes, via PHP ou via le javascript pour générer la liste des références. Chacune de ces méthodes ayant des avantages et des inconvénients.

Est-ce que ce plugin est pour moi ? Cela dépend de la finalité de votre blog et surtout de votre besoin ou non d’un tel plugin. Personnellement je l’ai développé parce qu’on me la demandé gentiment et que je voulais comprendre comment fonctionner les plugins sous WordPress. Du coup, j’ai retiré l’extension de mon template et je l’ai ré-implanter via RefGenerator dans mon blog.

Comment ça marche

  1. Télécharge le fichier compressé qui se trouve en fin d’article et décompresse-le sur ton ordinateur.
  2. Transfert le dossier décompressé dans le répertoire plugins de ton installation wordpress.
  3. Rend-toi ensuite dans la partie administration de ton wordpress, dans l’onglet Plugins et active RefGenerator.
  4. Puis, toujours dans la partie administration sous l’onglet Options de WordPress clique sur le sous-onglet RefGenerator qui vient de se rajouter.
  5. Configure RefGenerator en fonction de la méthode utilisée pour générer la liste des liens externes de tes articles.

Quelle méthode choisir ?

Si vous venez d’installer WordPress et que vous n’avez pas l’habitude de bidouiller dans les templates, la méthode PHP vous conviendra, c’est le cas, je pense, de la majorité des gens qui vont télécharger ce plugin. En revanche, si vous êtes un utilisateur chevronné de WordPress et que modifier vos templates ne vous fait pas peur, alors la méthode javascript vous sera plus utile. Quelque soit la méthode utilisée, j’espère que le plugin répondra positivement à vos attente.

Last but not least

Si vous changer le nom de l’attribute class de la balise qui contient la liste de liens, n’oubliez pas de modifier les fichiers CSS qui se trouvent dans le sous dossier css du répertoire du plugin. Veuillez trouver ci-dessous le dossier compresser de refGenerator au format zip et au format tgz, choisissez le format de compression que vous préférez.

Attention une nouvelle version du plugin est maintenant téléchargeable.

La page d’administration du plugin contient des fautes d’orthographe du à mon empressement à sortir le plugin. Pour traduire dans votre langue le plugin, il vous suffit. de vous rendre dans le dossier langs dans lequel vous retrouverez les fichiers de langues. Si vous avez l’âme d’un professeur de français, Vous devez d’abord copier le fichier (.po) en le renommant en fonction de votre langue et corriger les fautes d’orthographe et ensuite mettre à jour son fichier .mo via la commande msgfmt refgen-xx_XX.po -o refgen-xx_XX.mo sous Unix/linux/BSD ou en utilisant PoEdit sous Windows. Le suffixe xx_XX est l’identifiant de la langue de votre WordPress. Envoyez-moi les fichiers modifiés et je mettrai à jour RefGenerator le plus rapidement possible pour la joie de tous.

14 thoughts on “RefGenerator, mon premier plugin WordPress

  1. C’est tout simplement génial!
    J’écris des articles à partir de multitudes de sources que je mets toujours mais cela complique la lecture et navigation de mes quelques modestes visiteurs , alors merci!

  2. Bon j’arrive là parce que je suis en train de m’intéresser aux design wordpress (ou pas), et celui-ci de ce blog m’a l’air fort original.

    Cependant, est-ce volontaire de ne pas afficher la boite “Catégories/Archives'” sur la page d’accueil ? Parce que ce n’est guère évident de trouver les archives depuis la page d’accueil (deviner qu’il faut cliquer sur l’unique article pour voir ce menu, ce n’est pas intuitif).

  3. Salut,
    J’avais installé ce plugin que je trouve intéressant: malheureusement, ce dernier affiche les liens sous ma balise “more” dans ma page d’accueil.
    http://radicarl.net

    Or, j’aurais simplement souhaité que ce plugin affiche mes références externe à la fin de la page consacré à l’article… et non directement sous l’intro dans la page d’accueil.

    As-tu une idée comment je pourrais y remédier ?

    Merci, et encore bravo pour ce plugin

    • @RadiCarl
      Je travaille justement sur une nouvelle version du RefGenerator, en béta en ce moment, qui va justement répondre à tes besoins. Dès que mes tests seront terminés tu pourras la télécharger sur mon blog.

  4. Bonjour,

    j’utilise votre plugin (option php) et je l’aime beaucoup.

    J’aurais aimé être plus à l’aise avec le php pour pouvoir créer une liste d’URL à omettre de la liste, la raison est que j’ai des plugins qui ajoutent des liens sortants et que je ne veux pas les afficher en double sur mes pages…

    Croyez-vous que ce serait un gros boulot ? je suis prête à suivre la piste que vous m’indiquerez et tenter de modifier le plugin.

    Merci

    Suzanne

    • @suzanne,
      La nouvelle version de RefGenerator vient justement de sortir avec un patch pour empêcher l’apparition de doublons dans la liste des références 😉 . Donc je te conseille vivement de la téléchargée et de voire si avec ses nouvelles fonctionnalités, le plugin ne répond pas déjà à tes attentes.
      Si néanmoins ce n’est pas le cas, je pourrais effectivement envisager de mettre un liste de lien qui serait alors automatiquement omis par le plugin, en version PHP ou Javascript. C’est faisable mais pour cela il faudrait modifier le fichier refgenerator.php inclus dans le plugin. Si tu veux je peux le mettre dans ma todolist pour la prochaine version.
      Ceci dit, merci d’utiliser mon plugin. et n’hésite pas à commenter le nouveau plugin sur sa la nouvelle page

  5. Bonjour,
    D’abord bravo et j’adopte. Sauf que j’ai un petit soucis c’est sur une faute d’orthographe qui me gêne mais que je n’arrive pas à régler, donc je n’ai pas encore activé:
    Références pour cet article
    et non
    Références pour cette article

    Vous pouvez m’aider?

    • @Houdremont : merci d’avoir installer mon plugin. Etant donné que je devais mettre à jour le plugin, j’en ai profité pour ajouter dans les options d’administration, le fait que l’utilisateur pouvait choisir à sa guise le titre de la liste générée par refgenerator. J’espère ainsi répondre à ta question et rendre l’utilisation du plugin encore plus simple.
      La nouvelle version de Refgenerator devrait être disponible dès à présent sur le site de WordPress

  6. Bravo encore, bien que j’avais en définitif réussi à corriger, j’apprécie tout particulièrement la nouvelle fonctionnalité.
    Grâce à toi, puisque nous nous tutoyons, j’ai un peu progresser dans la maîtrise de mon interface. Je vais essayer maintenant d’aller jusqu’au bout de mon installation

    Vive les Logiciels Libres et les communautés qui vont avec!

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.