Changes between Version 4 and Version 5 of review

Timestamp:

Apr 22, 2011, 12:13:54 AM (14 years ago)

Author:

g7moreau

Comment:

Options générales

review

@@ -41 +41 @@
 Tout comme de nombreux modules...
 
-Il faut charger le module
+Il faut charger le module {{{review}}}.
+Les options seront dans un paragraphe spécial.
 {{{
 \usepackage[options]{review}
@@ -73 +74 @@
 puis deux à quatre paramètres :
 
- - '''{{{revadd}}}'''{{{[option]{author}{add}{com}}}}
-   Ajoute du texte {{{add}}} ;
+ - '''{{{\revadd}}}'''{{{[option]{author}{add}{com}}}} -
+   ajoute le texte {{{add}}} ;
    
- - '''{{{revmod}}}'''{{{[option]{author}{old}{add}{com}}}}
-   Remplace le texte {{{old}}} par 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}}} ;
+ - '''{{{\revdel}}}'''{{{[option]{author}{old}{com}}}} -
+   supprime le texte {{{old}}} ;
 
- - '''{{{revmark}}}'''{{{[option]{author}{com}}}}
-   Place une simple remarque dans la marge
+ - '''{{{\revmark}}}'''{{{[option]{author}{com}}}} -
+   place une simple remarque dans la marge
 
- - '''{{{revpar}}}'''{{{[option]{author}{com}}}}
+ - '''{{{\revpar}}}'''{{{[option]{author}{com}}}} -
    Place une remarque conséquente (longue) dans le corps de la page
 
@@ -94 +95 @@
 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}
+}}}