Entités et notations dans les DTD - Pearson

7Entités et notationsdans les DTDLes entités sont simplement des entrées textuelles automatiques,c’est-à-dire des raccourcis d’écriture. Grâce à elles, vous pouvezassocier un nom à un texte qui sera substitué à l’entité à chaque foisqu’elle apparaît dans le document.Il existe plusieurs types d’entités qui fonctionnent toutes de la mêmefaçon et qui sont toutes définies au sein d’une DTD. Leurs différencesportent sur les endroits où la substitution pourra avoir lieu et sur le typede données qu’elles peuvent contenir.Ces types peuvent être classés en deux catégories : les entités généraleset les entités paramètres. Les premières ne peuvent être substituées quedans un document XML, tandis que les secondes ne peuvent l’être quedans une DTD.Les entités générales peuvent elles-mêmes être subdivisées en entitésinternes et externes, analysées ou non analysées. Les entités paramètrespeuvent aussi être subdivisées en entités internes et externes, mais ellessont toujours analysées.

92Petit manuel de prise en main de XMLCréer une entité généraleLa forme d’entité la plus simple est définie dans uneDTD et représente simplement du texte. Officiellement,on les appelle entités générales internes, maison les désigne souvent sous le terme de raccourcis.Ces entités sont créées à l’aide de la syntaxe, où nom_ent est lenom que l’on souhaite donner à l’entité et qui seracelui sous lequel elle sera désignée dans le documentXML ; contenu est le texte qui sera substituéà l’entité dans le document.dtdFigure 7.1 Les entités générales internes facilitentl’inclusion de phrases longues qui reviennent souventdans un document XML.CONSEILS• Le nom de l'entité doit respecter les règles desnoms XML valides.• En XML, il existe déjà cinq entités généralesprédéfi nies : &, <, >, " et&apost; (voir page 14). Toutes les autresentités doivent être déclarées dans la DTDavant leur utilisation.• De nombreuses entités courantes ont déjà étédéfi nies, prêtes à être incluses dans vos propresDTD. Pour plus de détails, voir les conseils dela page 95.

Chapitre 7Entités et notations dans les DTD 93xmlLe fait le plus intéressant à propos desjardins est qu’il existe une forte controversesur leur existence même...Dans tous les cas, il est intéressant de noterque l’imagination des poètes et des ancienshistoriens a créé l’une des sept &mdm;.Figure 7.2 Il est plus simple et plus rapide de taper &mdm;que merveilles du monde.htmlLES JARDINS SUSPENDUS DE BABYLONELes jardins suspendus de Babylone a étéconstruit en 600 BCet détruit(e) par un tremblement de terre en226 BC....Le fait le plus intéressant à propos des jardinsest qu’il existe une forte controverse sur leurexistence même...Dans tous les cas, il est intéressant de noterque l’imagination des poètes et des ancienshistoriensa créé l’une des sept merveilles du monde....Utiliser les entités généralesPour utiliser dans un document XML une entité quevous avez définie dans une DTD, il suffit de préfixerson nom par une esperluette (&) et de le faire suivred’un point-virgule (;) : l’entité no_ent, par exemple,s’utilisera donc sous la forme &no_ent;.CONSEILS• Vous ne pouvez utiliser une entité générale que sielle a été défi nie dans la DTD utilisée par votredocument XML. Dans le cas contraire, le processeuraffi rmera qu'elle n'existe pas.• Les références de caractères permettent d'ajouterdes symboles spéciaux : &246;, par exemple,produit le caractère ö. Bien qu’elles leur ressemblent,ce ne sont pas des entités et elles n’ont pasbesoin d’être déclarées dans la DTD (voirAnnexe B).• Les entités générales ne peuvent être utilisées quepar les documents XML, pas par les feuilles XSLT(il existe des moyens de contourner cette restriction,mais ils sont complexes et lourds).• Vous pouvez utiliser une entité dans une autredéfi nition d'entité du moment que cela n'induitpas de référence cyclique.Figure 7.3 L’entité de la Figure 7.2 est substituéelors de l’analyse du document XML.

94Petit manuel de prise en main de XMLCréer une entité généraleexterneSi le texte de votre entité est plus long ou si elle doitpouvoir être utilisée dans plusieurs DTD, il estsouvent plus pratique de la sauvegarder dans unfichier séparé portant l’extension .ent.Quand vous aurez besoin de cette entité dans uneDTD, il suffira d’utiliser la syntaxe , où nom_ent est le nomde l’entité, SYSTEM indique qu’il s’agit d’une entitéexterne et entite.uri est l’emplacement du fichiercomprenant le contenu de cette entité.CONSEILS• entite.uri peut désigner un fi chier local à votreordinateur ou un fi chier situé sur une machine duréseau local ou sur Internet.• L'extension .ent n’est pas obligatoire (n’importequelle autre extension convient), mais c’est laplus employée.• Grâce aux entités externes, vous pouvez en faitcréer une DTD à partir de plusieurs autres.dtdLe fait le plus intéressant à propos desjardins est qu’il existe une forte controversesur leur existence même....Dans tous les cas, il est intéressant de noterque l’imagination des poètes et des ancienshistoriens a créé l’une des sept &mdm;.Figure 7.4 Ici, on définit l’entité pour qu’elle représente uneportion de texte XML complète. Vous remarquerez qu’elleinclut l’entité mdm définie à la Figure 7.1. Ce texte est sauvegardédans le fichier jardins.ent.dtdFigure 7.5 L’entité histoire_jardins pointe vers l’URI dufichier contenant le texte de l’entité.

Chapitre 7Entités et notations dans les DTD 95xml...Les jardinssuspendus de BabyloneAl Hillah en Irak0600226tremblement de terre&histoire_jardins;...Figure 7.6 Assurez-vous de placer standalone=”no” dansla déclaration XML. Vous pouvez ensuite utiliser l’entitégénérale externe &histoire_jardins; dans le document.Utiliser les entités généralesexternesUne entité externe peut être utilisée et partagée avecd’autres utilisateurs. Vous pouvez également emprunterleurs entités externes.Pour utiliser une entité générale externe, vous devezajouter standalone=”no” à la déclaration XML,comme à la Figure 7.6. Cette directive indique auprocesseur que le document a besoin d’un fichierexterne ; ici, celui qui contient la définition de l’entité.Ensuite, l’entité s’utilise exactement comme uneentité interne.CONSEILS• Une URI (Uniform Resource Identifier) est unechaîne de caractères permettant d’identifi er et delocaliser une ressource. On la confond souventavec une URL (Uniform Resource Locator) bienque, techniquement, une URI puisse être une URLou un URN (Universal Resource Name). Dans lecadre de ce livre, URI et URL ont la même signification.• Vous pouvez utiliser un lien vers une liste d'enti tésstandard, comme www.w3.org/TR/xhtml1/#h-A2.Cela vous permet d’utiliser des références d’enti tésmnémotechniques pour les caractères accentuéssans devoir les défi nir vous-même.• Une entité générale (comme celles que nous avonsdécrites dans les pages précédentes) est défi niecomme une composante de la DTD et est utiliséedans un document XML. Il existe un autre typed'entité qui permet d'ajouter du contenu à la DTDelle-même. Ces entités sont appelées entités paramètreset utilisent une syntaxe un peu différente(voir la section "Créer et utiliser des entitésparamètres", plus loin dans ce chapitre).Figure 7.7 L’entité définie à la Figure 7.5 contient un élément,du texte et une autre entité. Le principe est le même :on tape un texte court et le processeur le remplace par lecontenu qu’il désigne. Notez que tous les éléments provenantd’une entité générale externe doivent quand même être définisdans la DTD pour que le document soit valide.

96Petit manuel de prise en main de XMLCréer des entités pourdu contenu non analyséPour l’instant, nous n’avons présenté que des entitésreprésentant du texte. Celles-ci sont également appeléesentités analysées car le processeur les lit et lesanalyse pendant le parcours du document XML. Lesentités non analysées, que nous allons étudier ici, nereprésentent généralement pas du texte (bien qu’ellesle puissent) et sont totalement ignorées du processeur.Elles peuvent donc servir à intégrer du contenunon textuel ou non XML dans un document XML.Il peut s’agir de n’importe quoi : du texte, un fichierimage ou vidéo, un document PDF, etc.Pour créer une entité représentant ce type de contenu,il faut d’abord indiquer dans une DTD comment letraiter à l’aide d’une notation. La syntaxe d’unenotation est de la forme , où nom_n est le nom permettant d’identifierle contenu non analysé, instr_n est généralementune information (comme une URI) qui définit letraitement du contenu (il n’existe pas de formatofficiel et vous devez donc consulter la documentationde votre processeur XML pour plus de détails).Pour définir une entité désignant un contenu nonanalysé, on utilise la syntaxe , où entité.uridésigne l’emplacement du fichier du contenu nonanalysé et nom_n est le nom de la notation crééeprécédemment.CONSEILS• Lors de la création de la notation, instr_notationpeut être un type MIME (qui est un standardInternet permettant de décrire des types decontenus), une URI pointant vers une applicationinterne ou externe capable de traiter le contenunon analysé, ou quasiment n’importe quoi (celan’a aucune importance puisque le processeurXML ne le traite pas). Selon la spécifi cation duW3C, il n’existe pas de format standard pourcette information et chaque application XMLpeut l’utiliser comme elle le souhaite.• Les entités non analysées sont nécessairementdes entités générales car elles sont intégréesau corps d'un document XML.Figure 7.8 Une donnée non analysée classique : une imageJPEG, stockée dans le fichier lighthouse.jpg.dtdFigure 7.9 Le nom identifiant l’élément de notation jpgsera utilisé lors de la création de l’entité pour le contenunon analysé.dtdFigure 7.10 Le nom de l’entité, image_phare, fait référenceà un fichier externe, appelé lighthouse.jpg. On peut obtenirplus d’informations sur ce fichier en examinant l’identifiantde notation jpg.