exercices corriges pdf · web viewprÉface ce guide s’adresse à toute personne désireuse de...

PRÉFACE

Ce guide s’adresse à toute personne désireuse de se familiariser avec DocBook, mais ne possédant pas nécessairement un haut niveau en informatique. Que vous soyez étudiant ou tout simplement curieux à propos de ce langage, ce guide vous propose une présentation simple et concise du langage, suivi d’une approche thématique abordant les différentes caractéristiques,

avantages et inconvénient de ce dernier. Enfin, une approche pratique sera abordée en fin de [ce] guide, vous proposant des conseils pour la création d’un document DocBook.

Bonne lecture !

Mise en page (Table des matières, Index) et illustrations : Alice Somsouk

Rédaction :

Préface et troisième partie : Alice Somsouk

Première partie, glossaire et annexes : David Buxton,

Deuxième partie, glossaire, et annexes : René Gilles Étienne

2

hbeciri, 03/01/-1,

simplifiez

TABLE DES MATIÈRES

INTRODUCTION GÉNÉRALE 5

DOCBOOK : QU’EST-CE QUE C’EST ? 7

DOCBOOK : POURQUOI ? 8

DOCBOOK : HISTORIQUE ? 9

DOCBOOK : QUELLE VERSION ? 10

APPROCHE THÉMATIQUE 11

UN LANGAGE SIMPLE 13

LES ÉLÉMENTS DE CE LANGAGE 13

UN LABEL INSTALLÉ SUR DE SOLIDES BASES 15

LA DTD (DOCUMENT TYPE DEFINITION) 15

LE STYLE 16

UN CODE AUX PRINCIPES ÉPROUVÉS 19

UN BALISAGE FLEXIBLE... 19

... D’OÙ DÉCOULE UNE GRANDE PRODUCTIVITÉ 19

LA MÉTHODE EN QUESTION 20

UN FORMAT EXPORTABLE 21

Bémols 22

CRÉATION D’UN DOCUMENT DOCBOOK 24

XML 27

RÉDACTION DU XML 27

VALIDATION DE LA DTD 35

INTRODUCTION AUX FEUILLES XSL 36

Structure d’un document XSL 36

Association d’une feuille XSL à un document XML 36

3

TABLE DES MATIÈRES

CRÉATION D’UN DOCUMENT DOCBOOK (SUITE) 24

DOCBOOK 39

RÉDACTION 39

Les différentes balises de structures 39

Eléments racines 39

Eléments de structure 40

Eléments d’information 41

Eléments d’avertissement 42

Les balises pour insérer des images 44

Les balises servant à la création d’entités 44

TRANSFORMATION 46

ANNEXES 47

ANNEXES 54

INDEX 55

GLOSSAIRE 59

SOURCES 61

NOTES 62

4

INTRODUCTION GÉNÉRALE

Guide d’introduction à DocBook 1 ère partie

DocBook vous fait peur ? Tout au long de ce guide, nous vous ferons découvrir les principales utilisations pratiques de ce programme, comment s’en servir de manière efficace et avec un minimum de difficulté.

5

Flickr.com

INTRODUCTION GÉNÉRALE - SOMMAIRE

DocBook, qu’est-ce que c’est ?

DocBook, pourquoi ?

DocBook, historique ?

DocBook, quelle version ?

INTRODUCTION GÉNÉRALE – 1 e PARTIE

6

DocBook : Qu’est-ce que c’est ?

DocBook est un langage qui vous permet de publier votre document texte en plusieurs formats sans avoir à rédiger votre document à nouveau dans chaque langage.

DocBook fait référence à un langage de balisage défini à partir de SGML / XML (Métalangage de balisage issu comme le HTML du SGML). Globalement, DocBook est un ensemble de balises typiques qui ressemblent néanmoins sur le principe aux balises HTML (Langage de programmation des pages web) ce qui donnera peut-être une impression familière aux plus érudits d’entre nous. Mais attention, DocBook est un peu plus complexe que HTML tout en vous offrant cependant plus de fonctionnalités et de possibilités de sortie.(?)

Langage de balisage : ensemble de données qui sont destinées à être interprétées par un processeur et non pas par l’utilisateur. Il est composé de balises, unités sémantiques qui servent à structurer le texte

SGML : (Standard Generalized Markup) langage standard de balisage généralisé et reconnu comme une norme de l'Organisation internationale de normalisation (ISO), depuis 1986. Tout document SGML est associé à une DTD (Définition du type de document). SGML est à l'origine de HTML et de XML.)


7

DocBook : Pourquoi ?

DocBook vous offre une variété d’avantages significatifs. S’il n’en fallait retenir que six :

DocBook XML est un format pérenne car librement développable et utilisableDocBook XML est un format accessible pour peu que l’on soit méthodiqueDocBook XML est un standardDocBook XML permet de se focaliser sur le sens et la sémantiqueDocBook XML est un outil portableDocBook XML est gratuit à obtenir et à utiliser

Le plus grand avantage de DocBook est sa versatilité. C'est-à-dire, un document écrit avec un balisage DocBook peut être facilement converti en HTML, PostScript, PDF, RTF, DVI, et ASCII. De plus, DocBook est gratuit et facilement accessible. Les documents DocBook sont écrits en texte brut, et peuvent être modifiés avec n’importe quel éditeur de texte pouvant enregistrer des documents [sous] texte au format ASCII. C’est un dispositif efficace qui vous permet de vous servir de vos documents sous plusieurs formats, par exemple en version imprimée et version Internet.

C’est pourquoi DocBook est un véritable atout pour son rédacteur, le libérant dans un premier temps des inquiétudes liées au format et à la mise en page de son document. La séparation contenu / format permet de travailler consciencieusement sur la rédaction du texte, sans se soucier des interprétations aléatoires des logiciels, ceci pouvant être à l’origine de rendus parfois désordonnés. La focalisation sur le sens et la sémantique permet donc de rendre le message voulu sans aucune altération. Enfin, l’on ne perd pas du temps à mettre le document en forme au détriment du fond.

Dans le cas d’un travail en équipe, le travail coopératif est amélioré de manière significative et est facilité grâce à l’utilisation de standards.


8

DocBook : Historique ?

Apparu en 1992 à la suite d'un projet commun de l’entreprise informatique HaL Computer Systems et l'éditeur O'Reilly, il avait pour but de faciliter l'échange de documentation UNIX. Avec le temps, ce partenariat est devenu The Davenport Group, son objectif s'étant élargi pour devenir le format d'écriture et d'échange de documentations techniques issues du monde des industries de l'informatique et de l'électronique. Depuis 1998 le consortium SGML Open, maintenant connu sous le sigle OASIS, a pris les commandes de DocBook.

DocBook est issu du monde SGML, mais un équivalent langagier en XML a été développé et a pris l’ascendant sur son prédécesseur pour les tâches courantes.( ?) Ses premiers utilisateurs étaient d’importantes sociétés de développement de logiciels qui s’en servaient car leurs représentants avaient aidé à sa conception. DocBook a cependant fini par être adopté par la communauté Open Source qui l’a intégré comme son outil de création de documents par défaut avec des logiciels tels que FreeBSD, KDE, le bureau GNOME, les références GTK+ API, la documentation du noyau Linux, ainsi qu’au sein de la Linux Documentation Project (LDP).

Le nombre d’utilisateurs de DocBook continue d’ailleurs de s’accroître, en dehors de la communauté Open Source. De nombreux outils de création axés sur cet outil apparaissent, ainsi qu’une exhaustive documentation technique.

La DTD DocBook elle-même est maintenue par le Comité technique de DocBook (DocBook Technical Committee), dirigé par Norman Walsh, principal auteur des feuilles de style DocBook.

Il est également l’auteur de sa documentation officielle DocBook: The Definitive Guide, disponible en ligne et en librairie.


9

hbeciri, 03/01/-1,

c’est sans doute par là qu’il aurait fallu commencer

hbeciri, 03/01/-1,

partie un peu hard pour les non initiés

DocBook : Quelle version ?

Pre DocBook v5.0

L’actuelle version de DocBook vient tout juste de sortir mais les utilisateurs des versions antérieures restent très nombreux. Pour cette raison, nous allons entrevoir brièvement les changements apparus entre la version 4.x et la plus récente.

Jusqu’à la création de DocBook 5, toute version précédente avait été normativement régie par une DTD, le seul métalangage convenable.(?) Donc, bien que les formats DocBook 4.x puissent être en SGML ou XML, la version XML ne possédait pas son propre espace de noms, sa propre terminologie.

L’unicité d’un titre d’élément est une restriction importante qu’on trouve dans ces versions. Cela fait qu’un élément nommé « info » doit porter la même information à n’importe quel endroit dans le fichier. Alors, il faut créer plusieurs étiquettes pour les différentes sortes d’informations dans le fichier : « bookinfo », « chapterinfo », etc.

Les documents DocBook 4.x ne sont pas compatibles avec DocBook 5. Toutefois en utilisant une feuille de style XSLT, ces vieux fichiers peuvent être converti en format lisible à DocBook 5. Une telle feuille de style est incluse dans le progiciel de spécifications DocBook 5.

« Simplified DocBook »

Comme vous êtes un nouvel utilisateur, vous vous sentez probablement un peu perdu, mais n’ayez pas peur ! Il vous est possible de bénéficier des avantages de DocBook sans avoir à s’importuner avec la version complète de DocBook en choisissant de travailler sur Simplified DocBook, version élaguée de notre outil. La version actuelle de Simplified DocBook DTD est la version 1.1. Elle est conçue uniquement pour les articles ou les documents sensiblement plus courts que les livres. Le nombre de balises supportées est également réduit au quart des possibilités initiales.


10

hbeciri, 03/01/-1,

même pb de technicité : définissez clairement vos notions de base !!

APPROCHE THÉMATIQUE

Guide d’introduction à DocBook 2 è partie

Comme vu en introduction, il apparaît que les caractéristiques de DocBook sont toutes indiquées pour les gros producteurs de documentation. Les utilisateurs sont principalement séduits par la méthode, l’accessibilité relative du langage (par rapport à d’autres langages célèbres), la fiabilité et le côté pratique. Sont ensuite venus s’ajouter à cela le caractère quasi-universel de ce langage qui s’est développé dans une optique incluant également la compatibilité avec ses collègues (on préfèrera le terme de « collègues » à celui d’« outils concurrents » pour diverses raisons expliquées en aval.). Nous allons approfondir ces aspects entrevus en introduction en définissant plus en détail les concepts abordés afin de mettre le

11

Flickr.com

hbeciri, 03/01/-1,

développement trop sinueux pour une intro.

doigt sur l’outil à l’étude et sur sa singularité.

12

L’APPROCHE THÉMATIQUE - SOMMAIRE

Un langage simple

Les éléments de ce langage

Un label installé sur de solides bases

La DTD

Le style

Un code aux principes éprouvés

Un balisage flexible…

…d’où découle une grande productivité

La méthode en question

Un format exportable

Bémols

APPROCHE THÉMATIQUE – 2 è PARTIE

13

Un langage simple


Si l’on opérait un zoom sur le code d’une page créé avec DocBook, le résultat affiché serait un langage simple qui a été conçu comme tel afin d’assurer une certaine transparence entre le langage interprétable par les ordinateurs et ce que peut facilement appréhender l’homme. Voici donc deux catégories d’éléments :

Les informations hiérarchiques

Les informations sémantiques

Les informations hiérarchiques

Il s’agit des informations sur la structure globale du document.

Exemple du caractère intuitif de la hiérarchie extrait et simplifié d’un code :articleinfotitleauthorfirstnamesurnamecopyrightyearholder


14

Vous trouverez plus

d’informations à ce sujet dans la 3 è

partie

Un langage simple


Les informations sémantiques

Le balisage qui va affecter votre prose plus précisément.

Exemple du caractère intuitif des données sémantiques de DocBook

questionparaquestion!-- Some questions have no answers—questionparaquestion

En lisant de tels codes (eh oui, tout cela est bien du code destiné à un processeur), n’importe qui devrait pouvoir comprendre ce que contient un document, et même anticiper l’apparence globale du produit fini. C’est l’un des premiers et principaux avantages de DocBook XML, mais il y en a d’autres !


15


La DTD (Document Type definition)

Dans DocBook, deux composants sont présents pour votre confort de création, ainsi que pour s’assurer de la fiabilité de votre résultat :

Le premier composant est la DTD, qui permet, dans le cadre d’un balisage structurel, de donner au processeur l’organisation de base d’un document ainsi que son contenu sémantique. Le HTML présente l’inconvénient de différer parfois selon le terminal qui le visionne à cause de son manque de précision, alors qu’une des préoccupations majeures des programmeurs est justement de faire en sorte que le rédacteur puisse bénéficier d’une certaine transparence entre ce qu’il écrit et ce qu’il observera au final (le concept WYSIWYG).

Les documents issus d’un outil de traitement de texte sont, eux, généralement frappés d’une très bonne présentation, mais en contrepartie moins bien structurés [par défaut]. De plus la compatibilité des outils et l’interchangeabilité des formats générés sont un problème récurrent qui rend toutes les informations visuelles inutiles au final (puisqu’elles sont souvent perdues).


16


Le style

DocBook donne quant à lui clairement l’organisation du document, sans laisser de directives qui risqueraient d’être mal interprétées car sa DTD se pose en renfort interprétatif.(?) Cette dernière est un document contenant des déclarations exhaustives sur le langage, le type de document ou même des contraintes. En parlant de contraintes, la présence d’une DTD est capitale pour que votre document DocBook soit conforme !


17

hbeciri, 03/01/-1,

...conforme à quoi ? (expliquez !)

hbeciri, 03/01/-1,

cette explication fondamentale arrive bien tard (cf rems sur partie 1)


Le style

Le deuxième composant présent pour votre confort de création est le style propre aux documents DocBook. Le langage HTML, par exemple, reste défini de façon trop rigide ou large dès qu’on a affaire à un fichier sans feuille de style, bien que l’on puisse utiliser des feuilles de style de type CSS pour régler certains de ces problèmes. Il y a des éléments que la logique gèrerait de façon évidente dans un document, mais qui resteront mal rendus si l’utilisateur ne prend pas le soin de préciser toutes leurs caractéristiques.

Il vous est sûrement déjà arrivé de visionner des pages aux contenus chaotiques ? Il suffit parfois de changer de navigateur pour régler un petit impair qui ne devrait néanmoins pas exister. A l’inverse, les documents DocBook XML n’ont pas d’étiquette prédéfinie vu que la présentation est dépendante d’une feuille de style dont le standard est le XSL, même si le CSS est un format supporté (?).

Le style est très utile en cela qu’il permet aisément de transformer un document pour qu’il soit utilisable dans des optiques totalement différentes. C’est principalement l’apparence du document qui le rend exploitable de façon optimale soit par une imprimante, soit par un navigateur, soit par un outil de lecture pour handicapés visuels, ou autres.


18


Le style

Pour conclure :

La DTD et le style sont parfaitement libres d’exploitation car ils répondent à toutes les caractéristiques GNU et de l’Open Source. Ils sont modifiables à souhait, librement utilisables, et parfaitement diffusibles mêmes transformés. Les uniques protections existantes sont justement celles permettant à DocBook de rester parfaitement gratuit. C’est une garantie d’indépendance qui permet à ce format très populaire de rester accessible à ses utilisateurs compte tenu de la popularité de ce type de langage.


19


Un balisage flexible...

Baliser un document revient à implanter des informations qui, dans le produit fini, ne seront visibles et consultées que par un programme ou un processeur chargé de leur donner un sens, de les traduire selon des codes prédéfinis ou à définir. Pour mettre certaines partie d’un document en gras par exemple, là où on s’attendrait dans le code HTML, à l’encadrement des dites parties par des balises de marquage telles que <b> et </b>, DocBook prévoit que vous pourriez avoir envie de changer l’allure du produit fini. L’utilisateur de DocBook XML se contente de faire savoir au processeur qu’il a affaire à une partie spéciale, et peut ensuite implanter dans la feuille de style les détails de leur traitement. Il s’agit de faire comprendre au processeur qu’il doit y faire attention, en vertu de l’intitulé (assez générique et intuitif comme nous l’avons vu dans cette approche thématique) de la balise qui va suivre, et en fonction de sa définition.

Fort heureusement, le format et le langage XML sont très accessibles à la plupart des processeurs et programmes répandus sur le marché, étant donné que les données ne font l’objet d’aucun cryptage particulier comme c’est le cas dans le pack Office ou chez Adobe.

... d’où découle une grande productivité

La flexibilité du balisage incite parfois à penser que le langage XML fait appel à l’intelligence de la machine. Si vous voulez un jour que les parties structurellement balisées par un code tel que <emphase> ne corresponde plus à du gras, mais à du rouge, il vous suffira de modifier la feuille de style dans ce sens, tandis que dans un document sans feuille de style ni DTD, ce processus serait long et fastidieux avec un balisage de présentation car il faudrait modifier chaque occurrence de <gras>.

Bien sûr, l’on peut objecter que plutôt que d’aller modifier chaque balise une par une, il existe la fonction rechercher/remplacer (commande que l’on peut trouver dans la plupart des outils de traitement de texte, mais si l’on a affaire à un grand nombre de documents, il faudra recommencer l’opération sur chacun d’entre eux, alors qu’avec DocBook, tous les documents liés à la même feuille de style seront modifiés en même temps. Ce qui n’empêche pas de créer un style à part si l’on souhaite modifier une feuille en particulier ou en rajouter une nouvelle qui ne correspondrait pas au schéma standard.


20


Structurelle ou présentationnelle ? Analysons la logique du langage de DocBook.

La méthode en question

Séparer le fond de la forme est une méthode qui permet de procéder de façon très simple au traitement automatique d’un à plusieurs documents, pour autant qu’ils soient référés à la même feuille de style. On a donc recours à un balisage plus lâche, plus générique, davantage respectueux du principe quand on écrit le document XML que quand on écrit un autre type de document, étant donné que le reste sera pris en charge par le processeur via la DTD, et par la feuille de style. C’est pourquoi on parle de balisage structurel quand on écrit le fond (la feuille XML). Cette méthode représente un énorme gain de temps sur le long terme, c'est-à-dire dès qu’on a plus d’un document à traiter, ou si l’on doit retraiter le fichier plusieurs fois.

Le balisage structurel est plus ou moins en opposition avec le balisage de présentation que l’on connaît dans le HTML qui, lui, indique en même temps à l’outil de mise en forme comment traiter la forme et le fond, ce qui est plus rapide à très court terme, mais qui se révèle peu pratique quand on a un autre, ou un très grand nombre de documents du même type à créer, ou à modifier

Afin d’optimiser le confort utilisateur et les résultats, la liste de balises DocBook est exhaustive et difficile à apprendre dans leur intégralité, mais en pratique, c’est comme avec un cerveau: seule une faible partie est sollicitée régulièrement. De plus, les intitulés des balises sont certes longs, mais très faciles à retenir et agréables à relire car ils sont plus explicites. De plus, on peut y insérer des espaces, des tabulations... etc, sans porter atteinte à l’intégrité du document final. Nous verrons plus en détail les balises principales dans la troisième partie ainsi qu’une annexe contenant la liste entière des balises DocBook. En s’écartant de l’ésotérisme des précédents langages de balisage, DocBook s’est fait l’allié de l’utilisateur un tant soit peu averti.


21

hbeciri, 03/01/-1,

(sauf si c’est un terme, qu’il faut alors définir)

Un format exportable

DocBook est un éditeur tout ce qu’il y a de plus sociable !

DocBook n’est pas le seul langage qui permet de créer des documents de façon pratique. Alors pourquoi celui-ci plutôt qu’un autre? D’abord parce que le format XML est parfaitement adapté pour internet. Ensuite parce qu’il est exploité et reconnu par un très grand nombre d’outils (*) pour toutes les qualités évoquées en amont. Le plus évident et le plus simple des outils étant bien sûr le bloc-notes, présent sur tous les systèmes d’exploitation. D’autres formats très populaires ont une compatibilité moindre (voir inexistante) avec ce logiciel.

Le fait que l’on doive séparer la forme du fond permet à DocBook d’avoir l’ascendant sur des logiciels mélangeant le tout sur un seul et unique fichier tel que Word ou Open Office. Il est bien entendu possible d’exporter et d’importer des feuilles de styles sur ces deux logiciels, mais la pratique est peu courante et moins simple qu’avec DocBook.

Contrairement au format de fichier Acrobat par exemple, DocBook n’est pas ce qu’il y a de plus simplifié au niveau de la mise en page. Cependant, un document DocBook XML peut servir de base créatrice à un fichier Acrobat; son caractère exportable en fera un outil de choix, c’est la raison pour laquelle il est devenu le format officiel de documentation de Linux et de FreeBSD.

Il est également facile (comme vu précédemment dans la partie « style ») de faire d’un document DocBook une ressource à mettre en ligne, ou à imprimer...

Les applications de DocBook les plus fréquemment recensées :

le PDF

le java

le HTML

les livres

les diapositives

la maintenance web

les foires aux questions

la documentation technique des ordinateurs


22

Bémols

Aussi beau soit-il, il arrive à notre canard de chanter faux.

DocBook a cependant quelques défauts. Il est en effet très difficile à manipuler par tous ceux qui voudraient s’en servir pour bénéficier d’une présentation avancée (même si nous avons vu qu’il était possible d’exporter du DocBook vers un logiciel plus adapté à ce genre de tâches).Il faut également être très attentif quand on créée un document DocBook, car même si son code est moins brut à l’œil nu, sa cohérence reste aussi très importante, et oublier de fermer une balise ou une autre erreur de ce genre résultera en un rendu inattendu dont il faudra rechercher la cause, ce qui peut prendre du temps.

Convertir d’anciens balisages de présentation en balisage DocBook est également une sacrée gageure. Les informations structurelles manquant éventuellement doivent assez souvent être réimplantées manuellement par l’utilisateur. Des outils existent afin d’éviter ce genre de problèmes, mais à l’heure actuelle, ils restent assez peu performants.

Les utilisateurs peuvent donc se plaindre de ne pas bénéficier d’outils d’édition structurelle optimaux. Ils sont également onéreux, et manquent de conventionalité entre eux, ce qui fait que la plupart des gens continue simplement d’écrire toutes les balises à la main.


23

hbeciri, 03/01/-1,

pb de justification

CRÉATION D’UN DOCUMENT

DOCBOOKGuide d’introduction à

DocBook3e PARTIE

Assez des informations théoriques et préférence pour la pratique ? Cette partie a pour objectif de présenter les éléments nécessaires à la création d’un document Docbook. Alors préparez vous à mettre les mains dans le cambouis !

24

Deviantart.com

CRÉATION D’UN DOCUMENT DOCBOOK - SOMMAIRE

XML

Rédaction du XML

Validation de la DTD

Introduction aux feuilles XSL

Docbook

Rédaction

Les différentes balises de structures

Les balises pour insérer des images

Les balises servant à la création d’entités

Transformation

NB : Différents niveaux sont proposés dans les exercices ou les « procédures » techniques, allant du Facile (1) à Difficile (3). Ces étoiles sont placées à gauche de votre page, dans la marge. Ce guide s’adresse avant tout aux personnes novices en la matière, qui maîtrise l’environnement Windows ou Linux, et qui savent se servir d’Internet. Cependant aucune connaissance informatique n’est requise (langage HTML, DTD etc.). Le but de cette partie n’est pas d’apprendre à créer des documents DocBook de façon très poussée, mais d’avoir une approche rapide et claire sur le sujet sans être expert en informatique.

CRÉATION D’UN DOCUMENT DOCBOOK – 3e Partie

25

Introduction

Comme vu précédemment, un document DocBook est un document XML : il doit

respecter les règles d’écritures propre au XML, soit un texte contenant des balises

prédéfinies par le concepteur. Ainsi, un document DocBook permettra de représenter des

données pérennes que les hommes et les machines pourront manipuler. Comme tout

document XML, le document DocBook doit se conformer à la DTD, l’ensemble de règles

portant sur les éléments et leurs attributs qui permet la validation du XML.

La création d’un document DocBook comprend deux étapes bien distinctes :

L’écriture proprement dite du texte XML, en respectant la DTD de DocBook

La transformation de ce texte en un format lisible tel que le PDF, HTML, etc.

XML, DTD…

Ca m’a l’air compliqué…

Pas de panique, commençons tout d’abord par l’écriture du texte XML !


26

XML

Rédaction du XML

Nous avons vu qu’un document XML est un langage de structuration des données et qu’il est essentiellement constitué de texte et de balises. Voici quelques règles simples à respecter. Ne vous laissez pas impressionner par le nombre de règles car vous intégrerez très vite la logique du langage !

Tout d’abord, il vous suffit d’un simple éditeur de texte pour écrire et éditer un document XML, tel que Bloc-Notes, WordPad, Notepad, ou Notepad ++.

La première ligne contenue dans les méta-informations de votre page XML doit être de la forme :

<?xml version= « 1.0 » encoding= « iso-8859-1 » ?>

Méta- quoi ? Les méta informations ou méta données permettent de donner une description du document et d’autres informations.

Les deux attributs spécifient la version de XML utilisée (1.0 ou 1.1) et le codage des caractères.

Les balises sont repérées par les chevrons ouverts et fermés < et >Exemple : <balise>contenu</balise>.

La balise ouvrante peut contenir des attributs. Pour cela, on utilise la syntaxe <balise attr= « val »> (les guillemets « ou ‘ sont obligatoires). Les attributs ne sont pas répétés dans la balise fermante.Exemple : <diplôme année= « 2005 »>

Il faut toujours veiller à refermer toutes les balises ouvertes. Une balise sans contenu (ou balise ne fonctionnant pas par paire) pourra être ouverte et immédiatement fermée en faisant suivre son nom d’un slash, comme par exemple la balise <br> en HTML : <br/>

Il faut respecter la casse : on peut utiliser des majuscules et des minuscules dans les noms de balises mais une fois qu’un nom d’élément a été fixé, il faut s’y tenir.Exemple : <diplôme année= « 2005 »>


27

XML

Rédaction du XML

Il faut faire attention à l’ordre de fermeture des balises : la première ouverte est toujours la dernière fermée. Exemple :

<section><title> Leçon de pêche avec Hélène Béciri </title></section>

Il faut respecter la casse : on peut utiliser des majuscules et des minuscules dans les noms de balises mais une fois qu’un nom d’élément a été fixé, il faut s’y tenir.

Exemple : la balise <author> ne pourra être fermée ni par </Author> ni par </AUTHOR> .

Il ne faut pas utiliser de caractères réservés à XML dans le texte du document :

Les noms de balises et d’attributs doivent être des noms XML :

Le premier caractère est une lettre quelconque ou un « _ » (underscore ou tiret du bas).

Les caractères suivants peuvent être des lettres, des chiffres, des tirets bas (« _ »), des traits d’union (« - ») ou des points (« . ») .

Il n’y a pas de limitation sur la longueur d’un nom XML.

Attention ! Un nom de balise ne peut pas commencer par un chiffre !

28

Cependant, la liberté pour choisir un nom d’élément reste grande car on peut y faire figurer n’importe quelle lettre... De plus, le format de codage de caractères UTF-8 qui contient les alphabets latin, arabe, japonais, etc. est le plus utilisé en XML ce qui veut dire qu’il ne faut pas hésiter à utiliser des lettres accentuées dans les noms d’éléments.


29

XML

Rédaction du XML

On peut également insérer des commentaires. Les commentaires sont des informations que vous écrivez pour vous. Ils n’apparaissent pas aux yeux des visiteurs.

Vous pouvez par exemple utiliser les commentaires pour marquer des repères si votre page XML est très grosse, ou pour vous servir de rappel.

Un commentaire est une balise un peu spéciale commençant par 

QCM (1/2)

Assez de blablas et testons nos connaissances !

Peut-on mettre des majuscules dans les balises ET les attributs ?OuiNon

Quelle est la particularité des balises qui ne fonctionnent pas par paire ?

Elles commencent par <!--Elles commencent par un slash (</)Elles se terminent par un slash (/>)

Correction à la fin de l’exercie


30

XML

Rédaction du XML

QCM (2/2)Distinguez les noms XML corrects des noms incorrectes

<Drivers_License_Number>98 NY 32</Drivers_License_Number><Driver’s_License_Number>98 NY 32</Driver’s_License_Number><first name> Pascal </first name><first_name> Hélène </first_name><àçttûä>øåú</àçttûä><4-leaMaster>CDMM</4-leaMaster>

Laquelle des ces suites syntaxique est correcte ?<articleinfo> <author> <name> Hélène </name> </author> </articleinfo><articleinfo></articleinfo><author></author><name></name>HélèneHélène <name><articleinfo></articleinfo></name><author></author>

Quel est le codage des caractères qui permet l’utilisation des accents ?

ISO-8859-1UTF 8ISO-8859-15

Laquelle de ces balises est un commentaire ?

31

Correction sur la page suivante !


32

XML

Rédaction du XML

Correction (1/2) Les réponses sont en rougePeut-on mettre des majuscules dans les balises ET les attributs ?

OuiNon

Quelle est la particularité des balises qui ne fonctionnent pas par paire ?

Elles commencent par <!--Elles commencent par un slash (</)Elles se terminent par un slash (/>)

Distinguez les noms XML corrects des noms incorrectes<Drivers_License_Number>98 NY 32</Drivers_License_Number><Driver’s_License_Number>98 NY 32</Driver’s_License_Number><first name> Pascal </first name><first_name> Hélène </first_name><àçttûä>øåú</àçttûä><4-leaMaster>CDMM</4-leaMaster>

Laquelle des ces suites syntaxique est correcte ?<articleinfo><author><name> Hélène </name></author></articleinfo><articleinfo></articleinfo><author></author><name></name>HélèneHélène <name><articleinfo></articleinfo></name><author></author>

Suite de la correction sur la page suivante


33

hbeciri, 03/01/-1,

lesquelles ? (bonnes ou mauvaises ?)

XML

Rédaction du XML

Correction (2/3)

Les réponses sont en rouge

Quel est le codage des caractères qui permet l’utilisation des accents ?

ISO-8859-1UTF 8ISO-8859-15

Laquelle de ces balises est un commentaire ?

Bravo ! Maintenez que vous savez rédiger un document XML il faut vérifier que votre document est bien formé. Pour cela, nous allons passer à la seconde étape du processus XML, la validation de la DTD.

DTD – (Document Type Definition) : Définition du type de document. C'est un élément associé à un document XML ou SGML qui décrit la structure et le type des balises utilisées.

Nous nous intéresserons bien sûr à la DTD qui définit DocBook.


34

XML

Validation de la DTD

Pour cela on peut utiliser Xmllint, un programme disponible dans l’environnement Linux fourni avec la librairie multi-platorme libxml2. Il permet de valider si un document XML respecte la syntaxe XML ou s'il est valide selon une DTD. Evidemment nous nous intéresserons plus particulièrement à la DTD DocBook.

Pour utiliser Xmllint, ouvrez un terminal et placez-vous dans le répertoire où se trouvent les documents XML à manipuler. Tapez les commandes suivantes :

Valider un fichier XML contenant une DTD.

o % xmllint data.xml –valid

Valider un fichier XML

o avec une DTD externe :

% xmllint data.xml --dtdvalid data.dtd --noout

o avec un schéma XML

% xmllint data.xml --schema schema.xsd --noout

L’option —noout permet d’afficher uniquement les informations de validation.

Si vous utilisez Windows, pas de panique, vous pouvez installer Xalan. Cet outil est gratuit et écrit en java donc utilisable sous la plupart des systèmes d'exploitations (Windows, Linux, Unix, etc). Il faudra au préalable créer une feuille de style XSL.

Pour utiliser Xmllint, ouvrez un terminal et placez-vous dans le répertoire où se trouvent les documents XML à manipuler. Tapez ensuite la commande suivante :

java org.apache.xalan.xslt.Process -IN fichier.XML -OUT fichier.HTML -XSL fichier.XSL

DocBook propose sur son interface des feuilles de style XSL standard. Mais pour ceux qui souhaiterait aller plus loin, notre prochaine et dernière partie dans la découverte du XML s’intéresse à ces fameuses feuilles de style, les feuilles XSL.


35

XML


XML (XSL?) est un langage de structuration des données permettant de définir des feuilles de style pour les documents XML, un peu comme [ce que sont] les CSS pour le langage HTML, et non de représentation des données. Ainsi XSL (eXtensible StyleSheet Language) est un langage recommandé par le W3C pour effectuer la représentation des données de documents XML. XSL est lui-même défini avec le formalisme XML, cela signifie qu’une feuille de style XSL est un document XML bien formé.

Structure d’un document XSL

Un document XSL est également un document XML à la base. Il doit donc commencer par la balise suivante :

<?xml version= »1.0 » encoding= »ISO-8859-1 »?>

D’autre part, toute feuille de style XSL est comprise entre les balises <xsl:stylesheet ...> et </xsl:stylesheet>.

La balise xsl:stylesheet encapsule des balises xsl:template définissant les transformations à faire subir à certains éléments du document XML.

<?xml version=”1.0” encoding=”ISO-8859-1”?><xsl:stylesheetxmlns:xsl=”http://www.w3.org/TR/WD-xsl”xmlns=http://www.w3.org/TR/REC-html40result-ns= « »><xsl:template ... ></xsl:template ></xsl:stylesheet>

Association d’une feuille XSL à un document XML

Pour lier la feuille de style que vous venez de créer il suffit de l’enregistrer sous l’extension.xsl, et d’insérer les balises suivantes au début du document XML:

<?xml version= »1.0 » encoding= »ISO-8859-1 »?><?xml-stylesheet href= »fichier.xsl » type= »text/xsl »?>


36

hbeciri, 03/01/-1,

ce § manque de clarté : à revoir, car il est fondamental.

XML


Voici un exemple de feuille XSL permettant d’effectuer une transformation d’un fichier XML en version HTML :

<?xml version=”1.0” encoding=”ISO-8859-1”?><xsl:stylesheetxmlns:xsl=”http://www.w3.org/TR/WD-xsl”xmlns=”http://www.w3.org/TR/REC-html40”result-ns=””>

<xsl:template match=”/”><HTML><HEAD><TITLE> Leçon de pêche avec Hélène Béciri </TITLE></HEAD><BODY BGCOLOR=”#CCCCCC”>

<xsl:apply-templates/>

</BODY></HTML>

</xsl:template ><xsl:template match=”personne” >

<ul><li><xsl:value-of select=”nom”/><xsl:value-of select=”prenom”/></li></ul></xsl:template ></xsl:stylesheet>


37

XML


Voici la signification de cette feuille XSL

• Le premier tag <xsl:template> permet d’appliquer une transformation à l’ensemble du document (la valeur « / » de l’attribut match indique l’élément racine du document XML). Ce tag contient des balises HTML qui seront transmises dans l’arbre résultat

• L’élément <xsl:apply-templates/> indique le traitement de tous les enfants directs de la racine.

• La balise <xsl:template match= « personne » > permet d’aller traiter les éléments de type personne

• Enfin les deux éléments <xsl:value-of select= « nom »/> et <xsl:value-of select= »prenom »/> permettent de recuperer les valeurs des balises nom et prénom

Maintenant que nous avons compris les bases d’XML et de la DTD, nous pouvons attaquer le document DocBook !


38

DocBook

Rédaction

Tout d’abord, rappelons qu’un document Docbook permet de porter l’attention strictement sur le contenu, et non pas sur la présentation. Tandis que le rédacteur se concentre sur le contenu, le graphiste et/ou programmeur, se préoccupera uniquement de la présentation d’un format de sortie particulier.

Les nombreux (>370) éléments ou balises qui composent la DTD DocBook sont séparés en deux catégories :

Hiérarchie : éléments structurels

Information : éléments qui contiennent les données elles-mêmes (le texte)

Les différentes balises de structures

Les éléments de hiérarchie ou de structure sont primordiaux puisqu’elles permettent de donner les valeurs de sémantique en établissant la structuration du document. Il faut donc au préalable s’interroger sur le sens que l’on souhaite donner au texte a moment de la rédaction.

Eléments racines

Tout d’abord, nous allons nous intéresser aux éléments racines, c’est-à-dire les éléments de structure qui se trouvent tout en haut de la hiérarchie et qui débutent une documentation au format DocBook. Ils sont au nombre de 3 :

Set (collection, recueil de livres, ensemble de livres)

Book (élément de départ le plus commun constitué lui-même d’un titre <title>, sous-titre <subtitle> et titre abrégé <titleabbrev> optionnels ; de méta-informations optionnelles et d’un nombre quelconque, dans un ordre quelconque d’éléments (Preface, Chapter, Appendix, Bibliography, Glossary, Index, etc.)

Article (article composé de sections comme sous parties comme Introduction, Corps de l’article et Conclusion).


39

DocBook

Rédaction

Eléments de structure

Ces balises de structure font suite aux balises racines.

<chapter> : Chapitre d’un livre ou d’un article

<sect1> ... <sect5> : Sections et sous-sections d’un chapitre. Une section doit contenir au moins une balise de type paragraphe.

<title> : Texte d’en-tête ou titre d’un élément orienté-bloc

<para> : Paragraphe

<blockquote> : Une citation dans le texte. Cette balise doit contenir au moins une balise de type paragraphe.

<Itemizedlist> : Une liste non numérotée. Elle doit contenir des éléments listitem.

<Orderedlist> : Une liste numérotée. Elle doit contenir des éléments listitem.

L’attribut numeration permet de définir le type de numérotation : arabic, loweralpha, upperalpha, lowerroman, upperroman.

<Listitem> : Un élément de liste (numérotée ou non) qui doit contenir au moins un élément de type paragraphe.

Nous avons vu que set désigne les ensembles de livres, mais quels sont les points communs et les différences entre <book> et <article> ?

Les deux éléments racines de hiérarchie devront comporter un titre <title>. La principale différence réside dans le fait que l’on peut insérer des chapitres et une préface dans un <book> et pas dans un <article>. <article> est donc plus léger que <book>.


40

DocBook

Rédaction

En règle générale on utilisera pour un <book>

book meta information chapter sect1 sect2 sect1 chapter sect1 appendix sect1 appendix sect1 ... glossary

et pour un <article>

article meta information sect1 sect1 sect2 sect1 ...

Eléments d’information

Voici quelques balises d’information :

<emphasis> permet de mettre en valeur un morceau du texte.


41

DocBook

Rédaction

<example> permet de signaler un exemple. On peut y insérer un titre <title>

<ulink> permet de créer un lien hypertexte. L’attribut url permet de préciser l’adresse de destination.

Exemple : <ulink url= « lien »Canne à pêche</ulink>, aura pour effet de transformer le texte Canne à pêche en lien externe vers l’adresse lien.

On peut également créer des liens internes, c’est-à-dire des liens à l’intérieur du document. Cela permet de pointer par exemple un lien vers un autre paragraphe, une bibliographie etc. Les liens se formant au moment de la transformation du document DocBook, il faut donc que les indications fournies par l’auteur permettent à la transformation de les comprendre et de créer ces liens.

Les balises <link> et <id> permettent de créer des liens internes. Pour cela, on sélectionne l’élément vers lequel on souhaite pointer notre lien. On lui attribut une valeur id que l’on nomme. Il suffit ensuite d’entourer le mot pointant vers ce lien par les balises <link linkend= « nom de l’id » texte </link>

Eléments d’avertissement

<warning>, <remark>, <caution>, <tip>, <important>, <note> sont des balises d’avertissement

Elles se comportent à peu près toutes de la même façon :

Elle produisent en général automatiquement un titre (en français si vous l’avez précisé), hormis la balise <remark> ; Les balises <caution> et <warning> produisent en général automatiquement un cadre ; Elles nécessitent que leur contenu soit inclus dans un paragraphe, à l’exception de <remark>.


42

DocBook

Rédaction

Il existe de nombreuses autres balises que l’on peut consulter sur le site web de Docbook ou en Annexes de ce manuel.

Voici un exemple de fichier XML contenant une DTD DocBook et reprenant certaines balises que nous avons vues :

Exemple :01 <?xml version= « 1.0 » encoding= »UTF 8 »?>02 <!DOCTYPE article PUBLIC « //OASIS//DTD DocBook XML V4.2//EN »03 « ../docbook/dtd/docbookx.dtd »>04 <article lang= »fr »>05 <articleinfo>06 <authorgroup>07 <author>08 <firstname>Hélène</firstname>09 <surname>Béciri</surname>10 </author>11 </authorgroup>12 <pubdate>Décembre 2008</pubdate>13 <title> Leçon de pêche avec Hélène Béciri </title>14 </articleinfo>1516 17 <section>18 <title>Une bonne canne à pêche</title>19 <section>20 <title>La mise de l’appât</title>21 22 </section>23 24 </section>25 </article>

Cela indique au programme qu’il s’agit d’un document XML version 1.0, utilisant un codage de caractère UTF 8. Nous précisons ensuite le type de document, dans la balise DOCTYPE et dans la balise où l’on indique l’attribut langage destiné à déterminer dans quelle langue le document a été écrit. On précise également la DTD que l’on a utilisé pour compiler ce document (nommément DocBook 4.2).

Il ne faut pas oublier de terminer le document par les balises fermées de </set>, </book> ou </article>.


43

DocBook

Rédaction

L’élément <authorgroup> permet de définir le groupe d’auteur qui a rédigé la documentation. Chaque auteur doit être contenu dans une balise <author>. Il est possible d’ajouter une adresse email en plaçant l’élément <email> à l’intérieur. L’élément <pubdate> précise la date de publication du document. Le titre du document est signalé par la balise <titre>.  est un commentaire indiquant le début de l’article (et donc la fin des méta informations). S’ensuit l’article en question, divisé en sections que l’on peut nommer. Il n’est pas nécessaire de numéroter ces sections car les feuilles de styles XSL le font automatiquement lors de la transformation.

Les balises pour insérer des images

Il est possible d’insérer une image dans un document DocBook. Pour cela, on utilise l’élément <mediaobject> qui permet aux outils de transformation différentes de choisir l’élément (vidéo, image, texte) qui leur convient le plus.

Les balises servant à la création d’entités

Il est possible de partager son document DocBook en plusieurs entités afin d’avoir des petits documents plus faciles à manipuler.

Il suffit de déclarer les sous documents comme entité dans le document principal :

Exemple :01 <?xml version= »1.0 » encoding= »ISO88591 »?>02 <!DOCTYPE article PUBLIC « //OASIS//DTD DocBook XML V4.2//EN”03 « ../docbook/dtd/docbookx.dtd » [04 <!ENTITY Leçon de pêche ave Hélène Béciri SYSTEM « Leçon de pêche avec Hélène Béciri.xml »>05 <!ENTITY Leçon de pêche ave Pascal Cabaud SYSTEM « Leçon de pêche avec Pascal Cabaud.xml »>06 ]>07 <article class=”whitepaper” lang=”fr”>08 <articleinfo>09 <authorgroup>10 <author>11 <firstname>Hélène</firstname>12 <surname>Béciri</surname>


44

DocBook

Rédaction

13 </author>14 </authorgroup>15 <title>Leçon de pêche avec Hélène Béciri</title>16 </articleinfo>17 &presentation;1819 &environnement;20 </article>

Un sous document pouvant s’écrire :01 <?xml version= »1.0 » encoding= »ISO88591 »?>02 <section>03 <title>Leçon de pêche ave Pascal Cabaud</title>04 <para>...</para>05 </section>


45

Comme vous avez pu le voir précédemment, réaliser un document DocBook ne consiste pas seulement à le rédiger, mais également à le transformer en d’autres formats. Notre dernière partie fera le point rapidement sur ce processus de transformation.

DocBook

Transformation

La transformation d’un document DocBook peut représenter une difficulté pour les novices qui débutent dans le XML. Ces difficultés, d’ordre technique (informatique) peuvent être rapidement résolue en ayant recours à l’un des nombreux logiciels de conversion proposés sur le marché.

Par exemple, nous pouvez utiliser ABC Amber XML Converter (compatible sur Windows), qui propose de convertir votre document XML en divers formats (PDF, HTML, RTF, TXT ANSI, TXT Unicode, DOC, etc.), rapidement et facilement, tout en proposant l’option d’intégrer vos feuilles de style XSL.

Sinon, pour les plus confirmés qui utilisent Linux, il est possible d’utiliser les programmes db2dvi, db2html, db2pdf, db2ps et db2rtf. Il suffit alors de taper la commande suivie du nom du document DocBook.

Les formats obtenus sont les suivants :

Formats obtenus Lisibilité

DVI (DeVice Independant) xdvi ou kdvi sous linux.

HTML N'importe quel navigateur web

PDF (Portable Document Format)Acroread, xpdf ou kpdf sous Linux

Acrobat Reader sous Windows

PS (PostScript) GhostView sous Linux et Windows

RTF (Rich Text Format) N'importe quel traitement de textes

Mais attention ! Certes la DTD XML Docbook permet d'écrire des documents structurés ayant une forte valeur sémantique, mais une fois le document écrit, tous les formats dans lesquels vous souhaiterez transformer votre document ne seront pas en mesure de garder cette forte valeur sémantique.


46

ANNEXES

LES BALISES DE DOCBOOK

abbrev - Abréviationabstract - Résuméaccel – Raccourci clavier d’une interface graphiqueackno – Remerciements dans un articleacronym – Acronymeaction – Réponse à un évènement utilisateuraddress – Adresse réelle (généralement postale)affiliation – Affiliation institutionnelle d’un individualt – Représentation textuelle d’un élément picturalanchor – Endroit précis dans un documentanswer – Réponse à une question posée dans un ensemble de Questions/Réponsesappendix – Appendice d’un livre ou d’un articleappendixinfo – Méta information d’un appendiceapplication – Nom d’un logicielarea – Zone réactive souvent cliquableareaset – Ensemble de zones réactives liées entre ellesareaspec – Collection de zones réactivesarg – Argument (élément) d’un résumé d’une syntaxe de commandes logiciellesarticle - Articlearticleinfo – Méta informations sur l’articleartpagenums – Numéro(s) de page(s) d’un article impriméattribution – Source d’une longue citation ou d’un épigrapheaudiodata – Direction vers des données audio externesaudioobject – Regroupement d’une donnée audio et de ses méta informationsauthor – Nom d’un auteur (individu)authorblurb – Courte description ou remarque sur l’auteurauthorgroup – regroupement des informations sur les auteurs ou les collaborateurs d’un documentauthorinitials – Initiales de l’auteurbeginpage – Emplacement d’un espacement sur la version imprimée d’un documentbibliocoverage – Couverture spatiale ou temporelle d’un documentbibliodiv – Section d’une bibliographiebiblioentry – Entrée bibliographiquebibliography - Bibliographiebibliographyinfo – Méta information sur une bibliographiebiblioid – Identifiant d’un documentbibliolist – Regroupement d’un ensemble d’entrées bibliographiquesbibliomisc – Information bibliographique supplémentairebibliomixed – Entrée d’une bibliographiebibliomset – Regroupement organisé d’informations bibliographiquesbiblioref - Renvoi vers une entrée bibliographiquebibliorelation – Relation entre deux documentsbiblioset - Regroupement désorganisé d’informations bibliographiquesbibliosource – Source d’un documentblockinfo – Méta information sur un blocblockquote – Citation séparée du texte principalbook - Livrebookinfo – Méta information sur un livrebridgehead – Rubrique non concernée par la hiérarchie du documentcallout – Zone réactive/cliquable

47

ANNEXES

calloutlist – Liste de zones réactivescaption - A captioncaution – Note d’avertissementchapter - Chapitrechapterinfo Méta-information sur un livrecitation – Citation bibliographique sur une même lignecitebiblioid – Citation d’un identifiant (ex . : ISBN) bibliographiqueciterefentry – Citation d’une page de référencecitetitle – Titre du livre citécity – Nom de ville dans une adresseclassname – Nom de classe en langage de programmation orientée objets.classsynopsis – Résumé de la syntaxe d’une classeclasssynopsisinfo – Information supplémentaire sur le résumé de la syntaxe d’une classecmdsynopsis – Résumé de la syntaxe d’une commande logicielleco – Emplacement d’une zone réactive dans le textecode – Morceau de code sur une lignecol – Colonne d’un tableau HTMLcolgroup – Groupe de colonnes de tableaux HTMLcollab - Collaborateurcollabname – Nom d’un collaborateurcolophon – Faits sur les méthodes de création d’un livre survenant à sa fincolspec – Spécifications d’une colonne d’un tableaucommand – Nom d’un programme exécutable ou d’une autre commande logiciellecomputeroutput – Donnée affichée ou reproduite par un ordinateurconfdates – Dates d’une conférence à l’origine de la création d’un documentconfgroup – Regroupement de méta informations sur un document écrit pour une conférenceconfnum – Identifiant associé à une conférenceconfsponsor – Sponsor d’une conférenceconftitle – Titre d’une conférenceconstant – Une constante observée en programmation ou dans un systèmeconstraint – Contrainte d’un produit EBNFconstraintdef – Définition d’une contrainte d’un produit EBNFconstructorsynopsis – Résumé de la syntaxe pour un fabricantcontractnum – Numéro de contratcontractsponsor – Sponsor d’un contratcontrib – Résumé des contributions apportées à un documentcopyright – Informations sur les droits d’auteurcoref – renvoi à une zone réactivecorpauthor – Société d’auteurscorpcredit - Société ou organisme remercié dans un documentcorpname – Nom d’une entreprisecountry – Nom d’un paysdatabase – Nom d’une base de donnéedate – Date de parution ou de révision d’un documentdedication – Regroupement de la section dédicaces d’un livredestructorsynopsis – Résumé de la syntaxe pour un destructeur en programmationedition – Nom ou numéro d’une édition d’un documenteditor – Nom de l’éditeur d’un documentemail – Adresse mail

48

ANNEXES

emphasis – Texte mis en valeurentry – Cellule d’un tableauentrytbl – Tableau apparaissant dans une cellule d’un tableauenvar – Environnement logiciel variableepigraph - Epigrapheequation – Equation mathématique affichéeerrorcode – Code d’erreurerrorname – Intitulé d’une erreurerrortext – Message d’erreurerrortype – Classification d’un message d’erreurexample – Exemple sans titreexceptionname – Nom d’une exceptionfax – Numéro de faxfieldsynopsis – Nom d’un champ dans une définition de classefigure – Illustration sans titrefilename – Nom de fichierfirstname - Prénomfirstterm – Première occurrence d’un termefootnote – Note de bas de pagefootnoteref – Renvoi à une note de bas de pageforeignphrase – Mot ou phrase écrite en langue différente de celle du reste du documentformalpara – Paragraphe avec titrefuncdef – Nom d’une fonction et son type de retourfuncparams – Paramètres d’une fonction référencé à l’aide d’un pointeur dans un résumé de syntaxefuncprototype – Prototype de fonctionfuncsynopsis – Résumé de syntaxe d’une définition de fonctionfuncsynopsisinfo – Informations supplémentaires sur la définition ou le résumé de syntaxe d’une définition de fonctionfunction – Nom d’un fonction ou d’un pointeur en langage de programmationglossary – Glossaireglossaryinfo – Méta information sur un glossaireglossdef – Définition sur une entrée de glossaireglossdiv – Section de glossaireglossentry – Entrée de glossaire ou de liste d’un glossaireglosslist – Regroupement d’entrées de glossaireglosssee – Renvoi d’une entrée de glossaire vers une autreglossseealso – Renvoi supplémentaireglossterm – Terme de glossairegraphic – Objet visuel affiché sur une nouvelle lignegraphicco – Illustration contenant des zones réactivesgroup – Groupe d’éléments dans la définition d’une commandeguibutton – Texte figurant sur un bouton sur une interface graphiqueguiicon – Illustration ou texte faisant office d’icône sur une interface graphiqueguilabel – Texte faisant office de label sur une interface graphiqueguimenu – Nom d’un menu sur une interface graphiqueguimenuitem – Nom du dernier élément d’un menu sur une interface graphiqueguisubmenu – Nom d’un sous-menu sur une interface graphiquehardware – Tout élément matériel d’un ordinateur.highlights – Résumé des thèmes principaux abordés dans un documentholder – Nom d’un propriétaire de droits d’auteurs

49

ANNEXES

honorific – Titre d’une personnehtml:form – Inclusion d’éléments venant du XHTMLimagedata – Redirection externe vers une illustration graphiqueimageobject – balise générique permettant de renseigner les méta informations de imagedata.imageobjectco - balise générique permettant de renseigner les zones réactives d’une illustrationimportant – Admonition mise en valeur par rapport au texte.index – Indexindexdiv – Section d’un indexindexentry – Entrée d’un indexindexinfo – Méta informations sur un indexindexterm – Balisage des termes à indexer.informalequation – Equation mathématique affichée sans titreinformalexample – Exemple affiché sans titreinformalfigure – Chiffre sans titreinformaltable – Tableau sans titreinitializer – Identification de la valeur par défaut d’un FieldSynopsisinlineequation – formule ou équation mathématique survenant au sein d’une ligne du texteinlinegraphic – Elément contenant ou dirigeant vers un graphique apparaissant au sein d’une ligne du texte.inlinemediaobject – fichier multimédia apparaissant au sein d’une ligne.interface – Element d’une interface graphiqueinterfacename - Nom d’une interface graphiqueinvpartnumber – Numéro d’inventaireisbn - Numéro international normalisé du livreissn – Numéro de série international normalisé d’un périodique.issuenum – Numéro d’édition ou de parution.itemizedlist – Liste dont les entrées sont marquées par des pucesitermset – Rassemblement de termes d’un index dans les méta informations d’un document.jobtitle – L’intitulé du poste d’un individu dans un organisme donnékeycap – Caractère(s) imprimés sur une touche d’un clavierkeycode – Code interne correspondent à la touche d’un clavier keycombo – Combinaison de touches.keysym – Nom symbolique d’une touche sur un clavier.keyword – Mot-clef décrivant le contenu d’un documentkeywordset – Série de mots-clef.label – Jalon d’une question ou d’une réponse.legalnotice – Mention des obligations légales ou d’une garantielhs - La partie de gauche d’un document conçu grâce à l’EBNFlineage – Partie du nom constituant le lignage d’une personnelineannotation – Commentaire figurant sur une ligne traité différemment du reste de la lignelink – Lien hypertextelistitem – Mention des éléments d’une listeliteral – Texte sur une ligne représentant une valeur littéraleliterallayout – Bloc de texte devant respecter scrupuleusement les sauts de lignes et les espaceslot –Liste des titres des objets tels que les tableaux ou les chiffres dans un document.lotentry – Entrée d’une liste de titresmanvolnum – Numéro de référence d’un volumemarkup – Série de balises de formatage à représenter de littéralementmathphrase – Expression mathématique pouvant être représentée avec du texte ordinaire et peu de balisesmedialabel – Nom identifiant le support contenant une information

50

ANNEXES

mediaobject – Affichage d’un objet multimédia.mediaobjectco – Objet multimédia contenant des zones réactives/cliquables.member – Elément d’une liste simplemenuchoice – Sélection ou série de sélections d’un menumethodname – Nom d’une méthodemethodparam – Paramètres d’une méthodemethodsynopsis – Résumé de la syntaxe d’une méthodemml:math – Equation MathMLmodespec – Information spécifique à une application et nécessaire pour la réalisation d’un OLink.modifier – Modifieur d’un résumé.mousebutton – Nom conventionnel d’un bouton d’une sourismsg – Message d’une série de messages.msgaud – Public auquel le message d’une série de messages est destinémsgentry – Liste d’entrées dans une série de messagesmsgexplan – Contenu explicatif lié à un message dans une série de messagesmsginfo – Information sur un message dans une série de messagesmsglevel – Degré d’importance ou de sérieux d’un message dans une série de messages msgmain – Premier élément d’un message dans une série de messages msgorig – Origine d’un message dans une série de messages msgrel – Information liée à un message dans une série de messagesmsgset – Série détaillée de message (d’erreurs généralement)msgsub – Sous entrée d’un message dans une série de messages msgtext – Texte figurant au sein d’un message dans une série de messages nonterminal – Elément non terminal dans un module EBNFnote – Message séparé du texteobjectinfo – Méta information d’un objetolink – Lien pointé sur une cible de façon, en s’aidant d’une entitéooclass – Classe d’un langage de programmation basé sur les objets.ooexception - Exception d’un langage de programmation basé sur les objetsoointerface - Interface dans un langage de programmation basé sur les objetsoption – Option d’une commande logicielleoptional – Information optionnelleorderedlist – Liste dont chaque entrée est signalée par un indicateur séquentielorgdiv – Division d’une organisationorgname – Nom d’une organisation n’étant pas une grande sociétéotheraddr – Information sans catégorie dans une adresseothercredit – Personne ou entité (autre qu’un auteur ou un éditeur) remerciée dans un documentothername – Elément du nom d’une personne n’étant ni son prénom, ni son nom de famille, ni son lignagepackage - Paquetagepagenums – Numéros de page dans un livre, à usage bibliographiquepara - Paragrapheparamdef – Définition des paramètres d’une fonction en langage de programmationparameter – Valeur ou référence symbolique à une valeurpart – Division d’un livrepartinfo – Méta information sur une division d’un livrepartintro – Introduction aux contenus d’une division d’un livrepersonblurb – Courte description ou remarque sur une personnepersonname – Nom personnel d’un individuphone – Numéro de téléphone

51

ANNEXES

phrase – Zone de textepob – Boîte postale d’une adressepostcode – Code postal d’une adressepreface – Partie d’introduction précédente le premier chapitre d’un livreprefaceinfo – Méta-information d’une préfaceprimary – Mot(s) les plus importants d’une liste de termes à indexerprimaryie - Mot(s) les plus importants d’une liste de termes dans une entrée d’un indexprinthistory – Historique des impressions d’un documentprocedure – Liste d’opérations à mener dans une séquence bien définieproduction – Production dans un ensemble de productions EBNFproductionrecap – Renvoi à une production EBNFproductionset – Ensemble de productions EBNFproductname – Nom officiel d’un produitproductnumber – Nombre attribué à un produitprogramlisting – Listing littéral d’un ou d’une partie d’un programmeprogramlistingco - Listing littéral d’un ou d’une partie d’un programme avec des zones réactivesprompt – Caractère ou enchaînement signalant le début d’une zone de saisieproperty – Donnée associée à un élément d’un ordinateurpubdate – Date de publication d’un documentpublisher – Editeur d’un documentpublishername – Nom de l’éditeur d’un documentpubsnumber – Numéro (autre que l’ISBN, l’ISSN ou le numéro d’inventaire) attribué à une éditionqandadiv – Division avec titre dans un ensemble de Questions et Réponsesqandaentry – Question ou réponse d’un ensemble de Questions et Réponsesqandaset - Ensemble de Questions et Réponsesquestion – Question d’un ensemble de Questions et Réponsesquote – Citation en mode discours de discours indirectrefclass – Portée ou autre indicateur d’applicabilité d’une entrée au sein de référencesrefdescriptor – Description du sujet d’une page de référencesrefentry – Page de référencesrefentryinfo – Méta information d’une page de référencesrefentrytitle - Le titre d'une page de référence reference - Une liste des entrées de référence referenceinfo - méta informations pour une référence refmeta - méta informations pour une référence refmiscinfo - Méta informations pour une référence autre que les numéros du titre ou les numéros du tome refname - Le nom du sujet (des sujets) d'une page de référence refnamediv - Le nom, le but, et la classification d'une page de référence refpurpose - Un court sommaire d'une longueur d'une phrase traitant le sujet d'une page de référence refsect1 - Une sous section d'une référence refsect1info - Méta information pour une RefSect1 refsect2 - Une sous section d'une RefSect1 refsect2info - Méta information pour une RefSect2 refsect3 - Une sous section d'une RefSect2 refsect3info - Méta informations pour une RefSect3 refsection - Une section récursive dans une référence refsectioninfo - Méta information pour une référence refsynopsisdiv - Un synopsis syntactic du sujet de la page de référence refsynopsisdivinfo - Méta informations pour RefSynopsisDiv releaseinfo - Information à propos d'une version partifculière d'un document

52

ANNEXES

remark - une remarque, ou un commentaire, sur la présentation d'une ébauche de manuscritreplaceable - Contenu qui doit être éventuellement remplacé par l'utilisateurreturnvalue - La valeur ce qui est rendue par une fonctionrevdescription - Une description élaborée d'une révision d'un documentrevhistory - Un historique de révisions d'un documentrevision - Une description d'une seule révision dans l'historique de révision d'un documentrevnumber - Un numéro de révision de documentrevremark - Une description d'une révision de documentrhs - le côté droite d'une production EBNFrow - Une ligne dans une tablesbr - Un saut de ligne explicit dans un sommaire de commandescreen - Le texte que l'utilisateur voit éventuellement sur l'écran d'ordinateurscreenco - Un écran contenant des champs liés aux libellésscreeninfo - Informations détaillant comment un écran a été conçu et produitscreenshot - Une représentation de ce que voit éventuellement l'utilisateur sur l'écran d'ordinateursecondary - Un mot ou terme secondaire dans un terme d'indexsecondaryie - Un terme secondaire uniquement dans l'index au lieu de dans le textesect1 - Une section de niveau supérieur du documentsect1info - Métainformations d'une Sect1sect2 - Une sous section dans une Sect1sect2info - Métainformations d'une Sect2sect3 - Une sous section dans une Sect2sect3info - Métainformations d'une Sect3sect4 - Une sous section dans une Sect3sect4info - Métainformations d'une Sect4sect5 - Une sous section dans une Sect4sect5info - Métainformations d'une Sect5section - Une section recursivesectioninfo - Méta informations d'une section récursivesee - Une partie d'un terme d'index menant le lecteur à un autre terme dans l'indexseealso - Partie d'un terme d'index menant le lecteur à un autre terme dans l'index en addition du terme où se trouve ce référentseealsoie - Un référent "See also" dans un index au lieu de dans le texteseeie - Un référent "See entry" dans un index au lieu de dans le texteseg - Un élément d'une liste dans une liste segmentéeseglistitem - Un élément de liste dans une liste segmentéesegmentedlist - Une liste segmentée, une liste des ensembles d'élémentssegtitle - Le titre d'un élément d'un objet de liste dans une liste segmentéeseriesvolnums - Les numéros de tome dans une série de livresset - Une collection de livressetindex - Un index d'un ensemble des livressetindexinfo - Méta informations d'une SetIndexsetinfo - Méta informations d'un Setsgmltag - Une composante d'un langage SGMLshortaffil - Une description brève d'un lienshortcut - Un raccourci d'une action que l'on peut choisir d'un menusidebar - Une partie d'un document qui est isolée du restesidebarinfo - Méta informations d'un "Sidebar"

53

ANNEXES

simpara - Un paragraphe contenant du texte et du marquage et non pas d'éléments de blocsimplelist - Une liste simple des mots ou des phrases courtessimplemsgentry - l'emballage d'un terme plus simple dans un ensemble des messagessimplesect - Une section d'un document sans sous répertoirespanspec - Informations de formatage d'une colonne étendue dans un tableaustate - Un état ou une province dans un adressestep - Une action dans une procédurestepalternatives - Des choix alternatifs dans une procédurestreet - Le nom de la rue dans une adressestructfield - Un champ dans une structurestructname - Le nom d'une structuresubject - Un ensemble des termes décrivant le sujet d'un documentsubjectset - Un ensemble des termes décrivant le sujet d'un documentsubjectterm - Un terme parmi un ensemble des termes décrivant le sujet d'un documentsubscript - Un indicesubsteps - Un emballage d'un sous répertoire des choix dans une procéduresubtitle - Le sous-titre d'un documentsuperscript - Un exposantsurname - Nom de famillesvg:svg - Un image SVGsymbol - Un nom qui est remplacé par une valeur avant traitementsynopfragment - Une partie d'un CmdSynopsis en dehors de la partie principale du textesynopfragmentref - Une référence d'une sommaire de commande fragmentéesynopsis - Un élément général qui présente le syntaxe des commandes ou des fonctionssystemitem - Un terme pertinent à un systèmetable - Un tableau formel dans un documenttask - une tâche à effectuertaskprerequisites - Les éléments réquis pour une tâchetaskrelated - Informations pertinentes à un tâchetasksummary - Sommaire d'une tâchetbody - L'emballage des lignes d'un tableautd - L'entrée d'un tableau HTMLterm - Le(s) mot(s) défini(s) ou décrit dans une liste variabletermdef - La définition d'un terme dans une lignetertiary - Un mot tertiaire dans un terme d'indextertiaryie - Un mot tertiaire dans un terme d'index au lieu de dans le textetextdata - Une référence aux données en dehors du textetextobject - Un emballage d'une description d'un objet et de ses méta informationstfoot - Un pied de tableau d'une ligne ou plustgroup - Un emballage du contenu principal d'un tableau ou d'une partie d'un tableauth - L'en-tête d'un tableau HTMLthead - Un en-tête de tableau composé d'une ou plusieurs lignestip - Un conseil à l'utilisateur mis en dehors du textetitle - Le texte d'un titre d'une section d'un documenttitleabbrev - L'abréviation d'un titretoc - Une table des matièrestocback - Un élément dans une table des matières pour un composant de supporttocchap - Un élément dans une table des matières pour un composant dans la partie principale du textetocentry - Un composant dans le titre d'une table des matières

54

ANNEXES

tocfront - Un élément dans une table des matières pour les composants en têtetoclevel1 - Un élément de niveau supérieur dans une table des matières pour les composants pertinents aux chapitrestoclevel2 - Un élément de niveau secondaire dans une table des matières pour les composants pertinents aux chapitrestoclevel3 - Un élément de niveau tertiaire dans une table des matières pour les composants pertinents aux chapitrestoclevel4 - Un élément de quatrième niveau dans une table des matières pour les composants pertinents aux chapitrestoclevel5 - Un élément de cinquième niveau dans une table des matières pour les composants pertinents aux chapitrestocpart - Un élément dans une table des matières pour une partie d'un livretoken - Une unité d'informationtr - une ligne dans un tableau HTMLtrademark - Une marque de commercetype - Le classement d'une valeurulink - Un lien qui s'adresse à son cible en utilisant un URL (Uniform Resource Locator)url - Uniform Resource Identifier (Identifiant de ressources uniforme)userinput - Données enregistrées par l'utilisateurvarargs - Un élément vide dans un sommaire de fonction indiquant une quantité variable des argumentsvariablelist - Une liste dont chaque enregistrement est composé par un ensemble d'un ou plusieurs termes et une descriptionvarlistentry - Un emballage d'un ensemble des termes et la description dans une liste variablevarname - Le nom d'une variablevideodata - Un lien aux données de vidéo externesvideoobject - Un emballage des données de vidéo et ses méta informationsvoid - Un élément vide dans un sommaire de fonction indiquant que la fonction ne répond pas aux argumentsvolumenum - Le numéro de tome d'un document dans un ensemblewarning - Un avertissement qui n'est pas dans le textewordasword - Un mot à comprendre uniquement comme un mot et qui ne représente rien d'autrexref - Une référence liée à une autre partie du documentyear - L'année de publication d'un document

INDEX

55

A

Acrobat.........................................................................................................................................................................21, 43

Article...................................................................................................................................................36, 37, 38, 40, 41, 42

ASCII....................................................................................................................................................................................8

Attribut...............................................................................................................................25, 26, 27, 28, 30, 35, 37, 39, 40

B

Balise

d’avertissement..........................................................................................................................................................4, 39

d’information.............................................................................................................................................................4, 38

de structure.................................................................................................................................................................4, 37

racines..................................................................................................................................................................4, 36, 37

C

caractères..........................................................................................................................................................26, 27, 29, 31

CSS...............................................................................................................................................................................17, 33

D

Document...........................3, 7, 8, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 25, 26, 27, 31, 32, 33, 35, 36, 39, 40, 41, 42, 43

DTD..............................................................................3, 7, 9, 10, 12, 15, 16, 18, 19, 20, 24, 25, 31, 32, 35, 36, 40, 41, 43

E

Eléments d’avertissement

<important>....................................................................................................................................................................39

<note>............................................................................................................................................................................39

<remark>........................................................................................................................................................................39

<warning>......................................................................................................................................................................39

Eléments d’information

<emphasis>....................................................................................................................................................................38

<example>......................................................................................................................................................................39

<link>.............................................................................................................................................................................39

<ulink>...........................................................................................................................................................................39

56

INDEX

Eléments de structure

<blockquote>.................................................................................................................................................................37

<chapter>.................................................................................................................................................................37, 38

<itemizedlist>.................................................................................................................................................................37

<listitem>.......................................................................................................................................................................37

<orderedlist>..................................................................................................................................................................37

<para>................................................................................................................................................................14, 37, 42

<title>.........................................................................................................................................13, 27, 36, 37, 39, 40, 42

Exemples................................................................................................8, 13, 14, 17, 19, 21, 26, 27, 28, 34, 39, 40, 41, 43

F

Formats.....................................................................................................................................................7, 8, 10, 15, 21, 43

H

HTML.......................................................................................................7, 8, 15, 17, 19, 20, 24, 25, 26, 32, 33, 34, 35, 43

I

Image..................................................................................................................................................................4, 14, 24, 41

L

Langage................................................................................................................................................................................7

Linux Documentation Project (LDP)...................................................................................................................................9

P

PDF...........................................................................................................................................................................8, 25, 43

R

Rédaction......................................................................................3, 4, 24, 26, 27, 28, 29, 30, 31, 36, 37, 38, 39, 40, 41, 42

S

Séparation données-traitement...........................................................................................................................................15

SGML...................................................................................................................................................................7, 9, 10, 31

57

INDEX

T

Transformation.........................................................................................................................................................4, 24, 43

TXT....................................................................................................................................................................................43

U

UNIX..............................................................................................................................................................................9, 32

UTF-8.................................................................................................................................................................................27

V

Validation..................................................................................................................................................................3, 24, 32

W

WALSH Norman..................................................................................................................................................................9

WYSIWYG........................................................................................................................................................................15

X

XML...........................................3, 7, 8, 9, 10, 14, 17, 19, 20, 21, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 40, 41, 43

xmllint.................................................................................................................................................................................32

XSL.......................................................................................................................................3, 17, 24, 32, 33, 34, 35, 41, 43

XSLT..................................................................................................................................................................................10

58

GLOSSAIRE

ASCII(American Standard Code for Information Interchange) Norme populaire de codage de caractères en informatique. Sa nomenclature inclut 95 caractères, ce qui exclut les lettres accentuées et bon nombre de caractères spéciaux n'existant pas en langue anglaise.

Balise Caractère de structuration affectant le document, mais invisible au lecteur à moins d'en lire la source.

CSSCascading Style Sheets. Langage de présentation utilisé pour les documents HTML et XML, au même titre que le langage XSL pour le XML. Il est réputé plus simple que son homologue extensible (?), mais souffre par conséquent parfois d'hypospécificité.(?)

Davenport Group

[Un] groupe d'experts en documentation technique qui a créé DocBook. Il s'agit du partenariat entre l'éditeur O'Reilly et l'entreprise HAL. Le groupe OASIS a pris en main le développement du logiciel DocBook a la cessation d'activité de la boîte (R) en 1998.

DocBook Nom d'un langage de balisage pour la documentation technique

DTDDocument Type Definition, ou Définition de Type de Document. Document décrivant un modèle de structure logique de fichier XML ou SGML, leur contenu, sous-éléments, attributs. La hiérarchie qu'indique une DTD doit être validée..

DVIDeVice Independent. Format de fichier ouvert contenant des données binaires interprétables par un terminal mais n'étant pas destinées à être lues et comprises pas l'utilisateur. Il informe le terminal de l'apparence d'un document de façon très sommaire, voire lacunaire, prix à payer.

GNU Gnu's Not Unix. Projet de système d'exploitation n'utilisant que des logiciels libres, dont la motivation est éthique et relèvent de la philosophie politique.

HALHAL Computer Systems. Entreprise aujourd'hui disparue dont la stratégie était basée sur la simplification de tout ce qui touche à l'utilisateur tout en maintenant un maximum de fonctionnalités. Elle faisait partie des deux entreprises à l'origine du développement de DocBook. La personne morale a été absorbée par Fujitsu, qui a fermé cette filiale en 2001.

HTML HyperText Markup Language. Langage de balisage de fichiers qui a permis d'adapté le le SGML de façon optimale sur internet, de façon exhaustive, voir complexe.

ISOInternational Standard Organisation. Organisme de normalisation cherchant à réguler les domaines industriels et commerciaux dans l'intérêt général du public et des organismes producteurs/organisations commerciales.

OASISOrganization for the Advancement of Structured Information Standards. Consortium mondial de standardisation et de normalisation de tout ce qui relève du XML entre autres. Des sociétés telles qu'IBM, Boeing, Microsoft, Reuters ou Sun Microsystems en font partie.

Open SourceCaractéristique d'un logiciel ou d'un système d'exploitation dont les codes de programmation sont accessibles au public, ce qui rend leur développement possible (voir encouragé) pour les utilisateurs (?).

Oxygen XML editor

Logiciel de création et d'édition de fichiers XML et de feuilles de styles XSL ou CSS qui a pour politique de se rapprocher du concept du WYSIWYG, à l'inverse de notepad par exemple.

59

GLOSSAIRE

PDFPortable Document Format (Adobe Systems). Un format licencié de description de pages qui a la particularité d'être extrêmement rigide au niveau de sa mise en forme et de tout c equi relève du visuel, de telle sorte qu'il est impossible pour une application de faire la moindre erreur d'interprétation et de rendu.

progiciel Logiciel réservé à une utilisation à des fins professionnelles. Il s'agit souvent d'un ensemble bureautique fait à l'intention d'entreprises commerciales

RTFRich Text Format (Microsoft). [Un] format simple de documentation dont la banalité et la popularité sont les principaux atouts car elles lui permettent de faire la navette entre les différentes plateformes ou les différents logiciels de traitement de texte.

SGML(Standard Generalized Markup Language) Langage de description à balises dont le principe fondamental est la séparation de la structure logique des documents de leurs mises en pages. Le HTML et les applications Docbook en sont issus.

Style Ce qui relève de la mise en page ou de la typographie d'un document. Ce qui se réfère à ce qui sera visible à l'utilisateur.

Type de sa DTD

Type de document dont le principal avantage est la simplicité du langage de balisage et de ses éventuelles conversions.

Unités hiérarchiques Eléments renseignant la structure d'un document.

Unités sémantiques Eléments spécifiant les spécificités de prise en charge de la prose visible.

UNIXSystème d'exploitation gratuit dont l'expansion et le développement sont basés sur les retours et modifications des utilisateurs. La multiplicité des versions distribuées a été à l'origine de problèmes de compatibilité et a par conséquent diminué l'attractivité de ce système d'exploitation (mais pas à un petit nombre de ses dérivés).

W3C World Wide Web Consortium. Organisme aidant à la normalisation et à la compatibilité des langages et formats des documents destinés au Web à l'aide de recommandations

WYSIWYGWhat you see is what you get. Concept de transparence visée par certains outils de traitement graphique (texte, image...). Ces outils permettent à l'utilisateur d'intervenir sur un document en lui montrant simultanément à quoi ressemblera ce qu'il créée avec son logiciel.

XMLeXtensible Markup Language. Langage de balisage générique qui a permis que le SGML soit utilisé de façon optimale sur internet, de façon plus simple et conviviale qu'en HTML. Son atout principal est la facilité de changement de style des documents qu'il produit.

XSL eXtensible Stylesheet Language. Type de feuille de style (spécifiant l'apparence et facilitant les conversions d'un document) propre au langage de balisage XML.

XSL-FOeXtensible Stylesheet Language-Formatting Objects. Une recommandation faite par le W3C de mise en forme des documents XSL. Elle préconise une organisation des différents types de contenus pouvant figurer sur une feuille de style.

XSLT eXtensible Stylesheet Language Transformation. Langage de transformation utilisé pour une feuille XSL, permettant les conversions de fichiers.

60

SOURCES

61

Sites Internet

http://www.ibm.com/developerworks/library/l-docbk.htmlhttp://nwalsh.com/docs/tutorials/winwriters2001/noframes/foil10.htmlhttp://www.dpawson.co.uk/DocBook/reference.html#d21e1969http://xml.chez.com/initiation/http://www.dpawson.co.uk/DocBook/reference.html#d21e133http://nwalsh.com/docs/tutorials/winwriters2001/noframes/foil03.htmlhttp://www.docbook.org/tdg/en/html/docbook.htmlhttp://www.grappa.univ-lille3.fr/~tommasi/Homepage/SurXml.htmlhttp://www.u-picardie.fr/~ferment/xml/xml.htmlhttp://www.traduc.org/docs/HOWTO/lecture/DocBook-Install.htmlhttp://www.ajlsm.com/formation/xml/notes/html/xml/docs/docs.htmlhttp://www.grappa.univ-lille3.fr/polys/xml-DG/xml.htmlhttp://opensource.bureau-cornavin.com/crash-course/fr/doc-structure.htmlhttp://www.grappa.univ-lille3.fr/~torre/Enseignement/Master-ID/M1-2005/docbook.htmlhttp://www.ajlsm.com/formation/xml/notes/html/xml/docs/dtd.htmlhttp://www.commentcamarche.net/contents/xml/xmlxsl.php3http://www.grappa.univ-lille3.fr/

Livres

Comprendre XSLTPar Bernd Amann, Philippe RigauxPublié par O'Reilly France, 2002

DocBook: The Definitive GuidePar Norman Walsh, Leonard MuellnerEdition: illustratedPublié par O'Reilly, 1999

DocBook XSL: The Complete GuidePar Bob Stayton Edition: 2Publié par Sagehill Enterprises, 2003

DocBook: la référencePar Norman Walsh, Leonard Muellner

Publié par O'Reilly, 2001

NOTES

62

Détails sur barême

Saisie et mise en pageRecto-verso : vous n’avez pas coché ‘pages en vis-à-vis’ (=> titre courant à gauche sur

toutes les pages).

Quelques espaces avec doubles/triples retour chariot

Le folio est bien proche du bord du papier.

Feuille de style(Difficile à juger avec Word 2003...)

Il semble qu’il y ait accumulation de noms peu parlants – mais est-ce votre faute ?

En revanche, le mode ‘Plan’ n’affiche rien, ce qui montre que votre structure de titres est défectueuse (la

génération de la table des matières donne le résultat de la page suivante : édifiant !)

NB Evitez la mise à jour automatique des styles.

Styles: applicationQuelques incohérences :

- Style16 recouvre des mise en forme différentes (voir p 12)

- Docboook corp de txt est d’abord centré (p2), puis aligné gauche (p7).

Tableaux, images, copies d'écranOK (mais tableau p 43 : gérer les espaces sans retour chariot)

Index, TDMTDM : pb de structure (voir + haut)

Index : OK, mais il aurait été mieux sur 2 colonnes (num. de pages trop éloignés des entrées)

Esthétique générale B

Adéquation au publicB

RédactionAlice (préface, partie 3) : Bon ensemble. Les explications sont assez claires, la progression

est réfléchie, et le quiz une très bonne idée.

David (partie 1, glossaire, annexes) : Pas de souci côté français, mais vos développements

sont souvent trop techniques pour le public visé – c’était d’ailleurs la principale difficulté du

sujet. La filiation SGML-HTML-XML aurait gagné à être présentée de façon plus explicite,

pour donner des repères, notamment chronologiques, à vos lecteurs.

René Gilles (partie 2, glossaire, annexes) : Rédaction et présentation assez claires. Mêmes

pbs que pour David, mais en moins aigus car vous ne traitez que la 2e partie.

Pour tous : c’était une bonne idée de mettre en rouge les termes principaux (définis dans le

glossaire), mais il aurait fallu expliciter cette convention en début d’ouvrage pour que cela

soit directement utile à vos lecteurs.

63

Résultat de la génération de laTable des matières

Remarquez les redondances (en-têtes-de page, doubles affectations de style)

PRÉFACE..........................................................................................................................................................2

TABLE DES MATIÈRES.................................................................................................................................3

TABLE DES MATIÈRES.................................................................................................................................4

INTRODUCTION GÉNÉRALE - SOMMAIRE...........................................................................................6

DOCBOOK : QU’EST-CE QUE C’EST ?...............................................................................................................7

DOCBOOK : POURQUOI ?..................................................................................................................................8

DOCBOOK : HISTORIQUE ?...............................................................................................................................9

DOCBOOK : QUELLE VERSION ?.....................................................................................................................10

L’APPROCHE THÉMATIQUE - SOMMAIRE..........................................................................................12

UN LANGAGE SIMPLE.......................................................................................................................................13

LES ÉLÉMENTS DE CE LANGAGE 13

UN LANGAGE SIMPLE.......................................................................................................................................14

UN LABEL INSTALLÉ SUR DE SOLIDES BASES..................................................................................................15

LA DTD (DOCUMENT TYPE DEFINITION) 15


LE STYLE 16



UN CODE AUX PRINCIPES ÉPROUVÉS...............................................................................................................19

UN BALISAGE FLEXIBLE... 19

... D’OÙ DÉCOULE UNE GRANDE PRODUCTIVITÉ 19

UN CODE AUX PRINCIPES ÉPROUVÉS...............................................................................................................20

LA MÉTHODE EN QUESTION 20

UN FORMAT EXPORTABLE................................................................................................................................21

BÉMOLS............................................................................................................................................................22

CRÉATION D’UN DOCUMENT DOCBOOK - SOMMAIRE..................................................................24

INTRODUCTION.................................................................................................................................................25

XML.................................................................................................................................................................26

RÉDACTION DU XML 26

XML.................................................................................................................................................................27

XML.................................................................................................................................................................28

XML.................................................................................................................................................................29

XML.................................................................................................................................................................30

XML.................................................................................................................................................................31

XML.................................................................................................................................................................32

VALIDATION DE LA DTD 32

XML.................................................................................................................................................................33

64

INTRODUCTION AUX FEUILLES XSL 33

XML.................................................................................................................................................................34

XML.................................................................................................................................................................35

DOCBOOK.........................................................................................................................................................36

RÉDACTION 36

DOCBOOK.........................................................................................................................................................37

DOCBOOK.........................................................................................................................................................38

DOCBOOK.........................................................................................................................................................39

DOCBOOK.........................................................................................................................................................40

DOCBOOK.........................................................................................................................................................41

DOCBOOK.........................................................................................................................................................42

DOCBOOK.........................................................................................................................................................43

TRANSFORMATION 43

ANNEXES.......................................................................................................................................................44

ANNEXES.......................................................................................................................................................45

ANNEXES.......................................................................................................................................................46

ANNEXES.......................................................................................................................................................47

ANNEXES.......................................................................................................................................................48

ANNEXES.......................................................................................................................................................49

ANNEXES.......................................................................................................................................................50

ANNEXES.......................................................................................................................................................51

ANNEXES.......................................................................................................................................................52

INDEX..............................................................................................................................................................53

INDEX..............................................................................................................................................................54

INDEX..............................................................................................................................................................55

GLOSSAIRE...................................................................................................................................................56

GLOSSAIRE...................................................................................................................................................57

SOURCES........................................................................................................................................................58

NOTES..............................................................................................................................................................59

65

exercices corriges pdf · web viewprÉface ce guide s’adresse à toute personne désireuse de...

Documents