Nom et intitulé sont deux façons différentes de désigner des éléments comme le corpus, les thésaurus, les sphères ou les champs d’un corpus.
Le nom correspond au « nom technique » de l’élément, il est attribué à la création de l’élément et ne peut plus être changé par la suite ; c’est le nom qui est utilisé par le logiciel pour manipuler l’élément, il répond à un certain nombre de contraintes afin de faciliter son traitement par des programmes informatiques. Ce nom est également utilisé dans certaines interfaces d’administration pour manipuler l’élément (par exemple, dans les interfaces qui permettent de changer l’ordre des éléments).
L’intitulé désigne l’élément pour l’utilisateur normal, c’est lui qui apparaît dans les différentes interfaces du logiciel. Il est complètement libre et peut être modifié n’importe quand, même bien après la création de l’élément et sans risque pour la cohérence des données et dans le cas de bases multilingues, un intitulé doit être défini pour chaque langue de travail.
Pour résumer, l’utilisateur normal ne connaît que les intitulés, la machine, elle, ne connaît que les noms et l’administrateur d’une base manipule les deux.
Contrainte sur le nom
Afin de faciliter les traitements informatiques, les noms ne peuvent comprendre que les minuscules de a à z ainsi que les chiffres de 0 à 9 (un nom ne peut cependant pas commencer par un chiffre). Masjucules et caractères accentués sont interdits, idem pour l’espace et tous les symboles + , = , - , etc.
Le trait de soulignement « _
» est parfois autorisé, parfois interdit (il est de toute façon interdit en début du nom). Il est interdit pour :
les noms de corpus,
les noms de thésaurus,
les noms de sphère,
les noms de champs.
Dans les autres cas (comme le nom de la base), il est autoriés.
Il y a interdiction lorsque les noms sont susceptibles d’être précédés d’un préfixe indiquant la nature de l’élément (par exemple, « corpus_ » pour les corpus, « thesaurus_ » pour les thésaurus). Le corpus « suivi » est ainsi souvent désigné par « corpus_suivi » . Ce préfixe permet de distinguer les homonymes. En effet, des éléments de nature différentes peuvent avoir le même nom : deux corpus ont des toujours des noms différents, alors qu’un corpus et un thésaurus peuvent avoir le même nom.
Un nom doit comporter plus d’un caractère et moins de trente.
Rappel : le nom est attributé à la création de l’élément et ne peut pas être modifié par la suite (sauf à plonger dans les fichiers de configuration).
Quelques règles de rédaction des noms
Les noms ne sont pas seulement utilisé par la machine, ils apparaissent tels quels dans de nombreuses interfaces d’administration et ce sont eux qui sont manipulés par le développeur XSLT (celui qui fait les modèles de passage des données à des pages HTML). Il est donc utile de suivre quelques règles dans la rédaction des noms qui faciliteront le travail par la suite :
1) Le nom doit rester compréhensible pour un être humain. Il n’est pas interdit d’appeler ses différents corpus « c1 » , « c2 » , « c3 » mais il faut s’attendre à quelques déboires par la suite. Le nom ne doit être ni trop court ni trop long. Sachant que le nom est souvent accompagné d’un préfixe indiquant la nature de l’élément, il est inutile de la préciser dans le nom de l’élément. Par exemple, le corpus des « Fiches de suivi » sera utilement nommé « suivi » , « fichesuivi » ou « corpussuivi » étant trop lourd (cela donnerait corpus_fichesuivi ou corpus_corpussuivi). Enfin, si la base est multilingue, on mettra les noms dans la langue commune aux administrateurs de la base.
2) Les homonymies doivent avoir une signification. Un corpus et un thésaurus peuvent avoir le même nom ; il est préférable de réserver ce cas aux corpus et thésaurus qui sont intimmement liés (c’est par exemple le cas des mots-clés Dossier dans les sites ressources qui sont complètés par des fiches Dossiers stockant un certain nombre d’information sur le dossier, comme la date ou l’auteur du dossier). Si un thésaurus est utilisé exclusivement pour un corpus donné, il est utile que son nom reprenne le nom du corpus. Par exemple, un mini-thésaurus servant à indiquer le type d’une fiche de suivi (nom du corpus « suivi » ) pourra être appelé (« typesuivi » ).
3) L’utilisation de noms identiques pour des champs qui ont la même fonction est chaudement recommandée. Par exemple, si la base comprend des fiches d’analyse et des fiches d’expérience et que ces deux formats de fiche ont un champ « Auteurs » , Nommer ces deux champs pareillement « information_auteurs » permettra au développeur XSLT qui fera les modèles de mise en forme HTML de concevoir des briques communes aux deux corpus, ce qui peut constituer un gain de temps dans le développement non négligeables.
4) Des éléments de syntaxe comme le « s » de la marque du pluriel peuvent servir à identifier rapidement les éléments. Par exemple, on peut décider que, comme un champ de type Propriété ne peut contenir qu’une seule information, son nom sera au singulier (exemple : « propriete_langue » ) alors qu’un champ de type Information aura un nom au pluriel (« information_langues » ) puisqu’il peut contenir plusieurs éléments.
5) Lorsque le format de la fiche comprend plusieurs champs représentant les différentes versions dans différentes langues d’une même information (par exemple, la biographie d’une personne en français, espagnol et anglais), il est fortement conseillé de construire les noms en accolant le code ISO de la langue à une racine commune (Les trois champs « Biographie en français » , « Biographie en espagnol » et « Biographie en anglais » de notre exemple seront nommés respectivement « biofr » , « bioen » et « bioes » ).
Les points précédents sont de simples recommadations. Chacun est libre de fixer sa propre convention de nommage (de la même manière, que chaque développeur informatique suit ses propres règles pour les noms des variables). Il est simplement recommandé de maintenir une cohérence d’ensemble pour les différents noms des éléments d’une base de fiches afin d’en faciliter la maintenance.