3. Un peu de vocabulaire

Résumé

Nous allons expliquer tous les termes utilisés dans la documentation de Borges: projet, auteur, initiales d'auteur, document, sous-document, module, état d'un module, atome, révision d'un atome, etc.

Note

Ces termes ne sont pas présentés dans un ordre particulier.

auteur

Un auteur peut être le rédacteur, le traducteur ou le relecteur d'un module. Généralement, le concept d'«auteur» est lié au créateur (dans ce cas précis, le rédacteur) de quelque chose, mais Borges considère les traducteurs et les relecteurs comme des auteurs.

Voir aussi initiales d'auteur, module.

initiales d'auteur

Borges identifie les différents auteurs qui participent à un projet par leurs initiales. Cela restreint les auteurs à l'usage d'initiales uniques.

Si votre projet comprend un petit groupe d'auteurs, des initiales de deux lettres seront suffisantes. Cependant, plus de lettres peuvent être utilisées si les initiales sont uniques.

Voir aussi auteur, projet.

projet

Un projet est un document ou un ensemble de documents que vous gérez avec Borges. En général, un projet comporte une série de documents.

Voir aussi document.

super-document

Ce terme désigne un ensemble de modules, structuré de façon à former un livre, un article, un guide d'utilisation, soit tout bloc d'information exhaustive concernant un sujet particulier.

Le super-document est le document «maître» à partir duquel différents documents peuvent être générés. La structure du super-document est définie dans le fichier master.top.xml.

Un super-document peut contenir mutuellement des informations exclusives qui seront triées en divers documents spécialisés.

Voir aussi document.

document

Un document est une compilation d'un super-document avec pour résultat un fichier PDF ou (X)HTML. Vous pouvez choisir de compiler la totalité du super-document ou seulement quelques éléments de ce dernier. Les documents peuvent être des livres entiers, des articles, des pages de référence, des lettres, des manuels, etc.

Voir aussi compilation, super-document.

compilation

La compilation est le procédé par lequel une série de fichiers source écrits en XML sont «transformés» en document PDF ou (X)HTML.

module

Les modules sont les parties qui composent un document. Habituellement, un super-document est divisé en petits éléments appelés modules afin de simplifier la rédaction, la traduction, la gestion et la réutilisation du contenu. Les chapitres, sections, annexes et glossaires sont de bons candidats pour devenir des modules.

En fait, Borges requiert que tout élément structuré soit placé dans un module pour pouvoir être traduit, et afin de tirer partie des caractéristiques du système de gestion des révisions.

Les modules peuvent être marqués, à l'aide de l'attribut condition=, afin d'être exclus lors de certaines compilations. Cela vous permettra de créer plusieurs types de document à partir d'un ensemble unique de modules, tout en les améliorant grâce aux fonctions de réutilisation des contenus de Borges.

Voir aussi document, super-document, projet.

module d'origine

Ceci est utilisé pour préciser quel module a été écrit par un rédacteur. Les traducteurs utiliseront le module d'origine comme référence pour toutes les traductions.

Voir aussi module, module traduit.

module traduit

Cette expression désigne un module qui n'est pas celui d'origine, mais une traduction du module d'origine.

Voir aussi module, module d'origine.

état d'avancement d'un module

Les modules passent par différentes étapes durant leur cycle de vie. Chaque «étape» détermine l'état d'avancement du module.

Afin de passer d'une étape à une autre, quelques opérations doivent être exécutées sur le module, par exemple : la rédaction, la traduction, la correction orthographique, la relecture, etc.

Voir aussi cycle de vie.

atome

Les atomes sont les éléments XML servant aux modifications de contrôle au sein d'un module. Ce sont les plus petits éléments contenant du texte. Les atomes typiques en DocBook sont <title> et <para>.

Voir aussi révision d'atome.

révision d'atome

Les atomes possèdent un numéro de révision lequel est utilisé par le système de gestion de révision de Borges dans le but de retracer les changements faits dans les modules sur une «échelle atomique».

Voir aussi atome.

cycle de vie

Le cycle de vie d'un module est fait de diverses étapes (ou états) au travers desquelles le module doit passer pour être considéré comme prêt à être diffusé. Actuellement, Borges fonctionne selon un seul cycle de vie fixe, lequel est détaillé dans ???.

Voir aussi module, état d'avancement d'un module.