wiki:review

Paquetage Review - Un module pour aider à l'édition collaborative

Liminaire

Review est un paquetage permet l'édition d'un document à plusieurs mais ayant une personne rédactrice principale.

On pourrait penser qu'un système de gestion de code source fasse cela. En pratique, les gestionnaires de code sources centralisés de type subversion ne sont pas conçu pour cela. Les systèmes décentralisés comme git pourraient le faire avec une autre approche.

Review peut être utilisé sans gestionnaire de code source, c'est un système complètement intégré à LaTeX. Cependant, utiliser un gestionnaire de code source pour un document TeX est toujours une bonne chose.

En pratique

Un document LaTeX est découpée en deux parties :

  • l'en tête, avant le \begin{document} ;
  • le corps du document.

Les commandes review vont permettre de modifier le document. Chaque modification sera visible avec un encart dans la marge (de largeur par défaut \marginparwidth).

Au moment de la compilation finale, il est possible de faire disparaître tous les encarts de sorte que review se rende invisible. Il n'y a donc aucune excuse à ne pas l'utiliser !

Toutes les commandes LaTeX commenceront par \rev afin de ne pas être trop verbeuse mais pourtant facile à retenir.

En tête

Le paquetage review doit être paramétré et chargé dans l'en tête d'un document. Tout comme de nombreux modules...

Il faut charger le module review. Les options seront dans un paragraphe spécial.

\usepackage[options]{review}

Pour définir une liste des relecteurs, on utilise la commande revauthor qui prend deux paramètres : un nom (alias de la personne) et une couleur. Dans review, les couleurs sont toutes définies en RGB.

\revauthor{gaby}{1,0,1}
\revauthor{vincent}{1,1,0}
\revauthor{gerard}{0,1,1}
\revauthor{herve}{1,1,0}

Chaque review devra être signé par un relecteur. Il faut donc définit autant d'alias que de personne travaillant sur le document.

Les textes modifiés ainsi que les marques ont les couleurs par défaut rouge et bleu ({1,0,0} et {0,0,1}). Il est possible de les changer via les deux commandes :

\revcolormark{0,1,0}
\revcolortext{1,0,1}

Corps du document

Les commandes suivantes prennent toutes un argument en option, puis deux à quatre paramètres :

  • \revadd[option]{author}{add}{com} - ajoute le texte add ;

  • \revmod[option]{author}{old}{add}{com} - remplace le texte old par le texte add ;
  • \revdel[option]{author}{old}{com} - supprime le texte old ;
  • \revmark[option]{author}{com} - place une simple remarque dans la marge
  • \revpar[option]{author}{com} - Place une remarque conséquente (longue) dans le corps de la page

Le premier paramètre est author, il doit s'agir d'un des alias définit dans l'en tête. Le dernier paramètre est toujours com comme "commentaire". Il est là pour préciser la modification si nécessaire. Il peut être vide sous la forme {}.

Il peut très vite être pénible pour l'auteur principale de supprimer toutes les marques review dans le document. C'est à ce niveau qu'intervient le paramètre optionnel. Celui-ci peut prendre les valeurs :

  • accept La modification est acceptée et le texte proposé est mis tel quel.
  • reject La proposition est refusée. Les modifications sur le texte ne seront donc pas sur le document final.
  • wait La modification a été vue mais aucune décision n'a encore été prise. Cette valeur permet de dire au relecteur qu'on a bien vu ses modications même si on ne sais pas encore quoi faire exactement...

Options générales

Lors du chargement du paquetage \usepackage[options]{review}, plusieurs options permettent de modifier le comportement du module.

  • width - permet de spécifier la largeur des encarts dans la marge (par défaut égal à \marginparwidth). Exemple width=4cm ;
  • counter - chaque review a un numéro qui s'incrémente en commençant à 1. Il est possible de démarrer à n'importe quelle valeur entière. Exemple : counter=100.

Il est ensuite possible de mettre l'une des options suivantes. A noter qu'il est aussi possible de mettre cette option dès la déclaration générale du document car de très nombreux modules en tiennent compte (notamment draft et final).

  • draft ou see - document en cours de travail. Toutes les review non acceptées sont visibles.
  • final ou hide - formatage final avant impression. Le module  review se fait invisible. Les review acceptées sont prise en compte sans couleur et les autres sont complètement cachés.

Exemple d'utlisation

\usepackage[draft,count=20,width=5cm]{review}

L'option final s'utilise généralement sur la déclaration du documentclass.

\documentclass[a4paper,final,12pt]{book}

Téléchargemet

La dernière version de review est accessible directement :

wget http://servforge.legi.grenoble-inp.fr/svn/soft-latex-review/trunk/review.sty
Last modified 9 years ago Last modified on Apr 22, 2011, 12:34:39 AM