Description de la recevabilité d’une liste à un scrutin avec le plugin Opérations électorales

But

Le but des descriptions est de permettre d’aider la personne connectée dans l’espace privé lors de l’élaboration d’une liste. La description de la recevabilité permet de vérifier si les critères nécessaires à la soumission d’une liste à un scrutin sont respectés. En l’absence d’une description de ces critères, le plugin ne bloquera pas le processus considérant à juste titre qu’il n’y pas de recevabilité à verifier.

Intérêt d’utiliser une description de recevabilité

La recevabilité d’une liste est parfois simple (une alternance de genre, c’est à dire une femme suivie d’un homme ou inversement) mais se révèle souvent très complexe (la gestion de groupe dans la liste, avec une parité globale en pourcentage, un nombre minimum de candidates ou de candidats et un même maximum). Celui ou celle qui va composer la liste sera grandement aider par une assistance : la description de la recevabilité permet d’offrir cette aide.

Pré requis

Le présent tutoriel nécessite que vous ayez installé le plugin Opérations électorales et que vous vous familiarisiez avec le format de représentation de données YAML (qui est très simple).

Étape 1 : Créer la description et la sauvegarder à l’emplacement pertinent.

Le répertoire à la racine du plugin, intitulé recevabilites, accueille les descriptions YAML. Regardez les descriptions présentes qui concernent les scrutins proposés en exemple vous permettra de rapidement comprendre les normes utilisées pour procéder à cette description.

Ces descriptions sont écrites en YAML et au sein de fichiers qui portent l’extension .yaml. C’est dans le répertoire précité et sous cette forme que vous pourrez créer vos propres description de recevabilité.

Afin de faciliter la maintenance, il convient de créer le répertoire recevabilites dans votre plugin, mon_nouveau_plugin/recevabilites. L’ensemble des descriptions qui seront placées dans ce répertoire seront automatiquement pris en charge dès l’activation de votre plugin.

listes:
 global:
  imperatif:
  nb: integer # le nombre de membres que doit impérativement atteindre la liste
  success: <:idome:> # le message bravo
  error: <:idome:> # le message encore un effort
  explication: <:idome:> # l'explication du pourquoi atteindre ce nombre

mandats:
 'code_du_premier_mandat': # code du mandat tel qu'il sera déclaré lors de la création d'un membre de la liste
  titre: <:idome:> # le nom du mandat
  titre_h: <:idome:> # le titre attribué à un homme
  titre_f: <:idome:> # le titre attribué à une femme
 'code_du_second_mandat': # code du mandat tel qu'il sera déclaré lors de la création d'un membre de la liste
  titre: <:idome:> # le nom du mandat
  titre_h: <:idome:> # le titre attribué à un homme
  titre_f: <:idome:> # le titre attribué à une femme

groupes:
 '75': # le groupe 75 (code)
  imperatif:
   nb: 25 # doit impérativement contenir 25 membres
   titre: '<:idiome:>' # l'idiome du groupe permettra de précisé de 75 correspond à Paris
 '78': # le groupe 78 (code)
  imperatif:
   nb: 30 # doit impérativement contenir 30 membres
   titre: '<:idiome:>' # l'idiome du groupe permettra de précisé de 78 correspond à Yvelines

Étape 2 : Déclarer la disponibilité de la description créé auprès du scrutin auquel seront soumis les listes

Les descriptions une fois créées sont déclarées lors de la création du scrutin qui accueillera les listes.

Grace à cette déclaration, le plugin ira regarder si les conditions de recevabilité sont réunies. Si vous omettez la déclaration, le plugin ne vérifiera rien.

Étape 3 : profiter !

Votre description créée et celle-ci déclarée, vous pouvez profiter de la vérification de la recevabilité de la liste lors de la visualisation du contenu d’une liste.