Plugin Infobox : la documentation

Première utilisation

A l’installation du plugin Infobox, une div d’id « infobox » est ajoutée dans les pages du site, en première position à l’intérieur de la balise <body> [1].

Par défaut cette div est composée de 4 blocs « fieldset » de class « general », « marqueurs », « mots » et « divers ». On peut renommer ces 4 zones, ou en ajouter avec CFG.

Si la balise #INFOBOX n’est pas utilisée, les fieldsets restent vides.

Pour afficher un message, par exemple « Veuillez attribuer un mot clé à la rubrique » dans le fieldset de class « mots » de la fenetre « Infobox », la balise #INFOBOX est utilisée de la manière suivante :

#INFOBOX{mots, 'Veuillez attribuer un mot clé à la rubrique'}

La balise #INFOBOX peut se placer n’importe où dans les squelettes, en général bien entendu dans une boucle alternative, lorsqu’on attend un résultat, mais que la boucle ne sort rien. Par exemple :

#INFOBOX{general, 'La trad de cet article n'a pas encore été faite'}

Conseil : en cas de désactivation/désinstallation du plugin, et afin de pouvoir laisser toutes vos balises #INFOBOX dans vos squelettes le cas échéant, tester la présence du plugin :

  [(#PLUGIN{infobox|oui}) 
    INFOBOX{general,'hello'}
  ]

Le plugin est adapté à la structure de squelettes « Zen » car le « remplissage » de la fenêtre « infobox » se fait au fil de la construction de la page : chaque fois que la balise #INFOBOX est rencontrée dans un squelette le fieldset correspondant de la fenêtre « infobox » se remplit avec le message adéquat. On peut utiliser cette balise sans restriction de nombre.

Paramètrage avec CFG

Par défaut, la div « infobox » est calée juste après la fin de la balise ouvrante . La position CSS est « absolute », calée en haut à gauche du site. Ainsi son positionnement ne gène pas l’affichage du reste des blocs de la page. Si ce positionnement ne convient pas, il est possible de place la div infobox à un autre endroit.

Infobox vient avec 3 zones « fieldset » respectivement classés « general », « mots » et « divers ». CFG peut être utilisé s’il faut un plus grand nombre de blocs, ou renommer les 3 blocs par défaut.

Fonctionnement interne

A l’activation du plugin les opérations suivantes sont effectuées :
-  activation d’une nouvelle balise appelée #INFOBOX => au chargement de infobox_fonctions.php
-  insertion de la feuille de style « infobox » dans le head => au chargement de infobox_fonctions.php, partie insert_head

Notes

[1paramètre réglable avec CFG

Discussion

Une discussion

  • 1

    As-tu un exemple d’utilisation ? Je ne comprends pas à quoi ça peut servir.

    • Un peu comme le plugin console, mais pour l’interface publique. Les messages sont remontés via la balise #INFOBOX. On peut mettre des #INFOBOX un peu partout dans les squelettes, tous les messages sont regroupés dans une fenêtre unique, sur l’interface publique. L’utilité première est de faire remonter un message lorsque le squelette tombe dans une boucle alternative => si on est dans la partie alternative d’une boucle, c’est que vraisemblablement il manque quelque chose au niveau éditorial : un mot clé, une traduction... La fenêtre infobox est là pour le signaler aux rédacteurs.

      L’alternative que j’utilisais jusqu’à présent était d’afficher ce type de message à destination des rédacteurs, dans la page directement et de manière un peu plus désordonnée... Et j’étais obligé de lire tous les messages provenant de parties non affichables (head...) dans un commentaire dans le code source...

      Infobox n’est pas un plugin révolutionnaire, mais il est bien utile au quotidien ! Mon intention est de le partager avec tous ceux qui comme moi font de la mise au point de squelettes, en relation avec une équipe de rédacteurs.

      Je promets un bon exemple d’utilisation très bientôt, dès la mise en ligne du site sur lequel je travaille... mais j’espère que d’ici là le plugin aura commencé à être utilisé...

    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