Informations du paquet.xml

Base de données

Le plugin définit deux tables :

1. la table spip_relectures définissant l’objet et l’état de toutes les relectures ;
2. la table spip_commentaires regroupant l’ensemble des commentaires et de leur état, toute relecture confondue.

spip_relectures
La table contient deux groupes d’informations :

• la définition du cycle de relecture, à savoir ;
  • l’article à relire, avec son identifiant, sa révision au moment de la création du cycle de relecture,
  • la période de relecture soit la date de lancement et la date de fin prévue,
  • la description facultative des attendus de la relecture ;
• l’état de la relecture, à savoir ;
  • chaque champ textuel (descriptif, chapeau, texte, post-scriptum) de l’article initialisé avec la révision au moment de la création du cycle de relecture,
  • un statut de la relecture, ouverte ou fermée,
  • et une date de clôture ainsi que la révision de l’article au moment de la clôture.

La liste des relecteurs est inscrite dans la table SPIP générique spip_auteurs_liens : objet « relecture » et id de la relecture.

spip_commentaires
La table contient les informations suivantes :

• un numéro d’ordre local à la relecture et qui permet de constituer le titre du commentaire sous la forme « commentaire [n] » ou en abrégé « [n] » ;
• la sélection du texte commenté par des repères de début et de fin ;
• l’auteur du commentaire, soit l’identifiant d’un des relecteurs ;
• les dates de création et de dernière modification du commentaire ;
• le texte du commentaire et la réponse éventuelle de l’auteur de l’article obligatoire en cas de refus de prise en compte ;
• le statut du commentaire, ouvert, refusé, accepté ou supprimé.

Les commentaires peuvent être discutés au travers de forums SPIP qui leurs sont attachés. Ces forums utilisent la table SPIP générique spip_forums.

Configuration

Une option de configuration permet d’autoriser ou pas la création de relecture ouverte à tous les rédacteurs du site (la valeur par défaut est « non »). Si cette option est retenue, le formulaire de création d’une relecture proposera cette option à l’initiateur.

En outre, il est nécessaire de forcer l’activation des révisions sur les articles. C’est la fonction d’installation de la base de données de Relecture qui se charge de cette opération.

Autorisations

Pour un article

• Ouvrir une relecture sur un article (article, ouvrirrelecture)
  • l’auteur connecté possède l’autorisation de modifier l’article ;
  • l’article est dans l’état "proposé à l’évaluation" ;
  • l’article n’a pas déjà une relecture d’ouverte ;
  • l’article possède au moins un élément textuel non vide.
• Consulter des fiches de relecture clôturées d’un article (article, voirrelectures)
  • l’auteur connecté possède l’autorisation de voir l’article (ce qui évite à un auteur de consulter la relecture d’un article qui lui est interdit).

Pour une relecture

• Modifier la configuration de la relecture (relecture, modifier)
  • l’auteur connecte possède l’autorisation de modifier l’article ;
  • la relecture est ouverte.
• Consulter une fiche de relecture (relecture, voir)
  • la relecture est ouverte et l’auteur connecté possède l’autorisation de modifier ou de participer à la relecture ;
  • ou, la relecture est clôturée et l’auteur connecté possède l’autorisation de voir les relectures de l’article.
• Rédiger des commentaires de relecture (relecture, commenter)
  • la relecture est restreinte à une liste donnée de relecteurs, l’auteur connecté possède l’autorisation de modifier l’article ou est un relecteur de l’article et la période de relecture n’est pas échue ;
  • ou la relecture est ouverte à tous les rédacteurs, l’auteur connecté possède l’autorisation de modifier l’article ou est un rédacteur du site et la période de relecture n’est pas échue.
• Changer le statut de la relecture (relecture, instituer)
  • la relecture est ouverte, des commentaires ont déjà été déposés mais plus aucun n’est ouvert (la période peut-être échue ou pas) et l’auteur connecté possède l’autorisation de modifier la relecture ;
  • ou la relecture est ouverte, aucun commentaire n’a encore été déposé, la période de relecture est échue et l’auteur connecté possède l’autorisation de modifier la relecture.

Pour un commentaire

• Édition du texte d’un commentaire ou de sa réponse (commentaire, modifier)
  • l’auteur concerné est l’auteur du commentaire (il peut donc modifier le texte), la modification concerne le "texte" du commentaire ou n’est pas précisée, le commentaire est encore ouvert ou supprimé et aucune discussion n’a encore débutée (pas de message de forum). Ainsi l’auteur peut également repositionné le commentaire supprimé à ouvert ;
  • ou, l’auteur possède l’autorisation de modifier la relecture (il peut donc modifier la réponse), la modification concerne la réponse au commentaire ou n’est pas précisée et le commentaire est encore ouvert.
• Consultation d’un commentaire et de ses discussions (commentaire, voir)
  • le commentaire est supprimé et donc seul son auteur peut encore y accéder ;
  • ou le commentaire est dans un autre statut et l’auteur connecté possède l’autorisation de voir la relecture.
• Participer aux discussions sur un commentaire (commentaire, participerforum)
  • le commentaire est encore ouvert et l’auteur connecté a l’autorisation de modifier la relecture. De ce fait, cet auteur peut répondre à des messages ou ajouter un nouveau message tant que la relecture est ouverte et donc après que la période de relecture est échue.
• Changer le statut d’un commentaire (commentaire, instituer)
  • Pour l’instant le formulaire instituer n’est pas capable de supporter un workflow tel que celui des commentaires. De fait, cette autorisation est bloquée à false et on désactive le formulaire instituer qui ne fait plus qu’afficher le statut.

Notifications

• Ouverture d’une relecture : provoque l’envoi d’une notification à tous les autres auteurs de l’article et à l’ensemble des relecteurs.
• Avancement d’une relecture : un fois par jour - ou selon une autre périodicité paramétrée lors de l’ouverture de la relecture - les auteurs de l’article reçoivent un suivi de la relecture.
• Échéance de la période de commentaires : les relecteurs et les auteurs de l’article sont prévenus qu’il n’est plus possible de poser des commentaires.
• Clôture de la relecture : les relecteurs et les auteurs de l’article sont enfin prévenus de la clôture de la relecture.

Interface utilisateur

Toute l’interface de gestion des relectures est intégrée dans l’espace privé. Cette interface est décrite dans l’article Relecture, Interface utilisateur