Accueil Boite à Outils Syndication de contenu Syndication de contenu - Archives Editer plusieurs fichiers de syndication 3/3

Publié le : 20 février 2006
Publication antérieure :
12 août 2005

Imprimer Imprimer cet article

Auteur :
Alain Sichel

Alain Sichel
Editer plusieurs fichiers de syndication 3/3
3) Ajout des formats RSS 1.0 et Atom 1.0

Cet article a été publié le 12 août 2005, il est actuellement dépassé et n’a plus qu’un intérêt "historique". Pour éditer des fichiers de syndication, je vous conseille plutôt de voir Editez vos flux avec Fil_LE 1/2 et 2/2.

Si vous utilisez l’éditeur décrit dans Editer plusieurs fichiers de syndication 1/3 et 2/3, cet article vous propose de le compléter en éditant également des fichiers de syndication aux formats RSS 1.0 et Atom 1.0. [1]

Pour quoi faire ?

Les formats RSS 0.91 et son évolution en RSS 2.0 sont moins souples que le RSS 1.0 qui offre plus de possibilités d’ajouter des informations supplémentaires tout en respectant son format, et aussi d’être lisible par plus de lecteurs car il est basé sur RDF (format du w3c pour le web sémantique) [2].

Pour Atom, le format 0.3 n’était qu’une étape, le format 1.0 donne là-aussi plus de possibilités [3].

Installation de l’éditeur

Tout est dans Editeur3.zip (à télécharger en bas de cette page). Une fois décompacté, le dossier comprend :

- Les fichiers déjà présents dans la précédente version de l’éditeur [4] :

  1. aide.html ce fichier peut être lancé à partir de maker.php pour expliquer les différents éléments,
  2. easyRSS_maker_2.inc.php c’est la classe EasyRSS modifiée pour réaliser un fichier au format RSS 2.0,
  3. easyRSS_maker_3.inc.php la classe EasyRSS modifiée pour réaliser un fichier au format Atom 0.3,
  4. easyRSS_maker_htm.inc.php la classe EasyRSS modifiée pour réaliser un fichier au format HTML,
  5. easyRSS_maker_js.inc.php la classe EasyRSS modifiée pour réaliser un fichier au format JavaScript,
  6. easyRSS_maker.inc.php la classe EasyRSS modifiée pour réaliser un fichier au format RSS 0.91,
  7. easyRSS_reader_4.inc.php la classe EasyRSS 1.5.1 modifiée, pour récupérer les données d’un fichier de syndication existant.

- maker.php qui présente l’interface en ligne pour réaliser vos fichiers de syndications. Il était présent dans la précédente version de l’éditeur, mais cette version ajoute la réalisation de fichiers RSS 1.0 et Atom 1.0.

- De nouveaux fichiers :

  1. easyRSS_maker_1.inc.php c’est la classe EasyRSS modifiée pour réaliser un fichier au format RSS 1.0,
  2. easyRSS_maker_4.inc.php la classe EasyRSS modifiée pour réaliser un fichier au format Atom 1.0.

Comme indiqué dans pour l’installation de la version précédente, le plus simple est d’installer ce dossier complet à la racine de votre site [5], il faut ensuite protéger le dossier easyRSS par un fichier .htaccess afin que seules les personnes autorisées puissent accéder à maker.php, sinon n’importe qui peut remplacer vos fichiers de syndication [6].

Interface et utilisation

Les explications de l’article Editer plusieurs fichiers de syndication 3/3 restent valables, les seules modifications visibles sont dans le titre et le bouton d’envoi en bas de page qui inidquent les nouveaux formats édités.

Modification du script de maker.php

En plus de l’édition de fichiers RSS 1.0 et Atom 1.0, c’est ajouté une nouvelle fonction :

function nettoie($text) {
        $avant = array('\\','&#8217 ;','′','’','•');
        $apres = array('',"'","'","'",'- ');
        $text = str_replace($avant, $apres, trim($text));
        return $text;
}

Cette fonction est appelée à chaque fois que l’on récupère des informations dans un champ du formulaire (sauf pour les URL et les dates), afin d’éliminer des caractères indésirables si on veut avoir des fichiers RSS ou Atom valides.

Adaptations de maker.php

Les explications de l’article Editer plusieurs fichiers de syndication 2/3 restent valables (mais la numérotation des lignes est évidemment différente) :

Emplacement des autres fichiers :

Si "easyRSS_reader_2.inc.php" ou les fichiers "easyRSS_maker..." ne sont pas dans le même dossier que "maker.php", vous devez modifier dans ce dernier le chemin vers ces fichiers :
- ligne 236 pour "easyRSS_maker.inc.php",
- ligne 146 pour "easyRSS_maker_1.inc.php",
- ligne 191 pour "easyRSS_maker_2.inc.php",
- ligne 70 pour "easyRSS_maker_3.inc.php",
- ligne 108 pour "easyRSS_maker_4.inc.php",
- ligne 280 pour "easyRSS_maker_htm.inc.php",
- ligne 313 pour "easyRSS_maker_js.inc.php",
- ligne 346 pour "easyRSS_reader_4.inc.php",

URL du fichier RSS :

Afin de mettre l’adresse de votre fichier de syndication pour la récupération des données, il suffit de remplacer à la ligne 496 'http://www.mondomaine.org/rss2.xml' par l’URL de votre fichier. Il est préférable de choisir le format contenant le plus d’informations, c’est pourquoi je préconise que ce soit le fichier RSS 2.0 [7].

Nom et emplacement des fichiers de syndication :

Si vous voulez donner un autre nom au fichier de syndication édité ou un autre emplacement que la racine du site, vous devez modifier dans "maker.php" :
- la ligne 104 pour le fichier Atom 0.3,
- la ligne 142 pour le fichier Atom 1.0,
- la ligne 276 pour le fichier RSS 0.91,
- la ligne 187 pour le fichier RSS 1.0,
- la ligne 232 pour le fichier RSS 2.0,
- la ligne 309 pour le fichier HTML,
- la ligne 342 pour le fichier Javascript.

Ne pas éditer l’un des fichiers de syndication :

Si certains fichiers de syndication ne vous intéressent pas, ce qui ce comprend facilement vu le nombre de formats proposés, on ne va éditer que les formats choisis. On peut bien sûr supprimer les lignes spécifiques au fichier non désiré dans "maker.php", mais il y a plus élégant : vous pouvez placer /* au début du code à supprimer et */ à la fin, ainsi ce code n’est plus considéré comme du PHP mais comme un commentaire, et si vous voulez par la suite vous en servir, vous n’aurez qu’à retirer ces caractères. Voici où les placer :
- /* ligne 70, /* ligne 106 pour ne pas éditer le fichier Atom 0.3,
- /* ligne 108, /* ligne 144 pour ne pas éditer le fichier Atom 1.0,
- /* ligne 239, /* ligne 278 pour ne pas éditer le fichier RSS 0.91,
- /* ligne 146, /* ligne 189 pour ne pas éditer le fichier RSS 1.0,
- /* ligne 191, /* ligne 234 pour ne pas éditer le fichier RSS 2.0,
- /* ligne 280, /* ligne 311 pour ne pas éditer le fichier HTML,
- /* ligne 316, /* ligne 343 pour ne pas éditer le fichier Javascript.

Autres modifications

Les explications de l’article Editer plusieurs fichiers de syndication 2/3 sont valables pour cette nouvelle version de l’éditeur, notamment pour :

- l’adaptation du nombre d’items,
- la suppression d’éléments non désirés,
- ou la mise en forme des fichiers HTML et Javascript.

Conclusion

Avec cette troisième version, l’Editeur de fichiers de syndication est plus complet. Certes, il n’est pas automatique comme la syndication de SPIP, mais il est facile à mettre en œuvre et réalise des fichiers conformes aux spécifications RSS et Atom.

Une prochaine version (en préparation) utilisera la classe fil_LE et une interface plus dynamique.

 


 

 

[1] Attention, le fonctionnement de ce script nécessite PHP :

- la page du script doit avoir l’extension .php ou .php3,
- cette page doit être placée sur un serveur interprétant le PHP.

[2] Explications sur les formats en anglais :
- Histoire et comparaison des formats : What is RSS ?
- RDF Site Summary (RSS) 1.0
- RSS 2.0 Specification
- et en français : RSS 2.0
- Web Sémantique RSS
- Construction d’un fil RSS 1.0.

[3] Explications sur les formats en anglais :
- The Atom Syndication Format 0.3
- The Atom Syndication Format 1.0.

[4] Voir Editer plusieurs fichiers de syndication 1/3, certains fichiers ont été modifiés depuis la version précédente.

[5] Si ces fichiers ne sont pas dans le même répertoire, il faut indiquer dans le code de maker.php le chemin vers les fichiers easyRSS_maker... et easyRSS_reader_2.inc.php.

[6] Voyez pour cela l’article Contrôler l’accès d’une partie du site avec .htaccess.

[7] Le fichier RSS 1.0 contient les mêmes informations, mais la version actuelle du lecteur ne récupère pas les dimensions de l’image, quant au format Atom 1.0 il ne contient aucune information sur l’image.


Document joint à l'article

Editeur_3.zip - Ce document contient tous les fichiers nécessaires au fonctionnement de l’éditeur de flux

Cliquez ici pour réagir à cet article

Imprimer Imprimer cet article


Réactions à l'article :