Les Boîtes Privées

Les « Boîtes Privées » sont des cadres qui peuvent apparaître selon vos souhaits ici ou là dans la partie privée de votre site et vous donner des renseignements parfois fort utiles : Les articles au format SPIP, Les auteurs en stat, Les URLs propres, Les tris d’auteurs, Les révisions du Couteau Suisse, etc.

Présentation

Les « Boîtes Privées » sont des cadres bien pratiques qui peuvent apparaître selon vos souhaits ici ou là dans la partie privée de votre site.

Actuellement, nous pouvons vous proposer les boîtes suivantes :
-  Les révisions du Couteau Suisse
-  Les articles au format SPIP
-  Les auteurs en stat
-  Voir les URLs propres
-  Et pourquoi pas : ajouter une « boîte privée perso »

Installation

L’outil décrit ici est une fonctionnalité du plugin « Le Couteau Suisse » que vous pouvez trouver ici : Le Couteau Suisse.

Pour avoir accès aux diverses boîtes décrites dans cet article, il vous faut donc avoir préalablement installé ce plugin en suivant la procédure normale d’installation des plugins SPIP.

Ensuite, veuillez activer l’outil « Boîtes Privées » en vous rendant sur la page d’administration du plugin en espace privé (Bouton Configuration, et onglet "Le Couteau Suisse").

Une fois cet outil activé, vous aurez enfin la possibilité de choisir vos boîtes, chacun étant dés/activable.

Les révisions du Couteau Suisse

Le Couteau Suisse est un plugin qui évolue beaucoup ces temps-ci et il peut être intéressant d’en suivre les évolutions au fur et à mesure.
Ici, vous pouvez trouver un historique automatique en format texte.

Exemple de boîte :

Où est donc cette boîte ?

Sur la page de configuration du Couteau Suisse (ecrire/?exec=admin_couteau_suisse), vous la trouverez dans un cadre à gauche si vous êtes en interface « Petit écran » ou à droite si vous êtes en interface « Grand écran ».

Les articles au format SPIP

Lorsque l’on souhaite copier tout ou partie d’un article dans un autre article, il est nécessaire d’éditer cet article pour y avoir accès dans sa forme brute, c’est-à-dire avec les raccourcis typographiques de SPIP non traités.

Outre le fait que cela est parfois fastidieux, un rédacteur qui n’est pas autorisé à éditer un article ne pourra pas avoir accès à sa forme brute. Dans certaines situations, notamment sur des sites collaboratifs, il est nécessaire que les rédacteurs puissent copier le contenu d’autres articles. Par exemple, si l’on travaille avec des modèles d’articles, il est bon qu’un rédacteur puisse copier le modèle dans un nouvel article sans pour autant pouvoir le modifier. Dans d’autres situations par exemple, un secteur peut correspondre à des documents ressources qui seront réutilisés pour la rédaction d’analyses dans d’autres secteurs du site.

Cette boîte permet donc de copier le contenu d’un article avec ses raccourcis typographiques sans avoir à l’éditer.

Auteur : Joseph LARMARANGE

Où est donc cette boîte ?

Sur la page d’un article dans l’espace privé (ecrire/?exec=articles), vous trouverez sous les mots-clés une boîte intitulée Texte au format SPIP. Quand on la déplie apparaît le texte brut du descriptif, du chapeau, du texte principal et du post-scriptum de l’article (voir capture d’écran ci-dessous). Il est alors aisé de copier la totalité ou une partie du texte pour ensuite le coller dans un autre article. Cette boîte est accessible que l’on soit ou non autorisé à éditer l’article en question. Il faut juste être autorisé à visualiser l’article dans l’espace privé [1].

Et dans l’espace public ?

SPIP vous fournit la solution de manière native. En effet, pour court-circuiter les traitements typographiques de SPIP et afficher le contenu d’un champ tel qu’il est enregistré dans la balise de données, il suffit de rajouter une astérisque ou * à votre balise. Par exemple #TEXTE* pour afficher le texte brut d’un article. Pour plus de détails, voir la documentation officielle de SPIP.

Les auteurs en stat

Cette boîte renseigne les administrateurs (uniquement) du site sur :
-  Les derniers auteurs connectés
-  Les insriptions non confirmées

Vous avez accès dans ce cadre aux dates de connexion et aux liens adéquats.

Exemple de boîte :

Où est donc cette boîte ?

Sur la page des auteurs (ecrire/?exec=auteurs), vous la trouverez dans un cadre à gauche si vous êtes en interface « Petit écran » ou à droite si vous êtes en interface « Grand écran ».

Depuis la version 1.8.14.03 du plugin, cette boîte utilise le fond fonds/derniers_connectes.html. Si vous souhaitez surcharger ce fichier, recopiez-le dans le dossier fonds/ de votre squelette avant de le modifier à votre guise.

Les webmestres SPIP

Cette boîte renseigne les administrateurs (uniquement) du site sur :
-  Les administrateurs promus webmestres

Vous avez accès dans ce cadre aux identifiants et aux liens adéquats.

Exemple de boîte :

Où est donc cette boîte ?

Sur la page des auteurs (ecrire/?exec=auteurs), vous la trouverez dans un cadre à gauche si vous êtes en interface « Petit écran » ou à droite si vous êtes en interface « Grand écran ».

Voir les URLs propres

Ce cadre dépliable indique l’URL propre associée aux objets de contenu et calculée d’après leur titre. Les alias d’URLs que SPIP 2.0 permet d’ajouter sont également listés. Vous pourrez donc connaître grâce à cette boîte, le lien public principal que SPIP utilise lors d’une demande d’accès à l’objet en question.

L’outil « Format des URLs » vous permet une configuration fine des URLs. Les URLS propres ne sont pas utilisées si vous choisissez l’un des format d’URLs suivants : html, page, standard.

Exemple de boîte :

Où est donc cette boîte ?

Sur chaque page concernant un objet de contenu SPIP (article, rubrique, auteur, brève, mot-clé, site...)

Les tris d’auteurs

Ce cadre dépliable pour les articles contenant plus d’un auteur et permettant simplement d’en ajuster l’ordre d’affichage. Ceci est utile pour placer par exemple l’auteur original ou principal d’un article en toute première position.

Exemple de boîte :

Attention : le tri des auteurs que vous avez défini manuellement n’est pas pris en compte lorsque votre boucle (AUTEURS) comporte un critere de tri. Vérifiez bien vos squelettes et vos modèles. Exemples :

Boucle triée selon vos spécifications :
<BOUCLE_auteurs(AUTEURS){id_article}{","}>#NOM</BOUCLE_auteurs>

Boucle triée par nom d'auteur :
<BOUCLE_auteurs(AUTEURS){id_article}{par nom}{","}>#NOM</BOUCLE_auteurs>

Par défaut, SPIP v3.0 trie les auteurs par nom.

Où est donc cette boîte ?

Pour l’instant, sur la page d’un article rédigé par au moins 2 auteurs. Mais dès SPIP v3.0, il est possible d’étendre cette fonctionnalité à d’autres objets liés à des auteurs : parlez-en dans le forum ci-dessous si besoin est !

Et pourquoi pas : ajouter une « boîte privée perso » !

Il est possible, depuis la version 1.8.09.02 du plugin, d’ajouter facilement une boîte privée de votre fabrication dans l’espace privé. L’outil « Boîtes Privées » va scruter les globales boites_privees_gauche, boites_privees_milieu et boites_privees_droite afin d’insérer automatiquement votre boîte dans les pipelines de SPIP : affiche_gauche, affiche_milieu et affiche_droite. Ces trois globales doivent contenir un tableau de fonctions déclarées comme ceci : function ma_boite_privee($flux, $exec)

Un exemple étant parfois mieux qu’un long discours, voici un extrait de code à ajouter dans un mes_options (config/mes_options.php par exemple) :

$GLOBALS['boites_privees_gauche'][] = 'ma_boite_privee';
function ma_boite_privee($flux, $exec) { 
	return $flux 
		. debut_boite_info(true) 
		. 'Youpi !!' 
		. fin_boite_info(true); 
}

Notez que :
-  le paramètre $flux contient l’ensemble du code HTML passé de plugin en plugin. N’en parlez à personne, mais en plus d’ajouter une boîte perso, vous pouvez également modifier le code des boîtes privées déposées par les plugins en amont, et notamment celles du Couteau Suisse lui-même... Chuuuut !
-  le paramètre $exec contient le nom de la page en cours, vous permettant éventuellement de mieux cibler le contexte d’affichage de votre boîte.

A titre d’indications, SPIP offre tout un panel de fonctions de cadres (étudiez le fichier ecrire/inc/presentation.php ) :

function debut_boite_info($return=false)
function fin_boite_info($return=false)
function debut_cadre_relief($icone='', $return = false, $fonction='', $titre = '', $id="", $class="")
function fin_cadre_relief($return = false)
function debut_cadre_enfonce($icone='', $return = false, $fonction='', $titre = '', $id="", $class="")
function fin_cadre_enfonce($return = false)
function debut_cadre_couleur($icone='', $return = false, $fonction='', $titre='', $id="", $class="")
function fin_cadre_couleur($return = false)

etc. !

Afin de rester compatible avec toutes les versions de SPIP, le Couteau Suisse a harmonisé le dépliement de ses boîtes privées grâce à la fonction suivante :

function cs_cadre_depliable($titre, $id_alpha, $texte)

Notes

[1Ce qui est le cas par défaut pour les rédacteurs sauf si l’on a recours à des plugins de restriction d’accès.

Discussion

12 discussions

  • 1

    Bon, si je comprend bien, il n’est pas très simple de faire ses boîtes perso... Serait-il possible de faire des boites avec boucles...

    Je m’explique, il m’est souvent demandé de faire des tutoriels d’utilisation de l’espace privé, particulièrement lorsque ce dernier risque d’être utilisé par un grand nombre de personnes...

    Idéalement, je mettrais une boucle récupérant les articles contenu dans une rubrique « tutorial » ou, au moins, un lien vers cette rubrique...

    Des idées ou pistes ?

    Je suis nul en PHP.

    Merci

    • Dans ce cas, une bonne doc avec copies d’écrans, non ?

      En ce qui concerne la lame perso, voici un exemple qui ajoute des cadres de tuto bien flashies dans la colonne de droite en partie privée :

      ############## COUTEAU SUISSE : LAME PERSO #################
       
       // Installation d'une nouvelle lame personnalisee
       $GLOBALS['mes_outils']['mes_boites'] = array(
       	'nom'         => 'Mes bo&icirc;tes priv&eacute;es',
       	'description' => 'Une lame qui ajoute des cadres de tuto ici ou l&agrave; dans l\'espace priv&eacute;.',
       	'categorie'   => 'admin',
       	'pipeline:affiche_droite'   => 'mes_boites_affiche_droite',
      	'code:css' => '.mes_boites {background-color:yellow; border:3px solid yellow; color:blue; float:right; font-size:85%; padding:5px; width:100%;}',
       );
       
       // Fonction de pipeline
       function mes_boites_affiche_droite($flux) {
      	switch($flux['args']['exec']) {
      		case 'auteurs':
      			$flux['data'] .= '<div class="mes_boites"><p><b>Tutoriel</b></p>'
      				. "<p>Ici, vous &ecirc;tes dans l'espace r&eacute;serv&eacute; aux auteurs !</p>"
      				. '</div>';
      			break;
      		default:
      			break;
      	}
      	return $flux;
       }

    Répondre à ce message

  • 5

    On peut en faire facilement soi même, de ces boites ?

    • Tout dépend du contenu de chaque boîte mais c’est relativement simple. Le couteau suisse étant développé sur la zone, il est possible d’en proposer de nouvelles.

    • Sans vouloir faire le rabat-joie, pourrais tu m’indiquer où les trouver ? Y a un t il un sous-dossier « boites » dans le dossier SVN du couteau suisse ?

    • C’est pas si simple ;-) Les boîtes privées viennent tout juste d’être développées. Elles peuvent encore progresser !

      Ce qui est facile, c’est ajouter une lame perso : voir ici

      Je ne cerne pas dans ta question si tu veux ajouter des boîtes intéressantes et natives au Couteau Suisse, ou si tu veux ajouter une boîte très perso qui ne servira qu’à toi...

      Quelles idées as-tu derrière la tête ? Les deux voies sont possibles...

    • C’est plutot des boîtes persos (qui pourraient être intégrées au CS au final), mais pas des nouvelles lames.

    • Actuellement, il n’y a pas de mécanisme simple qui permet d’ajouter à la volée une boîte perso à l’outil « Boîtes Privées ».

      Le fichier qui gère les boîtes « Auteurs en stat » et « Format SPIP » est : « outils/boites_privees.php », le fichier qui déclare les boites est « config_outils.php » (ligne 360), le fichier qui gère la description est « lang/desc_fr.php » (ligne 394) et celui qui gère les chaines de langue est : « lang/cout_ ??.php » (ligne 10).

      Tu as donc les 4 fichiers à modifier si tu veux vraiment ajouter une boîte privée de ton cru, sachant qu’un fork des fichiers originaux du Couteau Suisse te prive de toute mise à jour ultérieure, ce qui est fortement déconseillé. A moins que tu fasses profiter la communauté de tes travaux... Et nous sommes toute ouïe !

      Bon, si vraiment ta boite privée est très très privée, je te conseille simplement de construire une lame perso dans config/mes_options.php et utiliser les pipelines déclarés dans couteau_suisse/plugin.xml.

    Répondre à ce message

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