Un document XML comme source: <source-xml>

L'élément <source-xml> permet de sélectionner des informations (actualités, annonces, événements...) dans un document écrit dans un format xml particulier.

Celui-ci peut être créé et modifié "manuellement", par exemple dans une source xml de votre projet dans Sitemanager, ou être généré automatiquement par l'une de vos applications web.

On peut également utiliser les attributs suivants (qui sont communs à toutes les sources):

Sous-éléments de <source-xml>

Un élément <source-xml> peut contenir l'un ou l'autre des éléments suivants (qui sont communs à toutes les sources):

Le format d'une source xml

Dans une source xml, l'élément principal s'appelle <valves>. Son contenu peut commencer par un élément <canal> qui décrit la source (à l'aide de sous-éléments <titre>, <description>, <lien> et <vignette>).

Cet élément <valves> contient ensuite toutes les informations, les unes à la suite des autres. Ces informations sont encodées dans des éléments dont le nom reflète le type de l'information.

On distingue:

• <information>: pour des informations générales;

• <document>: pour des documents (PDF, Word, etc.);

• <actualité>: pour des actualités;

• <message>: pour des messages (valves étudiant, etc.);

• <portrait>: pour des portraits de personne sous forme d'article;

• <événement>: pour des événements;

• <podcast>: pour des descriptions de podcast;

• <illustration>: pour des illustrations dans une gallerie de photos;

• <article>: pour des articles dans une newsletter;

• <annonce>: pour des annonces;

• <publication>: pour des publications;

• <fiche>: pour des fiches;

Ces éléments contiennent des sous-éléments qui vont définir les données propres à chaque information (<titre>, <aperçu>, <contenu>, <auteur>...).

Vous trouverez ici le détail de ce format ainsi qu'un exemple de document.

Les données disponibles dans une source xml

Dans une source XML, les données disponibles qui peuvent être sélectionnées pour l'affichage sont:

• l'identificateur de l'information qui est repris sous l'attribut id="..." de l'information.

• le titre de l'information qui est repris sous l'élément <titre> de l'information (qui ne contient que du texte);

• le contenu de l'information qui est repris sous l'élément <contenu> de l'information (qui peut contenir du code HTML simplifié pour le mettre forme);

• l'aperçu de l'information qui est repris sous l'élément <aperçu> de l'information (qui peut contenir du code HTML simplifié pour le mettre forme);

• la vignette de l'information qui est reprise sous l'élément <vignette> de l'information;

• l'illustration de l'information qui est reprise sous l'élément <illustration> de l'information;

• un ou plusieurs fichiers attachés à l'information qui sont repris sous des éléments <fichier-attaché> de l'information;

• le type de l'information qui est donné par le nom de l'élément qui définit l'information (voir ci-dessus);

• la priorité de l'information qui est reprise sous l'attribut priorité="..." de l'information dont la valeur est un nombre entier supérieur ou égal à 0. Par défaut, si vous ne mentionnez pas cet attribut, la priorité est égale à 1;

• une ou plusieurs familles de catégories reprises sous des éléments <catégories> (pour la famille principale) ou <catégories id="xxxx"> (pour les autres familles) de l'information. Chacun de ces éléments contiennent à leur tour des éléments <catégorie> qui définissent les catégories associées à l'information;

• l'auteur de l'information qui est repris sous l'élément <auteur> de l'information;

• la date de publication qui est repris sous l'attribut date-publication="..." de l'information;

• la date de modification qui est repris sous l'attribut date-modification="..." de l'information;

• la date de début qui est repris sous l'attribut date-début="..." de l'information;

• la date de fin qui est repris sous l'attribut date-fin="..." de l'information;

• le lien associé à l'information qui est repris sous l'élément <lien> de l'information;

Au niveau de la source, on retrouve également les données suivantes (ces données, qui peuvent être affichées pour chaque information, ne varient pas d'une information à l'autre):

• le titre de la source qui est repris sous l'élément <titre> de l'élément <canal>;

• la description de la source qui est repris sous l'élément <description> de l'élément <canal>;

• le lien de la source qui est repris sous l'élément <lien> de l'élément <canal>;

• la vignette de la source qui est repris sous l'élément <vignette> de l'élément <canal>;

• la date de publication de la source qui est repris sous l'attribut date-publication="..." de l'élément <valves>;

• la date de modification de la source qui est repris sous l'attribut date-modification="..." de l'élément <valves>;

• la date de lecture de la source qui est la date et l'heure à laquelle la source a été interrogée pour la dernière fois, qui peut différer de la date de publication (à cause du mécanisme de mise en cache).

Vous pouvez également donner une valeur par défaut ou forcer la valeur du titre, de la description, du lien et de la vignette de la source.

Catégories utilisées dans une source XML

Une information peut être classées dans une ou plusieurs catégories organisées en une ou plusieurs familles. Parmi ces familles, une joue le rôle de la famille principale (elle s'utilise sans identificateur).

Dans le cas d'une source au format XML, la famille principale est définie par une élément <catégories> sans attribut.

Vous pouvez définir autant de familles de catégories que vous désirez, en réutilisant ce même élément, mais avec un attribut id qui va donner l'identificateur des familles en question: <catégories id="xxxx">.

Les catégories auxquelles appartient l'information sont mentionnées dans des éléments <catégorie> placés au sein de ces éléments <catégories>.