Manuel utilisateur de la ModulEst
Chapitre 1. Introduction
Chapitre 2. L'application
Chapitre 3. Le fichier XML
3.1. Description
3.2. Fichier XML type
Chapitre 4. Génération du module au format HTML
Chapitre 5. Ajouter du contenu
Annexe A DTD module (modxml.dtd)
Annexe B Liste des entités caractères utilisables
Page d'accueil Table des matières Niveau supérieur Page précédente Bas de la page Page suivante

3.1. Description

Les trois premières lignes du fichier XML sont toujours les mêmes :

     <?xml version="1.0" encoding="ISO-8859-1"?>
     <?xml-stylesheet href="output.xsl" type="text/xsl" ?>
     <!DOCTYPE module SYSTEM "../dtd/modxml.dtd">

Elles signifient que nous utilisons la version 1.0 du langage XML, que nous pouvons utiliser les caractères accentués ISO-Latin-1 1 à l'exception des cinq caractères du tableau 3.1, qui ont une signification particulière et qui doivent être saisis à l'aide de leur entité XML correspondante ; que le nom de la balise racine de notre document XML est module et que la DTD que nous utilisons se trouve dans le fichier modxml.dtd.

<
   &lt;  
>
   &gt;  
&
   &amp;  
'
   &apos; (si entre simple 'quote')
"
   &quot; (si entre double "quote")

Tableau 3.1&nbsp: Caractères spéciaux et entités correspondantes

 

Attention, si vous souhaitez réellement obtenir un & dans votre module au format HTML (sous entendu &amp; dans le source HTML), vous devez en fait saisir &amp;amp; dans le fichier XML. De la même manière, vous devez saisir &amp;lt; et &amp;gt; pour obtenir les caractères < et >. Ceci provient du fait qu'en HTML, tout comme en XML, il faut échapper ces caractères spéciaux utilisés pour les balises HTML et XML.

Cette contrainte est nécessaire pour vous permettre en contre partie de réellement saisir du code HTML dans votre fichier XML. Ainsi Xi peut être saisi X&lt;sub&gt;i&lt;/sub\&gt; dans votre fichier XML, ce qui devient X<sub>i</sub> dans votre fichier HTML, pour enfin vous apparaître dans votre navigateur comme Xi.

Vient ensuite l'élément module (élément racine) avec un certain nombre d'attributs :

title
titre du module du module (obligatoire) ;
author
auteur du module : prénom et nom ou une liste des auteurs (obligatoire) ;
date
date de dernière modification du module (facultatif) ;
directory
nom du répertoire où se trouve la page de présentation : fixé à general (obligatoire) ;
stylesdir
nom du répertoire où se trouvent les feuilles de styles : fixé à styles (obligatoire) ;
prefacefile
nom du fichier de présentation du module : fixé à index.html (obligatoire) ;
tocfile
nom du fichier pour la table des matières : fixé à toc.html (obligatoire) ;
bibliographyfile
nom du fichier pour la bibliographie (facultatif : bibliographie.html) ;
webographyfile
nom du fichier pour la webographie (facultatif : webographie.html) ;
glossaryfile
nom du fichier pour le glossaire (facultatif : glossaire.html) ;
helpfile
nom du fichier pour la page d'aide (facultatif : aide.html).

Puis dans l'élément module, nous devons avoir un ou plusieurs éléments chapter. Cet élément a les attributs suivants :

title
titre du chapitre (obligatoire) ;
directory
sous-répertoire contenant l'ensemble des fichiers du chapitre (obligatoire). Ce dossier doit être unique et différent des attributs stylesdir (styles) et directory (general) de l'élément module ;
contentfile
nom du fichier d'introduction du chapitre : fixé à index.html (obligatoire) ;
counter
si le chapitre et ses sections doivent être numérotées (facultatif : yes ou no, défaut yes) ;
abstractfile
nom du fichier pour le résumé du chapitre (facultatif : resume.html) ;
qcmfile
nom du fichier pour le QCM du chapitre (facultatif : qcm.html 2).

L'élément chapter peut contenir zéro, un ou plusieurs éléments section avec les attributs suivants :

title
titre de la section (obligatoire) ;
contentfile
nom du fichier de la section : sans espace, sans accent, avec l'extension .html (obligatoire et unique pour un chapitre donné).

Et enfin, l'élément section peut contenir zéro, un ou plusieurs éléments subsection avec les mêmes attributs que section :

title
titre de la section (obligatoire) ;
contentfile
nom du fichier de la sous-section : sans espace, sans accent, avec l'extension .html (obligatoire et unique pour un chapitre donné).

1. La plupart des voyelles accentuées (voir annexe B.1).

2. Attention, ce fichier n'est pas créé par la ModulEst (voir section 5.3).

Page d'accueil Table des matières Niveau supérieur Page précédente Haut de la page Page suivante