Comment utiliser le guide de référence de l’IITA

Le guide de référence de l’IITA est un document de nature technique. Il découle de notre « référentiel unique de données » (single source of truth) qui constitue lui-même l’épine dorsale de notre norme de données. Vous y trouverez des descriptions complètes des nombreux éléments couverts par la norme.

Le guide de référence vous aidera à créer des fichiers XML correctement structurés et formés, et conformes à la norme. Vous vous y référerez comme à une notice d’utilisation.

Si vous utilisez un outil de publication compatible avec la norme, les champs de saisie des données seront certainement déjà disponibles. Vous n’aurez donc pas à vous soucier de la structure de vos fichiers ni à consulter le document de référence. Les définitions figurant dans le guide de référence pourraient toutefois vous être utiles.

Contenu du guide de référence

Le guide de référence présente le schéma, les listes de codes, les éléments et les attributs de l’IITA. Il contient également des informations sur les espaces de noms, les extensions et les jeux de règles.

Schéma

• Le schéma contient la liste de tous les éléments de données présentés dans l’ordre prescrit. Pour chaque élément, une page est créée. Elle contient une définition, les règles à suivre et toute autre information utile. C’est le modèle à suivre pour présenter chaque élément.

Listes de codes

• Les données que vous soumettez à l’IITA sont présentées sous forme de texte libre, ou bien de valeurs ou codes définis. Les codes sont assortis d’un attribut et utilisés lorsque les champs n’acceptent qu’un nombre limité d’options. Par exemple, le nombre de langues possibles est limité et chacune possède son propre code. Les listes de codes de l’IITA contiennent les noms et les descriptions de toutes les valeurs disponibles.

Éléments

• Les éléments vous permettent d’apporter des précisions :
  • par exemple, <title> (titre) est un élément ;
  • l’information qui le suit vous donne donc le titre de l’activité.
• Chaque élément peut avoir un sous-élément qui précise encore davantage les informations :
  • par exemple, dans l’élément <title> (titre), vous pouvez ajouter un élément <narrative> (texte libre) ;
  • dans l’élément <narrative> (texte libre), vous pouvez préciser le titre de votre activité sous forme de texte.

Attributs

• Les attributs sont un ensemble de valeurs qui apportent des informations sur un élément. Chaque élément peut avoir un ou plusieurs attributs, par exemple :
  • l’élément <narrative> (texte libre) possède l’attribut @xml:lang ;
  • cet attribut vous permet de préciser la langue dans laquelle est rédigé votre texte ;
  • il existe une valeur (ou code) pour chaque langue, par exemple, « fr » pour le français.

Exemple d’utilisation :

<title> (début du titre)

<narrative xml:lang="fr">Titre de l’activité</narrative>

</title> (fin du titre)

Documentation plus avancée

Si vous souhaitez compléter le schéma IITA selon vos besoins ou créer un outil de validation sur mesure pour vos publications IITA, ces pages vous seront utiles :

Espaces de noms et extensions

• Ces méthodes permettent de publier des informations qui ne sont pas encore couvertes par les éléments de l’IITA.

Jeux de règles

• Les jeux de règles permettent de vérifier la conformité d’un fichier XML à la norme de l’IITA.

Utiliser le guide de référence de l’IITA avec un outil de publication

Si vous utilisez un outil de publication, vous n’avez presque pas à vous préoccuper de la dimension technique. L’intérêt du guide de référence réside alors essentiellement dans ses définitions.

Pour trouver la définition d’un élément ou d’un attribut, vous pouvez :

• ouvrir la documentation IITA relative aux activités ou aux organisations et sélectionner l’élément que vous souhaitez consulter ou qui contient l’attribut recherché ;
• ou utiliser la fonction de recherche, p. ex., en saisissant « IATI Standard Title » (Titre dans la norme de l’IITA).

Pour trouver la définition d’une valeur dans une liste de codes, vous pouvez :

• ouvrir la page des listes de codes de l’IITA et sélectionner la liste de codes qui vous intéresse .
• ou utiliser la fonction de recherche pour trouver la liste de codes en question, p. ex., en saisissant « IATI Standard Language Codelist » (Listes des codes des langues de la norme de l’IITA).

La plupart des outils de publication proposent un modèle ou un formulaire pour saisir vos données. Vous n’avez donc pas à vous soucier de leur structure.

Habituellement, ces outils contiennent aussi des informations et des fonctions de vérification sur les règles à suivre. En cas d’échec de validation de votre fichier XML, vérifiez la règle applicable depuis la page consacrée à cet élément dans le guide de référence de l’IITA.