[ Previous page | Summary | Next page ]

# Rédiger des supports de cours

## Avec un éditeur de texte

Les documents XML ne sont que de simples documents textes. Il suffit donc d'un éditeur de texte pour les rédiger. Toutefois il est quelque peu rébarbatif de saisir régulièrement les mêmes balises. C'est pourquoi il est intéressant de disposer de quelques raccourcis clavier lors de la saisie.

Pour les utilisateurs de vim 6 et supérieur, vous trouverez quelques fichiers dans le répertoire vim/. Installez ces fichiers de la manière suivante :

- xml.vim => ~/.vim/ftplugin/xmllogidee.vim
- syntax.vim => ~/.vim/syntax/xmllogidee.vim
- filetype.vim => ~/.vim/filetype.vim

Ces fichiers fournissent une coloration syntaxique adaptée pour le XML et un ensemble de raccourcis clavier pour le mode insertion. Tous les raccourcis commencent par une virgule. Ainsi « ,xm » permet d'insérer la ligne d'en-tête XML et « ,in » insère un bloc d'en-tête info. Consultez le fichier xml.vim pour découvrir les autres raccourcis.

## Ce qu'il faut savoir en rédigeant

### Les chemins d'accès aux fichiers

Il faut être particulièrement vigilant avec les chemins d'accès aux fichiers aussi bien lorsque vous incluez des images (avec la balise image) que des documents (avec la balise include). En effet, le jeu des inclusions peut changer le "répertoire courant" et fausser les données.

Imaginez un répertoire module contenant tous les modules et un répertoire theme contenant l'ensemble des thèmes. Supposez que theme/theme_un.xml inclue un module avec une balise include similaire à celle ci :

       <xi:include href="../module/sujet.xml"/>

Supposez également que le module sujet.xml inclue une image schema.eps (présente dans le répertoire module) avec un élément :

       <image src="schema.eps"/>

Que va t'il se passer lorsque l'on va essayer de transformer theme_un.xml ? Et bien theme_un.xml va contenir une balise image listant schema.eps qui n'est pas disponible dans le répertoire theme et il va y avoir une erreur. D'où la nécessité de mettre des chemins d'accès aux fichier plus explicites même si l'image est dans le même répertoire que le module :

       <image src="../module/schema.eps"/>

### Le format des images

Les images qui sont inclues dans les documents XML doivent être au format « .eps ». Même si ce format ne convient pas pour toutes les sorties (HTML notamment), c'est le format de référence choisi. L'image sera automatiquement convertit en PNG pour les besoins de la version HTML.

[ Previous page | Summary | Next page ]

Legal notice and ackowledgements.
Document generated with Logidée's tools.