Protocole de rédaction

Statut : Ébauche
Modification: 2004-01-23
Modification: 2004-03-10 YM (ajouté role=ret pour définitions retenues au glossaire)

Résumé

Ce document est avant tout un aide mémoire et un guide de rédaction. Il s'adresse aux auteurs du Cadre de Référence Gouvernemental en Gestion Intégrée des Documents.

Il a pour but d'expliquer comment structurer l'information à l'aide de la DTD (DocBook) et l'éditeur XMetal, et de décrire les pratiques de rédaction à adopter pour avoir un produit final uniforme de qualité, accessible à tous les gestionnaires de l'information et les administrateurs du Gouvernement du Québec. Il est important de garder en mémoire que ceux-ci sont nos lecteurs.

Attention: Voici les ajouts faits en date 2004-01-23 et du 2004-03-11que l'on retrouvera dans la section addendum


NE PAS ÉDITER. La table des matères sera générée automatiquement ici.

Remarques préliminaires

Voici quelques particularités d'utilisation avec XMetal.

Checklist

Attention: une fois votre texte terminé, prenez le temps de réviser et de compléter les points suivants:

Introduction

Le style que nous préconisons pour rédiger l'hyperdocument est celui de la rédaction technique. Soit un style informatif qui pourra néanmoins s’inspirer du style journalistique afin de rendre plus vivant le ton de l’exposé. Auparavant, plusieurs considérations techniques doivent être définies. Nous aborderons les points suivants:

Le rédacteur pourra consulter le guide DocBook: The Definitive Guide v.2.0.8 décrivant les éléments de la DTD, ou la version aide de celui-ci.

Dans la section addenda à la fin de ce document-ci, chacun pourra ajouter des points nouveaux à inclure dans le protocole de rédaction.


Organisation des fichiers

Les fichiers nécessaires à la rédaction et à la production de l'hyperdocument se retrouvent sur l'espace collaboratif du GRDS dédié au projet CRGGID, sous le dossier {CRGGID}/redaction-CRGGID/.

Structure des dossiers de l'espace de rédaction de l'hyperdocument

L'espace de rédaction est situé sous: {CRGGID}/redaction-CRGGID/

Voici une brève description des dossiers présents dans l'espace de rédaction:

Dossiers de l'espace de rédaction
Dossier Description
~V indique un numéro de version du fichier. Ex.: chap_03-amorce_20030711.xml
~ID représente une chaîne servant d'identifiant. Ex.: chap_01-revue-litterature_20030711.xml
apps/Contient les applications externes utilisées par la moulinette de publication, dont Apache Ant et FOP.
artefacts/Dossier contenant les images et autres objets externes imbriqués dans le contenu du Guide. À noter que certains exemples employés dans le Guide peuvent être déposés à cet endroit.
conf/Contient les fichiers de configuration de la moulinette, dont le fichier FOP-userconfig.xml pour les configuration de FOP.
doc/Contient les documents utilisés par la moulinette de publication, dont aide-publication.txt (texte d'aide à la publication) et message-courriel_20030716.txt (gabarit du message de courriel qui notifie lors d'une nouvelle publication du Guide.
DTD/ Contient les fichiers de la DTD CRGGID (et ceux de DocBook).
entites/Contient le fichier driver qui assemble l'hyperdocument.
gestion/Dossier statutaire pour les documents de gestion liés à l'activité de rédaction.
protocole-redaction/Contient le protocole de rédaction.
sections-flottantes/Contient des fichiers contenant des sections en cours de rédaction. Lorsqu'une section est achevée, le contenu du fichier est copié dans un des fichiers de l'hyperdocument (sources/*.xml). Le fichier de la section flottante est alors déplacé dans le sous-dossier sections-flottantes/sections-integrees/
sources/Contient les sources de l'hyperdocument. Voir le tableau plus bas
temp/Dossier temporaire utilisé par la moulinette lors de la production de l'hyperdocument. Ne pas utiliser.
tests/On peut utiliser ce dossier pour effectuer divers tests.
utilitaires/Contient l'utilitaire permettant d'installer les gabarits et macros utilisés par XMetal sur les postes du laboratoire.
xsl/Contient l'application XSL de DocBook ainsi que les personnalisations requises pour produire l'hyperdocument.

Emplacement des fichiers XML de développement de l'hyperdocument

Les fichiers XML qui constituent l'hyperdocument sont déposés dans le dossier {CRGGID}/redaction-CRGGID/sources/. Voici une liste des fichiers qui se retrouvent probablement à cet endroit avec une brève description:

L'emplacement des fichiers XML de développement de l'hyperdocument a été choisi pour les raisons suivantes:

Structure des fichiers du guide
Fichier Description
~V indique un numéro de version du fichier. Ex.: chap_03-amorce_20030711.xml
~ID représente une chaîne servant d'identifiant. Ex.: chap_01-revue-litterature_20030711.xml
cadre-reference_~V.xmlFichier global pour le guide.
cadre-reference-info_~V.xmlFichier contenant les métadonnées.
cadre-reference-corps_~V.xmlFichier décrivant le corps du document.
chap_~ID_~V.xmlFichiers contenant chacun un chapitre du Cadre de référence.
annex_~ID_~V.xml Fichiers contenant chacun des annexes du Cadre de référence.
glossaire_~V.xmlFichier contenant le glossaire.
bibliographie_~V.xmlFichier contenant la bibliographie.

Étapes de création d'un nouveau fichier XML du Guide

L'ajout d'un chapitre ou d'une annexe au cadre de référence implique la création d'un nouveau fichier. Les fichiers XML seront créé à l'aide d'un gabarit dans XMetal.

  1. L'ajout d'un fichier au guide peut s'accompagner d'un changement important de structure du guide. Au besoin, créer une nouvelle version du guide.
  2. Créer un nouveau fichier XML à partir des gabarits sous: "File > New " de XMetal et choisir sous l'onglet "CRGGID" le document désiré.
  3. Sauvegarder le document à l'endroit approprié sous le format ID_V.xml" ou l'ID est l'identificateur unique de l'élément racine du fichier.
  4. Mettre à jour la version en cours du fichier driver {CRGGID}/redaction-CRGGID/entites/contenu.ent: créer une nouvelle entité générale externe et lui donner le chemin système du nouveau fichier. Prenez note que le nom de l'entité ne comporte pas de mention de version. Le chemin système doit obligatoirement suivre la convention utilisée par les autres entités du fichier.
  5. Insérer le nouveau chapitre ou l'annexe dans le guide: faire l'appel de l'entité dans le fichier {CRGGID}/redaction-CRGGID/sources/cadre-reference-corps.xml Inscrire l'appel de l'entité dans le document XML parent approprié.

Prenez note que l'ajout, la modification, le retrait ou le déplacement d'une section à un chapitre existant n'affecte en rien la structure de fichiers ni la stratégie d'entités générales du fichier driver.

Modification d'un fragment du guide

Simplement ouvrir le fichier devant être modifié dans l'éditeur XMetal. Celui-ci devrait alors être reconnu par les macros prennant en charge les fragments du guide et le message « Fragment CRGGID activé » s'affichera dans la barre de statut de l'application.

Pour être reconnu en tant que fragment CRGGID, un fichier doit comporter les deux items suivants:

  1. L'instruction de traitement xm-well_formed de XMetal qui indique à l'application que le document doit être édité en mode well-formed. Ce mode d'édition lie l'instance XML à la DTD sans toutefois valider.

    <?xm-well_formed path="S:\redaction-CRGGID\DTD\crggid.dtd"?>

    Cette instruction de traitement permet d'associer l'instance XML à la DTD sans utiliser la déclaration du type de document DOCTYPE. Elle doit apparaître dans le prologue du document XML.

  2. L'instruction de traitement crggid qui identifie l'instance XML comme étant un fragment du guide et active les macros.

    <?crggid fragment="section"?>

    Le pseudo-attribut fragment n'est pas utilisé par les macros et est réservé pour un développement ultérieure. Il sert à identifier le nom de l'élément qui chapeaute le fragment (l'élément racine du fragment). Cette instruction de traitement doit obligatoirement être située après l'élément racine du fragment (à la fin du document).

Note: On a parfois observé un bogue lié au fait qu'un fichier constituant un fragment du guide était ouvert en même temps que l'application XMetal, c'est-à-dire lorsqu'on sélectionne à partir de l'explorateur Windows l'item Edit in XMetal du menu contextuel du fichier XML. Dans ce cas, il se peut que le fragment du guide ne soit pas reconnu par les macros. La solution consiste alors à fermer XMetal et à procéder en deux étapes, soit en premier lieu ouvrir l'application XMetal et ensuite ouvrir le fichier XML.

Étapes de création d'une section flottante

On peut rédiger une section du guide à l'extérieur du guide. Il s'agit alors d'une section flottante. De telles sections sont crées à l'aide du gabarit Section de XMetal, sous l'onglet CRGGID. Les sections flottantes sont placées dans le dossier {CRGGID}/redaction-CRGGID/sections-flottantes/. Lorsqu'une section flottante est jugée prète à être intégrée dans le guide, on procède par copier-coller du code source vers le chapitre approprié du guide. Le fichier de la section flottante est ensuite transféré dans le dossier {CRGGID}/redaction-CRGGID/sections-flottantes/sections-integrees/ pour éviter de mélanger des sections en élaboration de celles déjà intégrées au guide.

Versionnage des fichiers

Tous les fichiers du Guide suivent les conventions de versionnage utilisée au GRDS, à l'exception des fichiers du dossier {CRGGID}/redaction-CRGGID/DTD/. Le versionnage se fait a priori, c'est-à-dire que l'on crée d'abord une nouvelle version du fichier et on travaille sur celle-ci plutôt que sur l'ancienne.

Notez qu'il n'est pas prévu de versionnage pour les artefacts tels les images et autres objets que l'on veut intégrer au Guide.

Version des fichiers entités en cours de rédaction: Le fichier contenu.ent doit être versionné à chaque nouvelle publication de l'ébauche de l'hyperdocument.

Versions publiées: Les « versions publiées » de l'hyperdocument sont versionnées. Le schème servant à identifier chaque parution n'est pas la date courante, mais plutôt un numéro décimal séquentiel (0.1, 0.2, 0.3, etc.), l'objectif étant que la version finale de l'hyperdocument porte le numéro 1.0.


Structure de rédaction avec XMetal (DocBook)

Les points suivants sont des directives à suivre pour l'organisation de la structure de rédaction. En guise d'exemple, nous reproduisons, ci-dessous, la structure générale de l'ouvrage avec DocBook.

Book <book>
      Préface <preface>
  Partie <part>
      Chapitre <chapter>
        Section <section>
           En-tête: métadonnées <sectioninfo>
           Titre <title>
           Texte <para>
           Titre flottant <bridgehead>
              Sous-section <section>
                 En-Tête: métadonnées
                     Titre
                     Texte
                     Titre flottant
  Bibliographie <bibliography> 
  Glossaire <glossary>
  Annexes <appendix>
  Index<index>

Les attributs communs

L'identifiant id

Chaque identificateur inscrit dans le Guide doit absolument respecter les critères suivants:

Les identificateurs doivent être structurés et facilement compréhensibles. À cette fin, il importe de créer des regroupements selon les divers usages des identificateurs du document. Ces regroupements sont obtenus en utilisant un préfixe commun pour les identifiants de même usage. Par exemple, une référence bibliographique aura le préfixe ref:

ref_xpath-1.0

Pour voir la liste des préfixes utilisés pour regrouper les identificateurs uniques, reportez-vous à l'annexe.

Libellé

L'attribut xreflabel est utilisé par l'ensemble des éléments (portions de texte) qui pourront être lié à l'aide de liens hypertextes internes et qui devront avoir un libellé constant. La chaîne de caractères contenue dans cet attribut sera alors inscrite comme texte de l'hyperlien quand il s'agit d'un lien xref.

Cette façon de procéder réduit le temps de rédaction et assure l'uniformité des appels pour une même référence en plus de conserver en un endroit unique la chaîne de caractères facilitant ainsi sa modification.

Langue

La valeur inscrite dans l'attribut lang doit être un code alpha-2 de la norme des codes de langue ISO 639-1. Cet attribut de base sera modifié seulement pour les éléments de l'hyperdocument qui seront rédigées en une autre langue que le français. La langue par défaut est le français.

Section et sous-section

La section est l’unité de base de la rédaction. Elle est un texte autonome, autosuffisant et complet en lui-même. Elle doit comporter minimalement une introduction, un développement et une conclusion propre. Des graphiques, des figures et des tableaux peuvent y être inclus, ainsi que des citations, des procédures, des notes de bas de pages et des annotations. Elle peut contenir, au besoin, des sous-sections. Nous pouvons insérer des pointeurs vers d’autres sections ou des références et établir des liens Internet vers des pages Web ou des documents en lignes.

Utiliser l'élément section lors de la création d'une section. Cet élément est récursif donc peut s'inclure lui-même pour décrire les sous-sections.

Cet élément doit toujours avoir un identificateur explicite incluant le préfixe « sec ». Par exemple:

<section id="sec_notion-document">
   <title>La notion de document</title>
   <!-- Le reste de la section ici... -->
</section>

Les sous-sections

Il n'y a pas comme tel d'élément sous-section dans les éléments de DocBook que nous avons retenus (CRGGID). Pour réaliser une sous-section, il faut réitérer l'élément <section> à l'intérieur des éléments <section></section>. Dans ce cas-ci <section> doit être introduit en cours de rédaction à la suite du texte déjà écrit. Cet élément ne peut pas être inséré à l'intérieur d'un texte, par exemple, entre deux paragraphes. Sinon, XMetal ne validera pas.

Une particularité de DocBook fait en sorte qu'une section inscrite à l'intérieur d'une autre section ne peut pas être suivie par du texte. Ainsi la structure suivante n'est pas valide puisqu'un élément para a été placé à la suite d'un élément section.

<section>
  <title>Un titre de section</title>
  <para>Bla bla bla</para>
  <section>
    <title>Le titre de la sous-section</title>
    <para>Un peu plus de bla bla bla</para>
  </section>
  <para>Toujours un peu plus de bla bla bla</para>
</section>

La sous-section sera utilisée pour séparer une section en plusieurs parties, chaque division développant un sujet secondaire relativement autonome et important dans la structure. Si le sujet ne constitue pas un développement assez important, ou, s'il se rattache directement au texte précédent et continue à développer un de ses aspects, il est préférable d'utiliser le titre flottant bridgehead.

Le titre de section et les titres flottants

Contrairement à HTML, la section ne peut pas avoir plus d’un titre de premier niveau. Il n’y a pas non plus moyen de hiérarchiser dans la structure d’autres titres secondaires. A cet effet, nous utiliserons le titre flottant soit l’élément bridgehead.

L'en-tête <sectioninfo>

Nous évaluons présentement l'utilité des en-tête en lien avec le CRGGID. Il est donc présentement conseillé de limiter son utilisation.

L’en-tête doit apparaître au tout début d’une section. Ce bloc informatif doit apparaître avant le titre de la section. On doit utiliser les éléments suivant :

<section id="sec_environnement-legislatif-normatif">
   <sectioninfo>
      <abstract>
         <para>Ce module (inséré dans la partie introductive de la 
              méthodologie) met l'emphase sur les aspects juridiques
              qui sont reliés aux documents technologiques et dont 
              il faut tenir compte dès sa création,durant leur 
              traitement et tout au long de leur cycle de vie.</para>
      </abstract>
      <!-- etc. -->
   </sectioninfo>
   <title>Le titre de la section</title> 
   <!-- Le corps de la section débute ici... -->
</section>

N.B.: l'en-tête n'est pas requise pour les sous-sections.

Le résumé <abstract>

Le texte d’un résumé doit être court (15 lignes) et inclus dans l'élément abstract formant ainsi un bloc de texte indépendant du corps de la section. Il devrait comporter un titre propre.

Le corps du texte

Le seul élément que nous utiliserons pour encadrer du texte dans des paragraphes est para. Nous n’utiliserons pas la balise <formalpara>. Pour plus d’information consultez [DefGuide].

Le bloc <procedure>

Le bloc procedure peut être utilisé de préférence au début de la section pour introduire des procédures méthodologiques. Il contient les éléments suivants : title, step, para. Nous pouvons introduire au besoin l'élément : itemizedlistà l'intérieur de l'élément step.

Exemple:

<procedure>
   <title>Étapes préparatoires</title>
   <step>Débuter la préparation</step>
   <step>Bien se préparer</step>
   <step>Vérifier que l'on est bien préparé</step>
   <step>Terminer la préparation</step>
</procedure>

Les listes

Plusieurs éléments de Dockbook peuvent être utilisés pour introduire une liste: calloutlist, listitem, orderedlist, segmentedlist, simplelist, variablelist. Nous avons résolu d'utiliser itemizedlist de préférence à tout autre liste. Par contre pour une liste ordonnée (avec numérotation), employer ordoredlist. Si on ne veut pas d’une liste avec des puces, on peut utiliser simplelist.

L’élément variablelist peut être considéré uniquement quand il s’agit de donner un terme (ou un concept) et sa définition. L'équivalent HTML est l'élément dl.

Deux traitements stylistiques peuvent être appliqués à variablelist. Chaque item de liste peut être traité comme un bloc ou comme un item de liste (plus compact), tel qu'illustré dans les exemples qui suivent:

Stylage bloc:

Terme 1
     Description du terme 1
Terme 2
     Description du terme 2
Terme 3
     Description du terme 3

Stylage list:

Terme 1    Description du terme 1
Terme 2    Description du terme 2
Terme 3    Description du terme 3

Le traitement par défaut est celui bloc. On peut préciser à chaque élément variablelist le traitement alternatif en insérant les instructions de traitement associées à la sortie xsl:fo (<?dbfo?>) et html (<?dbhtml?>) sous l'élément vairablelist comme suit:

<variablelist>
		<?dbfo list-presentation="list"?>
		<?dbhtml list-presentation="table"?>
<varlistentry>
   <term>Terme 1</term>
			<listitem> 
				<para>Description du terme 1</para>
			</listitem>
		</varlistentry>
   <term>Terme 2</term>
			<listitem> 
				<para>Description du terme 2</para>
			</listitem>
		</varlistentry>
   <term>Terme 3</term>
			<listitem> 
				<para>Description du terme 3</para>
			</listitem>
		</varlistentry>

	</variablelist>

Les tableaux

Christian, peux-tu réviser cette section... et voir le mécanisme pour les tableaux(JFH)

### table et informaltable

Les tableaux créés dans l'hyperdocument doivent tous avoir un titre significatif succint.

Cet élément doit toujours avoir un identificateur explicite incluant le préfixe tab.

Les illustrations

Les illustrations insérées dans le Cadre de référence doivent toujours avoir un titre significatif. Pour ce faire utiliser exclusivement les figure ou mediaobject. L'élément graphic ne doit pas être utilisé car il sera écarté dans la cinquième version de DocBook.

Utiliser préférablement des formats provenant de normes ouvertes. Par exemple, le format d'images PNG plutôt que GIF, SVG au lieu de Flash pour les images vectorielles.

Toujours fournir un texte de remplacement.

Pour les types d'illustrations appropriés, fournir lorsque nécessaires des alternatives dans des formats plus simples ou plus normalisés. Par exemple, une image pourrait être décrite comme remplacement à une séquence vidéo pour le média papier. Le nom du fichier devra rester le même pour toutes les alternatives, les extensions permettront d'identifier les fichiers.

Les fichiers illustrations seront déposés dans le dossier "illustration" de la structure de dossiers dédiés à la rédaction.

Cet élément doit toujours avoir un identificateur explicite incluant le préfixe approprié.

Les exemples

literallayout

On utilisera les éléments literallayout (niveau bloc) et literal (niveau ligne)pour insérer des exemples de code verbatim.

L'attribut class sert à indiquer le type de police à employer. Les valeurs possibles sont: normal et monospace. On doit toujours employer la valeur monospace quand l'exemple verbatim contient du code XML ou provenant d'un langage de programmation.

Le contenu de l'élément literallayout conservera intégralement son apparance d'origine, y compris l'indentation produite par une succession d'espaces, de caractères de tabulation, etc. Les longues lignes ne sont pas tronqués, ce qui peut résulter en un masquage de fins de lignes trop longues pour être contenues dans un format d'affichage donné. Il est donc conseillé de vérifier le rendu visuel des verbatims pour les formats Web et PDF.

Une solution mise de l'avant pour provoquer un retour de ligne sur les longues lignes consiste à mettre dans l'attribut role="wrap". Une limitation de cette solution est qu'uniquement le contenu textuel de l'élément literallayout sera traité. Les éléments XML présents (par exemple des renvois co à une liste calloutlist, de l'emphase ou des hyperliens) seront ignorés. Il n'est pas nécessaire de mettre la valeur wrap dans l'attribut role lorsque le contenu de literallayout est constitué uniquement de texte (sans sous éléments) puisque l'application XSLT l'ajoute automatiquement lors du pré-processing (fichier copier.xsl).

Info-bulle

Cet élément doit toujours avoir un identificateur explicite incluant le préfixe approprié. (Voir aussi à la section Infobulles de l'addendum.)

Annotation

L’annotation qui est une fonction apparaissant dans la barre d’outil de Xmetal, est utilisé en cours de rédaction pour ajouter un commentaire ou note d'édition; mais elle servira surtout pour la révision du texte par une tierce personne.

Les attributs suivants sont spécifiques à cet élément:

AttributDescription
usernameNom d'usager de la personne qui crée l'annotation. Entré automatiquement par une macro avec le modèle de XMetal.
timeHorodatation de l'entrée. Ajouté automatiquement par la même macro.
initialsAu besoin, entrer les initiales de l'auteur de l'annotation. Utile pour le repérage dans la liste des annotations.
commentLe contenu de l'annotation.
<section>
  <title>Savez-vous planter des choux</title>
  <para><annotation comment="Compléter!" initials="CR" username="remillc"
  time="4 juillet, 2003 16:36:44">à la mode, à la mode...</annotation>
</para></section>

Les annotations sont des commentaires destinés à la communauté des auteurs du document. Elles ne feront pas partie du document publié.

Cet élément doit toujours avoir un identificateur explicite incluant le préfixe edit.

Liens internes et externes: <xref> et <ulink>

N.B.: ne pas mettre d'hyperlien dans les titres

Le rédacteur peut inclure différents types de liens dans le texte de l'hyperdocument:

Pour pointer vers une autre partie de l'ouvrage, utilisez l'élément et les attibuts suivants:

Pour des exemples et plus de détails, voir: "DocBook: the definive guide 2.0.8."

Pour établir un hyperlien vers un site Web, utilisez l'élément suivant: <ulink>

Exemple:

<para>
  For more information, see the O'Reilly catalog entry for
  <ulink url="http://www.ora.com/catalog/tex/"><citetitle>Making TeX
  Work</citetitle></ulink>.
</para>

Le titre de l'ouvrage cité, qui apparaîtra en bleu dans le texte souligné, devra être inscrit entre les balises <citetitle></cititle>

"The ULink element forms the equivalent of an HTML anchor (<a href="...">) for cross reference by a Uniform Resource Locator (URL)."

La personnalisation des liens <xref>

Donner des exemples simples de la personnalisation via l'attribut xrefstyle

<para>... consultez le 
   <xref xrefstyle="template:chapitre %n - %t" linkend="chap_amorce"/>.</para>

résultat HTML:

<p>Pour plus d'information, consultez le 
   <a title="Chapitre 5. Pourquoi une méthodologie ?"  
      href="#chap_amorce-sommaire">chapitre 5 - <i>Pourquoi une méthodologie ?</i>
   </a>.</p>

Résultat visible à l'impression:

Pour plus d'information, consultez le chapitre 5 - Pourquoi une méthodologie ? [37].

Longs URI/URL/URNs

Les URIs insérés dans le corps de texte causent souvent des problèmes d'affichage en raison de leur longueur excessive, en particulier lorsque le texte est justifié. La solution traditionnelle consiste à insérer des caractères blancs invisibles qui serviront de points de cassure pour le changement de ligne. Deux solutions sont possibles avec l'application XSLT développée pour le CRGGID:

  1. Attribut role

    Insérer l'URI dans l'élément phrase et inscrire dans son attribut role la valeur « uri » (en minuscule). L'application XSL se chargera d'insérer un caractère blanc invisible après chaque caractère « / » ou « : » contenu dans l'URI.

    Par exemple:

    <para>Bla bla bla 
       &lt;<phrase role="uri">http://www.exemple.com/foo/bar/toc/zouf/vlan</phrase>
         &gt; et on continue par là …
    </para>

    Donne au rendu PDF:

    Bla bla bla <http://www.exemple.com/foo/toc/
    zouf/vlanbar> et on continue par là …

    Cette solution ne fonctionne qu'avec le format de sortie PDF.

  2. Instruction de traitement sbr (soft break)

    Insérer l'instruction de traitement sbr dans une chaîne de caractère pour indiquer un endroit de cassure potentiel.

    Par exemple:

    <para>Bla bla bla http://www.exemple.com/foo/bar/toc/<?sbr?>zouf/vlan et on continue par là … </para>

    Donne au rendu PDF:

    Bla bla bla <http://www.exemple.com/foo/toc/
    zouf/vlanbar> et on continue par là …

Le double arobas @@

Afin de faciliter la redaction, nous suggérons d’utiliser la double arobas @@ en cours de texte lorsqu’il s’agit d’intégrer une référence. L’arobas sera accompagnée d’une annotation comme aide mémoire pour préciser la nature de la référence. Après la rédaction du texte, il sera plus facile ainsi de compléter en ajoutant des liens aux endroits marqués. Ce truc pourra aussi être utilisé pour les notes en bas de page.

Exemple Commentaire
@@ref Un lien interne pointant vers une référence bibliographique à venir.
@@secUn lien interne vers une section qui n'est pas encore écrite.

Par exemple:

<para>
   … il est possible d'appliquer le premier degré du
   <annotation
     username="hameljf" 
     initials="JFH"
     time="17 octobre 2003 16:40:15"
     comment="Peut-être faire une entrée et un lien au glossaire">
      @@ref principe de respect des fonds</annotation> 
   puisqu'il permet d'identifier …
</para>

Sinon, lors de l'insertion d'un appel d'une nouvelle référence bibliographique, vous devez prendre le temps d'insérer à l'endroit approprié les éléments bibliographiques nécessaires pour la création de la bibliographie.

Cet élément doit toujours avoir un identificateur explicite incluant le préfixe approprié.

Contrairement à l'exemple inclu dans la documentation, la balise citetitle possédant l'attribut pubwork, attitré à la saisie du type du document, doit être utilisée pour saisir le titre de la référence bibliographique à la place de la balise title. Référence : http://lists.oasis-open.org/archives/docbook/200202/msg00157.html

Bibliographie

La bibliographie est une partie autonome dans l'hyperdocument

Style bibliographique

Le style bibliographique à utiliser dans le Guide est en voie d’être défini (Voir note dans l'Addendum à la fin). Cependant, il devra supporter tant les documents papier qu'électroniques. La description physique et électronique complète doit fournir des éléments d'information permettant de retrouver le document sur une longue période (404 - l'URL ne suffit pas!!!).

Ainsi, lorsque la ressource est disponible en format papier et électronique, nous inscrirons la référence bibliographique pour le format papier et mettre un hyperlien sur le titre de la resource pour permettre l'accès au format électronique. Ceci assure l'accès à la ressource à long terme.

Voici quelques références électroniques pour écrire des références papier et électroniques:

ATTENTION: le modèle de bibliographie est toujours en élaboration. On devra statuer dans les prochaines semaines. Cette partie du protocole est donc à lire sous toutes réserves.

Exemples:

<biblioentry id="ref-Dherent-2002" xreflabel="Dhérent 2002">
  <citetitle pubwork="book">
    <ulink url="http://www.archivesdefrance.culture.gouv.fr">
      Les archives électroniques
    </ulink>
  </citetitle>
  <subtitle>Manuel pratique </subtitle>
  <author>
    <firstname>Catherine</firstname>
    <surname>Dhérent</surname>
  </author>
  <publisher>
    <publishername>Direction des Archives de France</publishername>
    <address>
      <city>Paris</city>
      <state/>
      <country/>
    </address>
  </publisher>
  <pubdate>2002</pubdate>
  <pagenums>104</pagenums>
  <isbn>2-911601-35-5</isbn>
</biblioentry>

<biblioentry id="ref-CRDP-2001" xreflabel="Centre recherche droit public 2001">
  <citetitle pubwork="book">
    <ulink url="http://www.autoroute.gouv.qc.ca/loi_en_ligne/index.html">
      Loi concernant le cadre juridique des technologies de l'information 
      (L.Q. 2001, c. 32)</ulink>
  </citetitle>
  <subtitle>texte annoté et glossaire</subtitle>
  <corpauthor>Centre de recherche en droit public. Faculté de droit. 
    Université de Montréal</corpauthor>
  <pubdate>2001</pubdate>
  <publisher>
    <publishername>Centre de recherche en droit public</publishername>
    <address>
      <city>Montréal</city>
    </address>
  </publisher>
</biblioentry>
<biblioentry id="ref-EBSI-2002" xreflabel="EBSI 2002">
  <citetitle pubwork="part">Terminologie de base en sciences de l'information : 
    volets 1 et 2</citetitle>
  <citetitle pubwork="part" role="siteWebOrganisme">Université de Montréal</citetitle>
  <citetitle pubwork="part" role="siteWebAuteur">École de bibliothéconomie et 
  sciences de l'information</citetitle>
  <corpauthor>École de bibliothéconomie et sciences de l'information</corpauthor>
  <bibliosource class="uri">
    <ulink url="http://www.ebsi.umontreal.ca/termino/index.htm">
      <phrase>(Consulté le 10 février 2003)</phrase>
    </ulink>
  </bibliosource>
  <pubdate>2002</pubdate>
</biblioentry>
<biblioentry id="ref-Rousseau-Couture-1999" xreflabel="Rousseau, Couture 1999">
  <citetitle pubwork="book">Les fondements de la discipline archivistique</citetitle>
  <citetitle pubwork="part">Glossaire</citetitle>
  <author>
    <firstname>Marlène</firstname>
    <surname>Gagnon</surname>
  </author>
  <authorgroup>
    <author>
      <firstname>Jean-Yves</firstname>
      <surname>Rousseau</surname>
    </author>
    <author>
      <firstname>Carol</firstname>
      <surname>Couture</surname>
    </author>
    <collab>
      <collabname>Florence Arès, Chantale Filion, Marlène Gagnon,
        Louise Gagnon-Arguin et Dominique Maurel</collabname>
    </collab>
  </authorgroup>
  <publisher>
    <publishername>. Presse de l'Université du Québec</publishername>
    <address>
      <city>Ste-Foy</city>
      <state>Québec</state>
    </address>
  </publisher>
  <pubdate>1999</pubdate>
  <pagenums>279-294</pagenums>
  <isbn>2-7605-0781-5</isbn>
</biblioentry>

Pour le moment, le ponctuation n'apparait pas dans l'exemple ci-dessus. Elle sera généré lors du choix du stylage.

Références bibliographiques

Ce qui suit est une suite d'exemple de gabarits contenant les éléments retenues dans DocBook pour une bibliographie.

L'appel à la référence bibliographique pourrait avoir le format suivant :Chaîne de caractères descriptive-espace-année à quatre chiffres. Ceci permettrait de modifier l'appel de références selon le style bibliographique choisi à l'aide d'une expression régulière.

Question envoyée pour la gestion des références uniquement sur support électronique.7 janvier 2003. Une personne de la liste de discussion m'a fait parvenir la façon dont il traitait les références électroniques avec le code xsl:fo permettant de styler ces références.

N.B.: L'élément <biblioentry> doit toujours avoir un identificateur explicite incluant le préfixe approprié.

Exemple :<biblioentry id="ref-" xreflabel="">

La majorité des éléments permettant de baliser les références bibliographiques peuvent contenir l'élément servant à créer les hyperliens <ulink>.

Des gabarits pour la saisie des éléments d'une référence bibliographique se retrouve dans au début du fichier bibliographie.xml et ci-dessous.

Christian pourrais-tu vérifier les points ci-dessous.

Les citations de contenu:<quote> et <blockquote>

Pour citer un passage d'un autre ouvrage, on utilisera <blockquote> lorsqu'il s'agit de citer un passage de niveau bloc, ou <quote> pour les citations de niveau ligne.

Les citations doivent être saisies sans les guillemets délimiteurs. Ceux-ci seront générés automatiquement par l'application XSL de DocBook, en tenant compte des particularités propres à la langue utilisée.

Par exemple:

<blockquote>
   <attribution>Richard Dawkins</attribution>
   <para>
      The universe that we observe has precisely the properties we should 
      expect if there is, at bottom, no design, no purpose, no evil and
      no good, nothing but pitiless indifference.
   </para>
</blockquote>

The universe that we observe has precisely the properties we should expect if there is, at bottom, no design, no purpose, no evil and no good, nothing but pitiless indifference.

--Richard Dawkins

L'élément <blockquote> doit posséder impérativement l'élément <para> et peut contenir, comme dans le cas ci-dessus, l'élément <attribution>.

La citation de niveau ligne:

<para>This software is provided <quote> as is </quote>, without expressed or implied warranty.</para>

This software is provided "as is", without expressed or implied warranty.

Autres éléments constituant des blocs dans le corps du texte

Dans DocBook, plusieurs éléments permettent de constituer des blocs d'information à part du texte.

Éléments pour signaler un danger

Éléments pour porter attention

Exemple de <footnote>

<para>
An annual percentage rate (<abbrev>APR</abbrev>) of 13.9%<footnote>
<para>
The prime rate, as published in the <citetitle>Wall Street
Journal</citetitle> on the first business day of the month,
plus 7.0%.
</para>
</footnote>
will be charged on all balances carried forward.
</para>
An annual percentage rate (APR) of 13.9%[1] will be charged on all 
balances carried forward. 

For additional examples, see also footnoteref. 



-------------------------------------------------------------------------
-------

[1] The prime rate, as published in the Wall Street Journal on the first 
business day of the month, plus 7.0%. 



Autres éléments

  • <remark> : Commentaire d'édition dans un brouillon.
  • <epitaph> : Un texte court au début d'un document. Exergue : pensée, poème, devise
  • <callout> : Annotation d'une image graphique dans l'élément <calloutlist>

Voir aussi la liste des éléments bloc

Glossaire

Le glossaire contiendra le vocabulaire défini et utilisé dans la méthodologie. Il sert à clarifier les termes et les concepts que nous retiendrons de sorte que le lecteur puisse y référer au besoin. Comme la bibliographie, il forme une partie autonome qui sera en annexe de notre travail.

L'élément <glossentry>doit toujours avoir un identificateur explicite incluant le préfixe approprié.

 Exemple : <glossentry id="gloss-document">

Le glossaire est divisé selon les lettres de l'alphabet à l'aide de l'élément glossdiv. Le tri se fait correctement par ordre alphabétique à l'intérieur des divisions.

Les éléments de la bibliographie ne sont présentement pas triés par la feuille de style de Norm Walsh.

Voici un exemple d'une entrée fictive dans le glossaire contenant deux définitions provenant de sources différentes, une remarque et un Voir aussi. Plusieurs autres éléments sont également disponibles pour ajouter d'autres informations selon nos besoins.

<glossentry id="gloss-extreme-markup-language">
<glossterm>eXtreme Markup Language</glossterm>
 <acronym>XML</acronym>
  <glossdef>
   <blockquote>
    <attribution>
     <citation><xref linkend="ref-XML"/></citation>
    </attribution>
    <para>Voici la transcription de la définition du terme 
          trouvé dans la source d'information mentionnée dans 
          l'appel à la référence bibliographique inscrite dans 
          la balise "citation".</para>
   </blockquote>
  </glossdef>
  <glossdef>
   <blockquote>
    <attribution>
     <citation><xref linkend="ref-autre-2001"/></citation>
    </attribution>
    <para>Voici la transcription de la définition du terme 
          trouvé dans la source d'information mentionnée dans 
          l'appel à la référence bibliographique inscrite dans 
          la balise "citation".</para>
   </blockquote>
   <remark>
     Voici une remarque intéressante sur cette définition.
   </remark>
   <glossseealso otherterm="gloss-SGML"/>
  </glossdef>
</glossentry>

N.B.: Pour plus d'exemples et pour voir les gabarits de saisie du 
glossaire, voir le glossaire actuel en code source et la partie 
explicative en début de document.

Les Voir et Voir aussi sont saisis à l'intérieur des balises <glosssee otherterm="id"/> et <glossseealso otherterm="id"/>. Les hyperliens incluant le texte seront ajoutés par la feuille de style appropriée. La langue d'inscription des renvois utilisés est celle de l'attribut langue de la balise de plus bas niveau si celle-ci n'est pas indiquée, la feuille de style remonte jusqu'à l'élément de plus haut niveaubook. L'attribut langue fait partie des attributs de bases. On peut donc modifier la langue au niveau de chaque élément contenu dans la DTD DocBook.

Afin d'avoir des appels de référence reliés aux références bibliographiques il s'agit d'utiliser la syntaxe suivante : <attribution><citation><xref linkend="ref-iso-15489-1-2001"/></citation></attribution>. L'intitulé de l'hyperlien sera celui de l'attribut xreflabel ou celui de la balise abbr de la référence bibliographique si celui n'est pas présent, par contre il y a alors deux paires de parenthèses.Vérifier si le format de l'appel de la référence est bien celui désiré.

Afin de faciliter la saisie des gabarits contenant les balises les plus souvent utilisées, vous pouvez vous référer au début du fichier "glossaire.xml" ou aux gabarits apparaissants ci dessous..

Gabarit glossaire

1) gabarit pour ajouter des division au glossaire


	<glossdiv>
		<title></title>	
	</glossdiv>
			
			
	NOTE: les entrées du glossaire vont être insérées entre les balises 
</title> et </glossdiv>.


2)gabarit de saisie des termes du glossaire contenu dans une source 
d'information avec appel de référence

	<glossentry id="gloss-">
		<glossterm></glossterm>
		<acronym></acronym>
		<glossdef lang="">
			<blockquote>
				<attribution>
					<citation><xref linkend="ref-"/></citation>
				</attribution>
				<para></para>
			</blockquote>
			<remark></remark>
			<glossseealso otherterm="gloss-"></glossseealso>
		</glossdef>
	</glossentry>
					
3)Gabarit pour la saisie d'une définition du GRDS

	<glossentry id="gloss-">
		<glossterm></glossterm>
		<acronym></acronym>
		<glossdef>
			<para></para>
			<remark></remark>
			<glossseealso otherterm="gloss-"></glossseealso>
		</glossdef>
	</glossentry>

4) À la suite d'un couple de balises "paragraphe", ou à l'intérieur de 
celles-ci on peut ajouter les balises permettant de délimiter un exemple.

	<informalexample>
		<para></para>
	</informalexample>

5) Pour inscrire les termes anglais correspondant aux entrées du glossaire 
française, insérer à l'intérieur du couple de balises "glossterm", à la 
suite de la chaîne de caractères représentant le terme, les balises 
suivantes :

 <foreignphrase lang="en">
 </foreignphrase>
 
 Exemple: 

<glossterm>document numérique 
	<foreignphrase lang="en">electronic document</foreignphrase>
</glossterm>

NOTE: si dans le texte on parle de la terminologie anglaise celle-ci 
pourra également être insérée entre les balises "foreignphrase".


6) Des liens hypertextes peuvent être saisis à l'intérieure des balises 
<para></para><ulink url="http:\\www.google.com">Google</ulink> 

	<ulink url=""></ulink>

7) Gabarit pour les éléments du glossaire avec "voir" seulement

	<glossentry id="gloss-">
		<glossterm></glossterm>
		<glosssee otherterm="gloss-"></glosssee>
	</glossentry>

Étant donné que le développement du glossaire et de la bibliographie consiste principalement à l'ajout d'information, on ne devrait pas avoir besoin de versionnage.

Si plusieurs utilisateurs travaillent sur les mêmes fichiers, un dossier bidon avec le nom de la personne et la date du retrait pourrait être créé.

NOTE : L'identification des termes du glossaire qui seront utilisés dans le glossaire du projet PIAF se fera au niveau des élément "glossentry" avec l'attribut "role". La sémantique de la chaîne de caractères contenu dans cet attribut sera "identifiant du projet-section à laquelle la définition s'applique" exemple: role="PIAF-1".

L'index

Les entrées d'index <indexterm>

Chaque entrée d'index est représentée par l'élément indexterm. En voici la structure:*

indexterm ::=
(primary?,
 ((secondary,
   ((tertiary,
     (see|seealso+)?)|
    see|seealso+)?)|
  see|seealso+)?)

* Tiré de: [DefGuide]

L’index sera créé à la toute fin. Les entrées d'index seront inscrite dans le corps du document, c'est-à-dire en contexte.

Décrire la façon dont les exemples seront inscrits dans le texte format ligne ou bloc.

Comment rédiger un texte technique

Généralités

Ce qui suit est un rappel des principes de base qui sous-tendent un "bon texte". Il doit d'abord répondre aux quatre conditions de base suivantes:

  1. couvrir le sujet et répondre complètement à la question posée;
  2. présenter un contenu technique de qualité;
  3. avoir fait l’objet d’une rédaction soignée;
  4. être présenté d’une manière claire et agréable.

Nous ajouterons qu'un "bon texte" doit s'adresser à ses lecteurs et correspondre à leurs intérêts, leurs connaissances et leur niveau de lecture.

Ainsi, un "bon texte" est:

  • structuré,
  • argumenté,
  • clair,
  • précis,
  • illustré,
  • cohérent sur le fond,
  • cohérent sur la forme,
  • exempt de faute d'orthographe,
  • bien présenté.

Le style rédactionnel

Le style rédactionnel qui convient à un ouvrage technique est un style informatif dénué de tout attribut littéraire. Cependant, pour rendre plus vivant le texte et faciliter sa lecture, quelques astuces journalistiques sont utiles :

  • formuler des titres significatifs avec des mots clefs;
  • créer des chapeaux ou "lead", soit un court texte "punché", qui résume, en tête de texte, l'essentiel de la nouvelle qui sera par la suite développée;
  • soigner l'aspect visuel de la présentation en limitant, par exemple, la longueur des paragraphes, en insérant des listes, des graphiques, de tableaux, et en utilisant des titres flottants qui viendront découper le texte et l'alléger.

Le titre sera gai mais sans familiarité:

  • éviter les formules imagées ou à la mode, alambiquées ou poétiques: "C'est la goutte qui fait déborder le vase";
  • éviter le style télégraphique source de confusion;
  • faire de vraies phrase4s: sujet, verbe, complément...

Le temps de narration

La norme est d’utiliser un seul temps de narration : le présent de l’indicatif ou le passé composé. L’indicatif présent sert à décrire les actions en cours et les remarques intemporelles. Le passé composé sert uniquement à relater les actions passées. Les temps secondaires sont le futur simple et le conditionnel présent. En toute circonstance, il faut respecter la concordance des temps.

Cependant, l'imparfait (sauf avec le conditionnel) et le passé simple sont à proscrire.

Le mode de narration

Dans le mode de narration, nous pouvons alterner entre le style direct (à privilégier) et le style indirect afin de rompre la monotonie. Dans un ouvrage technique où l’auteur et, a fortiori, le rédacteur doit s’effacer devant son sujet, le «  NOUS  » collectif est obligatoirement de mise. Quant à l’emploi du « ON », il est habituellement réservé au français parlé.

Dans un ouvrage technique où l’auteur et, a fortiori, le rédacteur doit s’effacer devant son sujet, le « NOUS  » collectif est obligatoirement de mise. Quant à l’emploi du « ON », il est habituellement réservé au français parlé.

Le respect du français

Le CRGGID est un projet gouvernemental et à ce chapitre, nous devons nous conformer à la politique gouvernementale concernant l’utilisation du français dans l’administration publique.

En bref, voici quelqes lignes directrices:

Comme il y aura plusieurs termes anglais utilisés en informatique, nous metterons ces mots en italiques

Avant d'utiliser les mots étrangers, même entre guillement, il faut vérifier l'équivalent français (voir: OQLF) car il peut y avoir confusion.

Comment rédiger un texte clair, précis et concis

Afin d’obtenir un texte clair, précis et concis il est recommandé d’établir d’abord un plan et de soigner la construction des divisions et des phrases elles-mêmes, ainsi que le choix des mots.

Le plan

Ériger un plan ou non dépend de la façon de travailler du rédacteur et cette règle qui facilite pourtant la clarté de l’exposé ne peut-être imposée.

Les subdivisions

En théorie et en pratique, un ouvrage peut se diviser de la façon suivante:

En partie
En chapitre<60 pages (avec titre)
En section<10 pages (avec titre)
En sous-section<3 pages (avec titre "accrocheur")
En paragraphe<1 page
En sous-paragraphe<15 lignes

Dans son travail de rédaction, le rédacteur travaillera principalement aux niveaux des section et des sous-sections avec "DocBook". Voici quelque lignes directrices pour la construction des subdivisions.

Le titre

Accrocheur ou non, un titre doit refléter une seule idée: celle du sujet qui sera développé. Un titre accrocheur pourra ètre celui qui utilise une forme interrogative. Il ne s'agit pas ici de rentrer dans une forme fantaisiste.

La première phrase

La première phrase qui suit le titre doit rappeler le thème énoncé dans le titre et, si possible, annoncer ce qui suit.

La phrase "chapeau" ou "lead"

La phrase «chapeau» (l'attaque) ou "lead" en anglais journalistique apparaît en début de section ou sous-section. Elle est une sorte de résumé introductif qui répond à ces questions: d'où, où et comment se développe le sujet.

La phrase de clôture

La phrase de clôture se retrouve à la fin d’une section ou sous-section un peu à la manière d’une conclusion. Elle sert habituellement à clore le sujet développé auparavant et à introduire ce qui vient.

Une idée, un paragraphe

Il est important de développer une idée dans un seul paragraphe et de faire un alinéa lorsqu’une nouvelle idée se présente. Ceci, afin d’éviter la confusion et permettre une lecture facile.

De plus, l’argumentation se déroule de manière logique et linéaire de sorte qu’une prémisse se déduise de la précédente jusqu’à la conclusion.

Autres considérations

En règle générale, il ne faut jamais commencer un paragraphe par un pronom sauf le «Nous» collectif ou dans le cas du style indirect.

Construction des phrases

Nous faisons ici un rappel sur la construction des phrases dans une rédaction technique. Une phrase dasn un style informatif est d'abord une phrase courte de moins de 35 mots et d'au plus trois propositions. Il ne doit pas y avoir surenchère d'épithètes et d'adverbes.

Les caractéristiques suivantes doivent se retrouver:

Comment rédiger un texte précis
Améliorer la concision

Conventions d'écriture

Voici quelques conventions d’écriture que nous adopterons. Le tableau ci-dessous montre un rappel des conventions typographiques pour les textes français. Notons que les espaces insécables devront être signalées manuellement par le rédacteur à l’aide de l'entité &ampnbsp; introduite avant le Signe approprié.

AppellationAvant le signeSigneAprès le signe
Point finalPas d'espace.Espace
VirguelPas d'espace,Espace
Trait d'unionPas d'espace-Pas d'espace
Point de suspensionPas d'espaceEspace
Point virguleEspace insécable;Espace
Point d'interrogationEspace insécable?Espace
Point d'exclamationEspace insécable!Espace
Deux pointsEspace insécable:Espace
Petit tiretEspace-Espace
Grand tiretEspaceEspace
Barre obliquePas d'espace/Pas d'espace
Pour cent (*)Espace%Espace
Parenthèse ouvranteEspace(Pas d'espace
Parenthèse fermantePas d'espace)Espace
Crochet ouvrantEspace[Pas d'espace
Crochet fermantPas d'espace]Espace
Guillemet français ouvrant (**)Espace«Espace insécable
Guillemet français fermant (**)Espace insécable»Espace
Guillemet anglais ouvrant + phraseEspace"Pas d'espace
Guillemet anglais fermant + phrasePas d'espace"Espace

* Le symbole % est traité en français comme une abréviation et donc suit les mêmes règles qu'un mot isolé.

** Cette convention, peut varier d'une éditeur à l'autre.

N.B.: Le point-virgule (;) sert à séparer des propositions indépendantes, qui, le plus souvent, ne possèdent pas de lien logique entre elles. Son utilisation est donc déconseillée dans des textes techniques (sauf pour les énumérations). Mieux vaut faire des phrases courtes.


Définitions

Bibliographie

Une bibliographie est une section d'un document contenant une liste de références biblipgraphiques.

Référence bibliographique

Une référence bibliographique est une notice identifiant un document donnant auteur, titre et source, c'est-à-dire toutes les précisions nécessaires pour se procurer le document. [GDT]

Appel de référence bibliographique

Pointeur situé dans le corps du texte lié à une référence bibliographique.


Sources consultées

DefGuide
Norman Walsh, Leonard Muellner. DocBook: The Definitive Guide (Page consultée le 24 octobre 2003). http://www.docbook.org/tdg/en/

Annexe

Liste des préfixes

Voici la liste des préfixes utilisés pour regrouper les identificateurs uniques. Le préfixe est séparé du nom de l'identificateur par un trait de soulignement "_". Les préfixes doivent être courts mais explicites. Sauf mention contraire les éléments listés ci-dessous doivent avoir un identificateur générique d'inscrit au moment de leur création.S.V.P. Veuillez tenir cette liste à jour ainsi qu'inscrire la date de dernière modification.

Date de dernière modification : 17 octobre 2003.

annex
annexes
chap
chapitres
chap-intro
introduction de chapitre (partintro)
code
exemples de balisage
edit
note d'édition
ex
exemples dans le corps du texte
gloss
pour les termes du glossaire
ill
illustrations
illt
titres servant à créer la liste des illustrations
ind
entrées de l'index
infbul
info-bulles
nbp
note de bas de page
part
parties
ref
références bibliographiques
sec
sections
tab
tableaux
tabt
titres servant à créer la liste des tableaux
tf
titres flottants (bridgehead)
tdm
titres qui vont servir à créer la table des matières

Gabarits pour la bibliographie

NOTE: Lorsque la ressource est disponible en format papier et imprimé 
inscrire la référence bibliographique pour le format papier et mettre un 
hyperlien sur le titre de la resource pour permettre l'accès au format 
électronique. Ceci assure l'accès à la ressource à long terme.

1) Gabarit pour l'ajout de division dans la bibliographie:

	<bibliodiv>
		<title></title>

	</bibliodiv>

2) Gabarit pour la saisie des entrées bibliographiques

Le format de saisie pour l'attribut  "xreflabel", qui servira d'appel 
bibliographique, est auteur-espace-date si deux documents d'un même 
auteur ont la même date faire suivre d'une lettre minuscule. 
	exemple: Girard 2002a et Girard 2002b  
	exemple de code:  
<biblioentry id="ref-iso-15489-1-2001" xreflabel="ISO 15489-1 2001">

	<biblioentry id="ref-" xreflabel="">
			<authorgroup>
				<author>
					<firstname></firstname>
					<surname></surname>
				</author>
				<author>
					<firstname></firstname>
					<surname></surname>
				</author>
				<collab>
					<collabname></collabname>
				</collab>
				<corpauthor></corpauthor>
				<othercredit>
					<firstname></firstname>
					<surname></surname>
					<contrib></contrib>
				</othercredit>
			</authorgroup>
			</authorgroup>
			<citetitle pubwork=""></citetitle>
			<copyright>
				<year></year>
				<holder></holder>
			</copyright>
			<edition></edition>
			<isbn></isbn>
			<publisher>
				<publishername></publishername>
				<address>
				<city></city>
				<state></state><country></country>
				</address>
			</publisher>
			<pubdate></pubdate>
			<subtitle></subtitle>
			<pagenums></pagenums>
	</biblioentry>
		
		NOTE : éliminer les balises non utilisées.
		
		Voici les balises pertinentes pour les articles, les insérer sous 
l'élément "biblioentry": 
		
		<volumenum></volumenum>
		<issuenum></issuenum>
		<issn></issn>

 3) Gabarit pour insérer des hyperliens dans les éléments de la 
référence bibliographique 
     gabarit : <ulink url=""></ulink> 
     exemple :
<citetitle><ulink url="http:\\www.google.com">Google</ulink>
</citetitle>
		
 4)gabarit pour saisir les ressources électroniques, cette partie 
est insérée sous l'élément "biblioentry"
   <bibliosource class="uri">
      <ulink url="">http://www.acme.com/exemple</ulink>
      <phrase>(Consulté le  2003)</phrase>
	</bibliosource>

exemple:
	<bibliosource class="uri">
		<ulink url="http://www.columbia.edu/cu/cup/cgos/idx_basic.html">
http://www.columbia.edu/cu/cup/cgos/idx_basic.html 
		<phrase>(Consulté le 11 janvier 2002)</phrase>
		<medialabel>[en ligne]</medialabel></ulink>
	</bibliosource>
    
    Exemple fictif, comportant plusieurs balises :
    <biblioentry id="ref-ISO-15489-2001" xreflabel="ISO 15489-1 2001">
			<authorgroup>
				<author>
					<firstname>Andrea</firstname>
					<surname>Bahadur</surname>
				</author>
				<author>
					<firstname>Mark</firstname>
					<surname>Shwarek</surname>
				</author>
				<collab>
					<collabname>Diane Girard</collabname>
				</collab>
				<corpauthor>Université de Montréal</corpauthor>
				<othercredit>
					<firstname>Mark</firstname>
					<surname>Shwarek</surname>
					<contrib>dessin</contrib>
				</othercredit>
			</authorgroup>
			<copyright>
				<year>1974</year>
				<year>1975</year>
				<holder>Product Development International Holding N. V.</holder>
			</copyright>
			<isbn>0-88459-021-6</isbn>
			<publisher>
				<publishername>Plenary Publications International,Inc.</publishername>
			</publisher>
			<pubdate>2001</pubdate>
			<citetitle pubwork="book">Kites</citetitle>
			<subtitle>Ancient Craft to Modern Sport</subtitle>
			<pagenums>988-999</pagenums>
			<bibliosource class="uri">
				<ulink url="http://www.columbia.edu/cu/cup/cgos/idx_basic.html">
       http://www.columbia.edu/cu/cup/cgos/idx_basic.html <phrase>
(Consulté le 11 janvier 2002)</phrase> <medialabel>[en ligne]
</medialabel>
					</ulink>
			</bibliosource>
		</biblioentry>

Liste des éléments de niveau bloc

  • <sectioninfo>
  • <bibliosource>
  • <abstract>
  • <para>
  • <formalpar>
  • <blocquote>
  • <tip>
  • <caution>
  • <warning>
  • <important>
  • <highlights>
  • <note>
  • <epigraph>
  • <annotation>
  • <remark>
  • <citation>
  • <callout>

Voir aussi la section Citations et ce qui suit, ou consultez [DefGuide].

Addenda

Dans cette section du protocole de rédaction, chacun pourra ajouter des points nouveaux à inclure dans le protocole de rédaction.

Utilisation des caractères gras

Pour mettre en caractères gras du texte, il suffit d'utiliser l'élément <emphasis> et de lui ajouter la valeur bold dans l'attribut role: role= "bold". Par défaut, l'élément <emphasis> met le texte en italic. Il n'y a pas de "souligné", celui-ci étant réservé aux hyperliens.

À propos des hyperliens

Les hyperliens sont toujours mis entre chevrons < > par convention: <http://fr.yahoo.com/>

Bonnes pratiques pour la modification des feuilles de styles de DocBook

Utiliser la feuille de style "CRGGID.xsl" pour ajouter ou modifier les templates afin d'obtenir la présentation adéquate.

Attention lors de la redéfinition d'un template pour un élément s'il est représenté dans la feuille de style initiale par plus d'un élément ayant des niveaux de priorités différents.

Plusieurs éléments dans le fichier html résultant de la transformation XSL possède des classes, une partie importante de la présentation peut donc être décrite dans le fichier "CRGGID.css".

Choix Bibliographique

Lors de la réunion du jeudi 22 janvier, nous avons statué sur les points suivants:

  • Le modèle adopté est celui de l'EBSI que l'on retrouvera dans le guide de l'étudiant 2003-2004.
  • Chacun fera lui-même les entrées bibliographique reliées à sa partie en utilisant l'élément <biblioMixed> qui permet de rédiger en texte libre.
  • Ne pas oublier d'inscrire l'identifiant ID et le xreflabel qui sera court et significatif. Ceci pour permettre d'établir les références internes dans le texte.
  • Pour différer la référence à une citation bibliographique en cours de rédaction, utilisez le double @@ accompagné d'une annotation.

Niveaux de lecture

Lors de la réunion du 22 janvier p.m., nous avons défini quatre niveaux de lecture pour quatre lecteurs types:

Infobulles

Les infobulles seront générées à la fin et comprendront:

  • Textes descriptifs des métadonnées placées en annexe.

    Chaque métadonnée, enrichissement et schème d'encodage est présentée sous la forme d'un tableau. Chaque attribut table/@role contient un code permettant l'indexation des infobulles selon la convention suivante:

    • Pour un tableau décrivant une métadonnée: role = infbul_meta
    • Pour un tableau décrivant un enrichissement: role = infbul_enr
    • Pour un tableau décrivant un schème d'encodage: role = infbul_sch
  • Les définitions du glossaire
  • Les paires anglais/français des termes du glossaire
  • Les recommandations
  • La bibliographie

Le glossaire

Suite à la réunion du 22 janvier, le glossaire comprendra:

  • toutes les définitions existantes
  • nos propres définitions issues du texte même que l'on devra marquer d'un identifiant pour pouvoir les retracer et les inclure à la fin dans le glossaire.
  • L'attribut role = ret (pour: retenue) appliqué à un élément glossdef marquera les définitions qui seront retenues et affichées à la fin
  • La sélection des définitions qui apparaîtront se fera à la fin selon la terminologie utilisée dans le document, en conformité avec les lois et les normes reconnues et selon les nouveaux paradigmes avancés

2003-10-24 - Jean-François Hamel, Diane Girard et Christian Rémillard - <GRDS>