Todo

Écrire rapidement des listes de choses à faire, sans se prendre la tête.

Ce plugin est une extension de Textwheel, il ajoute de nouveaux raccourcis typographiques permettant de générer rapidement une liste de choses à faire proprement présentée, et triable.

Il ne s’agit pas d’une fonctionnalité mais juste de la présentation.

Installation

La branche v1 du plugin est compatible SPIP 2.1 et nécessite Textwheel ainsi que Bonux. Les nouvelles branche v2 et ultérieures ne nécessitent plus que Textwheel distribué par défaut avec SPIP.

Les branches v2 et ultérieures apportent de nouvelles fonctions au plugin mais assure une compatibilité ascendante parfaite avec la branche v1.

Utilisation de base

Une liste commence par une suite de trois +++ suivie d’un retour à la ligne, et se termine de la même façon ; ou bien elle est incluse entre les marqueurs <todo></todo>. Cette deuxième solution se dégrade mieux lorsque le plugin n’est plus là : les balises deviennent invisibles et il ne reste que la liste à l’intérieur.

Ensuite, c’est le premier caractère qui détermine le statut de la tâche qui se limite pour la branche v1 à :

  • + indique quelque chose à faire ;
  • o (lettre o minuscule) signifie une tâche en cours ;
  • - indique une chose faite.

Pour les branches v2 et ultérieures, les nouveaux statuts ci-dessous ont été rajoutés :

  • x (lettre x minuscule) indique une tâche abandonnée ;
  • = signifie une tâche arrêtée temporairement ;
  • ! indique qu’une action est nécessaire pour débloquer cette tâche ;
  • ? indique qu’on ne connait pas le statut exact de cette tâche.

Utilisation avancée avec les branches v2 et ultérieures

A partir de la branche v2 le plugin se dote des améliorations suivantes :

  • qualification des tâches avec une priorité, des catégories et des informations typées ;
  • regroupement de tâches par projet ;
  • précision du titre d’une tâche avec un descriptif libre.

Toute ces informations complémentaires s’écrivent à la suite du titre de la tâche séparées par un espace.

Priorité

Toute tâche peut être affectée d’une priorité écrite @n ou #n où n est un chiffre compris entre 1 et 9.

Catégories

Toute information écrite @tag ou #tag est considérée comme une catégorie à partir du moment où « tag » est une chaine alphanumérique.

Attention : le choix @ ou # est fait une fois pour toute pour le site au travers d’une constante qui vaut @ par défaut. Vous pouvez la modifier dans votre config/mes_options.php.

Pour chaque tâche la liste des étiquettes est collectée et affichée précédée d’un petit caractère habituel pour les tags. Si un tag correspond au titre d’un mot-clé SPIP, alors il est affiché comme un lien vers la page mot-clé associée.

Informations complémentaires typées

Les informations typées sont écrites avec la syntaxe type:valeur où type et valeur sont des mots pouvant contenir des caractères alphanumériques y compris « - », « . » et « _ ». Les types d’information sont extensibles mais le plugin ToDo propose déjà 4 types prédéfinis :

  • « debut » : pour la date de début de la tâche sous la forme 2012-06-02 ;
  • « fin » : pour la date de fin de la tâche sous la forme 2012-06-09 ;
  • « commit » : pour un numéro de commit générant un lien vers son dépôt et pouvant s’écrire,
    • z72463 pour la zone en SVN,
    • c12922 pour le core en SVN,
  • « version » : un numéro de version.

A partir de la v3, la forge git de SPIP est prise en compte dans l’information « commit » et dans une nouvelle information nommée « issue ». Pour chacune des ces informations le format est g:orga:repo:ref, où :

  • g indique la forge git de SPIP,
  • orga est un identifiant abrégé d’un caractère pour l’organisation soit
    • x pour spip-contrib-extensions,
    • s pour spip-contrib-squelettes,
    • t pour spip-contrib-themes,
    • o pour spip-contrib-outils,
    • g pour spip-galaxie,
  • repo, le nom du dépôt
  • et ref est soit le sha complet du commit, soit le numéro du ticket.

Il est possible d’insérer plusieurs informations de commit pour la même tâche. Celles-ci seront affichées comme une liste de révision séparées par une virgule.

Projets

Un projet est détecté par le caractère « :» en début de ligne. Tout le reste de la ligne constitue le nom du projet. Les tâches d’un projet sont regroupées dans un même bloc de visualisation et numérotée de 1 à n.

Descriptif complémentaire libre

Toute ligne ne commençant pas par un caractère signifiant (statut ou projet) est donc un descriptif libre. Chaque ligne du descriptif est affichée à la suite du libellé de la tâche.

Intégration au Porte-plume

La branche v2 pour SPIP 3 permet aussi d’utiliser la barre d’édition du Porte-plume pour ajouter une tâche ou en changer le statut. Un bloc spécial d’édition est dédié aux todos et propose un bouton par statut.

Evolutions

  • version 3.0.2 : compatibilité spip 4 et ajout de la prise en compte de la forge git de spip pour les commits et les tickets
  • version 2.2.0 : changement de la stratégie et du prototype des fonctions de formatage des informations typées
  • version 2.0.7 : ajout de la possibilité de lier le tag à un mot-clé SPIP
  • version 2.1.0 : ajout du # comme indicateur de priorité ou d’étiquette en plus du @ qui reste la valeur par défaut.
  • version 2.1.1 : ajout d’une classe « fermee » à la todolist si celle-ci ne contient que des tâches dans un état final.
  • version 2.1.2 : ajout d’un attribut format optionnel à la balise <todo> qui permet d’utiliser le squelette inclure/todo_$format.html pour afficher la todo.
  • version 2.1.3 : ajout d’une ancre au début de chaque todo d’une page.
  • version 2.1.4 : amélioration de la regexp pour éviter l’incompatibilité avec le raccourci page ou onglet du CS.

Exemple pour la branche v1

+++
- Ça c'est déjà fait
+ Une chose
+ Deux ou trois choses
o Suis en train de le faire
- Well done
+++

ou bien

<todo>
- Ça c'est déjà fait
+ Une chose
+ Deux ou trois choses
o Suis en train de le faire
- Well done
</todo>

Ce qui génère automatiquement ceci, avec les titres de colonnes permettant de trier par statut, par titre, ou de remettre dans l’ordre :

Exemple pour la branche v2

<todo>
:Projet 1
- Refaire fonctionner l'aide en ligne des plugins fin:2013-05-26 commit:z72345 @1 @aide @sad
o Utiliser Tickets pour remonter les problème du site, les actions à réaliser voire les erreurs sur la présentation des plugins @2 @sad commit:z70345 
- Ajouter un menu des langues disponibles fin:2013-05-26 commit:c12345 @1 @traduction
+ Vérifier la gestion correcte des langues dans les pages @1 @traduction
+ Vérifier les traductions @1 @traduction
On parle ici des traductions du plugin Plugins SPIP et du Upload de SPIP !
x Mettre en place la gestion des tags en plus des catégories (plugin étiquettes ?) fin:2013-05-28
= Revoir la présentation du formulaire de sélection des plugins en vedette ou supprimer cette fonction

:Projet 2
! Etendre le serveur d'aide et le promouvoir @2 @aide @sad
? Ajouter une fonction d'agrégateur de profil utilisateur pour compléter l'aspect développement @3
</todo>

Ce qui génère automatiquement ceci, avec en particulier la colonne Révision qui possède des liens vers la Zone ou le Core :

Discussion

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom