Date de publication: le mardi 7 août 2007 à 21h54
Dernière modification: par Pascal BOYER le vendredi 12 février 2010 à 11h27

Cet article est basé sur les informations trouvées dans la version 1.2 du document ezwebin_setup.pdf proposé en téléchargement sur le site officiel ez.no .

En plus de la traduction du texte tiré du document ezwebin_setup.pdf vous trouverez les informations complémentaires que j'ai ajoutées.

A noter également cette série d'articles (en anglais) très intéressante sur le sujet: How to Import and Export RSS Feeds

Configuring RSS feeds / Configurer des flux RSS

If you want to provide visitors with the ability to subscribe to RSS feeds from your site, you must create an RSS export feed via the Administration Interface. First, log in to the Administration Interface with your “admin” username and password. Next, click the Setup link in the horizontal navigation menu, and select RSS from the left navigation menu:
Si vous souhaitez offrir à vos visiteurs la possibilité de s'abonner à des flux RSS de votre site, vous devez créer, à partir de l'interface d'administration, des exportations de flux RSS. Pour cela, commencez par vous loguer à l'interface d'administration avec l'identifiant et le mot de passe de l'administrateur. Cliquez ensuite sur l'onglet Administration du menu horizontal puis, dans le menu gauche, sur le lien Syndication:

Fig. 1: Accès à la gestion des flux RSS à partir du menu gauche de l'onglet Administration

A list of existing RSS exports and imports (if any) will be displayed:
Une liste des flux RSS exportés et importés existants (s'il y en a) sera affichée:

Fig. 2: Listes des flux RSS exportés et importés (vide dans l'exemple illustré ci-dessus)

Click the New export button to create an RSS feed that you can incorporate into the web pages on your site (via the Site settings, described below).
Cliquez sur le bouton Nouvel export pour créer le nouveau flux RSS que vous souhaitez inclure aux pages de votre site:

Fig. 3: Interface d'édition de l'exportation d'un flux RSS

Description de l'interface d'édition d'un flux à exporter

An RSS export includes these attributes:
L'interface d'édition d'une exportation de flux RSS est composée des champs suivants

• Nom:
  The name of the feed.
  Le nom du flux.

• Description:
  A short description of the feed.
  Une courte description du flux.

• URL du site:
  Enter the base URL of your site (as specified on the Site Details page in the Setup Wizard). This generates the URL links in the export, constructed by combining the Site URL (ie, "http://www.example.com/") and the path to the individual object (configured in the source, for example "/articles/my_article"). The Site URL varies based on your web server and eZ Publish configuration.
  L'URI de base de votre site (tel que spécifié dans la page Site Details de l'interface graphique d'installation). Cela génère le lien URI de l'exportation en combinant l'URI du site (par exemple http://www.exemple.com) avec le chemin de l'objet (par exemple /article/nom_article). L'URI du site varie bien entendu en fonction de votre serveur et de la configuration de eZ Publish.

• Image:
  A thumbnail image representing the RSS feed and / or your web site. The suggested dimensions are 64x64 pixels.
  Une vignette représentant le flux RSS et/ou votre site web. La dimension suggérée pour cette vignette est de 64x64 pixels. Retenez que cette vignette ne peut être exporter de votre PC sur le serveur où elle doit donc être déjà présente (vraisemblablement dans l'onglet Médiathèque) avant d'être sélectionnée.

• Version RSS:
  There are currently two versions of the RSS protocol: 1.0 and 2.0. Refer to Wikipedia for more information about RSS: http://en.wikipedia.org/wiki/RSS_(file_format). eZ Publish supports both versions. Choose which format your RSS feed should use. In general, unless you specifically need to support older clients, use version 2.0.
  Il existe actuellement deux versions du protocole RSS: 1.0 et 2.0. Référez-vous à cet article de l'encyclopédie en ligne Wikipédia pour plus d'informations sur RSS. eZ Publish supportant les deux versions du protocole, vous devez choisir celle qu'utilisera votre flux exporté. En général, à moins de devoir être compatible avec les anciens clients, choisissez la version 2.0

• Nombre d'bjets:
  Specify the number of objects the RSS feed should contain. To avoid performance issues with RSS clients, this number should not be too large (for example, 10 - 20).
  Indique le nombre d'objets que le flux RSS doit contenir. Pour éviter que les clients RSS rencontrent des problèmes de performances, ce nombre ne doit pas être trop important (entre 10 et 20).

• Actif:
  Activate and deactivate the RSS feed with this control. If the feed is deactivated but still referenced in the site settings, the user's RSS client will display an eZ Publish kernel error (for example, “kernel (3) / Error, The requested page could not be displayed. (3)”).
  Activez ou désactivez le flux RSS avec cette option. si le flux est désactivé mais encore référencé dans les paramètres du site, alors les clients RSS des utilisateurs afficheront un message d'erreur produit par le noyau de eZ Publish ( par exemple: “kernel (3) / Error, The requested page could not be displayed. (3)”)

• Noeud principal uniquement:
  If this option is enabled, only changes to the “main” node of an object will be added to the feed. For example, an article may have three “locations” in the content tree. If RSS is enabled for each of those locations, the article will be added to three feeds. If this option is enabled, it will only be added to the RSS feed for the object's “main” location.
  Si cette option est activée, seules les modifications du noeud principal d'un objet seront ajoutées au flux. Par exemple, un article peut avoir 3 emplacements dans l'arbre de contenus. Si le flux RSS est activé pour chacun de ces emplacements, alors l'article sera ajouté aux trois flux. Par contre, si cette option est désactivée, alors l'article ne sera ajouté qu'au flux RSS de l'emplacement principal de l'objet.

• URL d'accès:
  This option specifies the URL to this RSS feed.
  Ce champ spécifie l'URI au moyen duquel on accèdera au flux RSS.

• Source 1:
  Each RSS feed can contain multiple source nodes that get added to the RSS feed. By default, the fields for configuring a single source node (Source 1) are displayed. To add additional nodes, click the Add source button:
  Chaque flux RSS peut contenir/exporter plusieurs sources de noeuds qui seront tous ajoutés au flux. Par défaut, seuls les champs servant à configurer une seule source de noeuds (Source 1) sont affichés. Pour ajouter des noeuds, cliquez sur le bouton Ajouter une source:

Fig. 4: Deux sources sont nécessaires pour ajouter deux classes d'objets à un même flux

To delete an existing source from the feed, click Remove this source.
Pour supprimer une source existante du flux, cliquez sur le bouton Supprimer cette source.

Configurer une source

To configure a source, enter data in the fields as follows:
Pour configurer une source, saisissez les données dans les champs comme indiqué ci-après:

• Chemin source:
  The location in the content tree from where feed items will be collected.
  L'emplacement, dans l'arbre de contenus, des éléments du flux qui seront collectés.

• Sous-noeuds:
  Specify whether or not nodes beneath the Source path nodes in the content hierarchy should be included in the feed.
  Indique, si oui ou non, les noeuds situés sous les noeuds indiqués par le champ Chemin source doivent être inclus au flux.

• Classe:
  Specify the content class that should be added to the feed. To specify multiple content classes, click the button Add source, specify the same URL, but specify a different content class.
  Indique les classes de contenus devant être ajoutées au flux. Pour spécifier plusieurs classes de contenus, cliquez sur le bouton Ajouter une source (voir figure 4) puis indiquez le même Chemin source mais une classe différente.

:
Chaque fois que vous sélectionnez une classe, validez en cliquant sur le bouton Assigner:

• Titre:
  Specify the attribute in the content object that will be used as a title for the element. The most common title attributes are “title”, “name” and “short name”, but other attributes might be preferred for different content classes.
  Spécifiez l'attribut de l'objet devant être utilisé en tant que titre de l'élément exporté. Les attributs les plus couramment employés pour cela sont titre, nom et nom_court, mais d'autres attributs peuvent bien sûr être choisis.

• Description:
  Specify the attribute in the content object that will be used as a description for the element. The most common description attributes are “short description”, “description” and “summary”, but other attributes might be preferred for different content classes.
  Spécifiez l'attribut de l'objet devant être utilisé comme description de l'élément exporté. Les attributs les plus couramment employés pour cela sont description, description_courte et resume, mais d'autres attributs peuvent bien sûr être choisis.

Une fois tous les champs renseignés, vous validez votre nouveau flux en cliquant sur le bouton OK.

Visualiser les flux exportés

L'action sur le bouton Ok renvoie à la liste générale des flux importés et exportés dans laquelle apparaît le nouveau flux:

Fig. 5: Affichage du nouveau flux exporté dans la liste générale des flux importés et exportés

Vous pouvez contrôler le bon fonctionnement de votre nouveau flux en l'affichant soit:

dans l'interface d'administration...

...auquel cas vous cliquez, dans le cadre présenté par la figure 5, directement sur le nom du flux:

Fig. 6: Message d'erreur obtenu si on oublie de cliquer sur le bouton Assigner lorsqu'on sélectionne une classe à ajouter au flux

Si vous obtenez ce message d'erreur, éditez à nouveau votre flux et pour chaque source exportée, cliquez sur le bouton Assigner du champ Classe. Validez avec le bouton OK puis cliquez à nouveau, dans le cadre présenté par la figure 5, directement sur le nom du flux:

Fig. 7: Affichage, dans l'interface d'administration, du fichier XML produit par le nouveau flux RSS

:
Dans l'interface d'administration, les objets cachés s'affichent dans la liste des éléments du flux mais pas lorsqu'on accède à ce même fichier XML à partir du site public (à moins que le paramètre ShowHiddenNodes de la section SiteAccessSettings du fichier site.ini.append.php du siteaccess public soit positionné à true).

...soit:

sur le site public...

...en utilisant l'URI définit lors de la configuration du flux:

Fig. 8: Affichage, sur le site public, du fichier XML produit par le nouveau flux RSS

Dans l'article suivant, nous allons voir comment présenter aux visiteurs les flux de notre site.

Commentaires