Structure des sources xml

L'élément racine <documents>

Toute source xml au format ULB doit contenir un élément racine appelé <documents> (en d'autres termes, on doit trouver une balise ouvrante <documents> au début de la source xml, et une balise fermante </documents> tout à la fin de la source xml).

Contenu:

L'élément racine <documents> ne peut contenir que des éléments <document> (au minimum 1). Ces éléments peuvent éventuellement être précédés d'éléments <contenu-bloc>, <contenu-toc> ou <contenu-texte> utilisé pour des inclusions de code xml, ainsi que des éléments <options> pour définir des options.

Attributs:

L'élément <documents> peut posséder (c'est facultatif) les attributs suivants:

• page-accueil-fr qui pointe vers la page d'accueil destinées aux pages rédigées en français (via son identificateur).

• page-accueil-en qui pointe vers la homepage destinées aux pages rédigées en anglais (via son identificateur).

• langue qui indique la langue par défaut utilisée dans toutes les pages contenues dans l'élément <documents>. Remarque: si vos pages sont écrites dans plusieurs langues différentes, vous pourrez utiliser ce même attribut au niveau des éléments <document> et/ou <page>.

  Cet attribut peut valoir:

  • "fr" pour le français

  • "en" pour l'anglais

  • "nl" pour le néerlandais

  • "zh" pour le chinois

<?xml version="1.0" encoding="UTF-8"?>
<documents page-accueil-fr="ulb:format-xml:index" langue="fr">
   <document>
   ...
   </document>
</documents>

Les éléments <document>

Chaque élément <document> contient la définition d'une ou plusieurs pages représentées par des éléments <page> (les avantages de cette structure sont décrits ici, elle permet notamment de lier les pages entre-elles par des liens du type page suivante/page précédente).

Contenu:

Un élément <document> peut contenir (dans cet ordre) :

• un élément facultatif <info> qui donne les méta-informations sur le document (titre, description et mots-clés) qui sont notamment utilisées par les moteurs de recherche;

• des éléments facultatifs <options> pour définir des options (qui servent à afficher ou non des sections optionnelles);

• un ou plusieurs éléments <page> pour chaque page html à produire.

Attributs:

Un élément <document> peut posséder les attributs (facultatifs) suivants:

• docref qui sert à construire l'identificateur des pages html à produire. Attention! deux documents ne peuvent pas avoir le même docref.

• filename qui sert à construire le nom des pages html à produire. Attention! deux documents ne peuvent pas avoir le même filename.

• sommaire qui renseigne sur la page qui servira de sommaire (via son identificateur).

• index qui renseigne sur la page qui servira d'index (via son identificateur).

• langue qui indique la langue par défaut utilisée dans toutes les pages contenues dans l'élément <document> (soit "fr" pour le français, soit "en" pour l'anglais). Remarque: si vos pages sont écrites dans des langues différentes, vous pourrez utiliser ce même attribut au niveau des éléments <page>.

• version-fr ou version-en qui renseignent sur les versions française ou anglaise du présent document (via leur identificateur).

<?xml version="1.0" encoding="UTF-8"?>
<documents>
   <document docref="demo" filename="demo" langue="fr" version-en="demo-anglais">
      <info>
        <titre>Manuel d'utilisation de l'intranet xml</titre>
        <mots-clés>aide, XML, exemple, manuel</mots-clés>
        <description>manuel décrivant la structure des documents XML sources utilisés à l'ULB</description>
      </info>

      <page>
         ...
      </page>
      <page>
         ...
      </page>
   </document>
</documents>

Les éléments <page>

Chaque élément <page> génère une seule page html. Le contenu de cet élément est constitué d'un ou plusieurs sous-éléments qui décrivent et qui mettent en page l'information à afficher.

Contenu:

Un élément <page> peut contenir (dans cet ordre) :

• un élément facultatif <info> , qui donne les méta-informations sur la page (titre, description et mots-clés). Par défaut, les informations définies au niveau du document seront utilisées;

• des éléments facultatifs <options> pour définir des options (qui servent à afficher ou non des sections optionnelles);

• Des éléments d'information dans une page (titres, paragraphes, images...) qui définissent réellement le contenu de la page (ceux-ci apparaitrons sur une seule colonne, en pleine largeur), ainsi que des éléments <zones> qui permettent de découper la page en plusieurs colonnes et d'afficher des éléments d'information dans ces colonnes.

Attributs:

L'élément <page> peut posséder les attributs (facultatifs) suivants:

• docref qui sert à construire l'identificateur de la page générée. Attention! deux pages ne peuvent pas avoir le même docref.

• filename qui sert à construire le nom de la page générée. Attention! deux pages ne peuvent pas avoir le même filename.

• sommaire qui renseigne sur la page qui servira de sommaire (via son identificateur).

• index qui renseigne sur la page qui servira d'index (via son identificateur).

• type qui définit le type de la page (normal, sommaire, index ou annexe) et la relation qu'elle a avec les autres pages du document.

• version-fr et version-en qui renseignent sur les versions française ou anglaise de la page courante (via leur identificateur).

• langue qui indique la langue utilisée dans la page.

<?xml version="1.0" encoding="UTF-8"?>
<documents>
   <document docref="demo">
      <page langue="fr" docref="demo-francais-page1" version-en="demo-anglais-page1">
         <info>
            <titre>Manuel d'utilisation de l'intranet xml</titre>
            <mots-clés>aide, XML, exemple, manuel</mots-clés>
            <description>manuel décrivant la structure des documents XML sources utilisés à l'ULB</description>
         </info>
         <titre1>Comment utiliser l'intranet xml?</titre1>
         <p>...</p>          
         <p>...</p>          
         ...
      </page>
      <page langue="fr" docref="demo-francais-page2" version-en="demo-anglais-page2">
         <titre1>...</titre1>
         <p>...</p>          
         <p>...</p>          
         ...
      </page>
   </document>
</documents>