#!/usr/bin/perl -w

=encoding UTF-8

=head1 NOM

jeu.rules - Jeu de règles pour acheck

=head1 DESCRIPTION

Les fichiers de jeu de règles contiennent les règles qu'acheck doit vérifier.

Les lignes commençant par un dièse («E<nbsp>B<#>E<nbsp>») et les lignes vides
sont ignorées. Les espaces au début et à la fin d'une ligne sont aussi ignorés
ainsi que les tabulations. Si vous avez besoin d'espaces à la fin ou au début
d'une valeur, vous pouvez utilisez des guillemets anglo-saxons
(«E<nbsp>B<">E<nbsp>»).
Un commentaire commence par un dièse, il peut y avoir des espaces ou des
tabulations devant le dièse.
Les lignes longues peuvent être coupées en plusieurs lignes se terminant par
une barre oblique inversée («E<nbsp>B<\>E<nbsp>»).

Quelques exemplesE<nbsp>:

 # cette ligne est ignorée
 champ    valeur
 champ    valeur                               # ceci est un commentaire
 champ         "valeur avec espaces à la fin   "
 champ    valeur\
          se poursuivant sur la ligne suivante

Vous devez protéger le caractère dièse avec une barre oblique inversée si vous
voulez l'utiliser dans une valeur et utiliser des apostrophes si une valeur
contient une barre oblique inversée.

Les jeux de règles sont constitués de listes de règles. Ces listes peuvent être
répétées un certain nombre de fois, jusqu'à ce que ou tant qu'une condition est
vérifiée.

Une règle détecte une erreur si le test correspondant est vrai et qu'aucun de
ses tests de validation ne l'est. Chaque règle peut produire des corrections,
un avertissement ou une erreur, et fournir des commentaires pour aider
l'opérateur à corriger l'erreur.

Des parties du texte peuvent être définies comme commentaires et ainsi aucune
règle ni vérification orthographique de sera faite dessus.

=head1 FICHIER DE RÈGLES

=head1 RÈGLES DE SYNTAXE

=head2 list

Une liste débute à une indication «E<nbsp>I<list>E<nbsp>» et se termine au
premier «E<nbsp>I<end_list>E<nbsp>» ou à la fin du fichier.

Champs obligatoiresE<nbsp>:

=over 4

=item I<type> type

=over 4

=item I<until>, répète la liste jusqu'à ce que la ligne courante vérifie «E<nbsp>I<test>E<nbsp>»E<nbsp>;

=item I<while>, répète la liste tant que la ligne courante vérifie «E<nbsp>I<test>E<nbsp>»E<nbsp>;

=item I<loop>, répète la liste «E<nbsp>I<test>E<nbsp>» fois.

=back

=item I<test> regex / nombre

Une expression rationnelle pour les listes «E<nbsp>I<until>E<nbsp>» et
«E<nbsp>I<while>E<nbsp>». Le nombre de fois que la liste doit être répétée pour
«E<nbsp>I<loop>E<nbsp>», ou «E<nbsp>0E<nbsp>» pour une boucle infinie.

=back

Champs optionnelsE<nbsp>:

=over 4

=item I<name> nom

Utilisez ceci pour nommer la liste.

=item I<spell> yes / no

Positionner à «E<nbsp>I<yes>E<nbsp>» (oui, valeur par défaut) ou
«E<nbsp>noE<nbsp>» (non), selon que vous voulez ou pas que l'orthographe soit
vérifiée pour les lignes de cette liste. Cette valeur est héritée par les
sous-listes.

=back

Sous-règlesE<nbsp>:

=over 4

=item I<list> [nom]

=item I<rule> [nom]

=item I<comment> [nom]

Suivi par le nom de la sous-règle ou sa définition pour une sous-règle anonyme.

=back

=head2 rule

Une règle débute à une indication «E<nbsp>I<rule>E<nbsp>» et se termine au
premier «E<nbsp>I<end_rule>E<nbsp>» ou au début d'un commentaire ou d'une
liste.

Champs obligatoiresE<nbsp>:

=over 4

=item I<type> type

=over 4

=item I<fix>, règle fournissant dans corrections et des commentaires dans un menuE<nbsp>;

=item I<autofix>, règle corrigeant une erreur sans intéractionE<nbsp>;

=item I<warning>, règle produisant un avertissementE<nbsp>;

=item I<error>, règle produisant une erreurE<nbsp>;

=item I<nop>, règle spéciale ne faisant rien, les autres champs ne sont pas obligatoires.

=back

=item I<regex> regex

L'expression rationnelle qui doit être vérifiée pour trouver cette erreur. Des
motifs peuvent être capturés pour être utilisés ensuite dans les expressions
«E<nbsp>I<fix>E<nbsp>».

=item I<fix> expression

Fournit une correction pour la règle, ce champ peut être répété pour fournir
plusieurs choix. Seule la première est utilisée pour les règles
«E<nbsp>I<autofix>E<nbsp>». Les règles «E<nbsp>I<warning>E<nbsp>» et
«E<nbsp>I<error>E<nbsp>» ne fournissent pas de correction. Les motifs capturés
sont utilisables ici avec les variables «E<nbsp>I<$1>E<nbsp>»,
«E<nbsp>I<$2>E<nbsp>», etc.

=item I<hint> texte

Fournit des explications, elles sont utilisées comme commentaire de relecture
en mode relecture.

=back

Champs optionnelsE<nbsp>:

=over 4

=item I<name> nom

Utilisez ceci pour nommer la règle.

=item I<valid> [name]

Fournit un test de validation, il peut être nommé ou anonyme. Pour les
validations anonymes, la définition du test doit suivre. Ce champ peut être
répété plusieurs fois, il suffit que l'un des tests de validation soit réussi
pour que la règle ne soit pas appliquée.

=back

=head2 valid

Un test de validation débute à une indication «E<nbsp>I<valid>E<nbsp>» et se
termine au premier «E<nbsp>I<end_valid>E<nbsp>» ou au début d'une règle, d'un
commentaire, d'une liste, ou d'un autre test de validation.

Champs obligatoiresE<nbsp>:

=over 4

=item I<pre> regex

=item I<in> regex

=item I<post> regex

Teste les expressions rationnelles, avant, dans et après le motif trouvé par
l'expression rationnelle de la règle. Au moins l'un de ces test doit être
fourni. Si tous les tests réussissent, la règle n'est pas appliquée.

=back

Champ optionnelE<nbsp>:

=over 4

=item I<name> nom

Utilisez ceci pour nommer le test.

=back

=head2 comment

Un commentaire débute à une indication «E<nbsp>I<comment>E<nbsp>» et se termine
au premier «E<nbsp>I<end_comment>E<nbsp>» ou au début d'une règle, d'un
commentaire ou d'une liste.

Champs obligatoiresE<nbsp>:

=over 4

=item I<skip> regex

Une expression rationnelle correspondant au texte du commentaire. Ne pas
utiliser «E<nbsp>I<start>E<nbsp>» ou «E<nbsp>I<stop>E<nbsp>» avec ceci.

=item I<start> regex

=item I<stop> regex

Expressions rationnelles définissant le début et la fin d'un commentaire, tout
le texte contenu entre est considéré comme commentaire. Ne pas utiliser
«E<nbsp>I<skip>E<nbsp>» avec ceci.

=back

Champs optionnelsE<nbsp>:

=over 4

=item I<name> nom

Utilisez ceci pour nommer le commentaire.

=item I<start_offset>

=item I<stop_offset>

Définit où le commentaire commence et s'arrête réellement. Les valeurs
possibles sont «E<nbsp>I<s>E<nbsp>» pour le début du motif trouvé,
«E<nbsp>I<s+E<lt>nE<gt>>E<nbsp>» pour I<n> caractères après le début du motif,
«E<nbsp>I<e>E<nbsp>» pour la fin du motif, ou «E<nbsp>I<e-E<lt>nE<gt>>E<nbsp>»
pour I<n> caractères avant la fin du motif. Par défaut, «E<nbsp>I<s>E<nbsp>»
est utilisé pour les motifs de début de commentaire, et «E<nbsp>I<e>E<nbsp>»
pour ceux de fin.

=back

=head1 VOYEZ AUSSI

acheck(1), acheck(5)

=head1 AUTEUR

Nicolas Bertolissio <nico.bertol@free.fr>
  
=cut
