Manuel de rédaction du site

Ce plugin installe une icône d’aide permettant d’afficher depuis n’importe quelle page de l’espace privé le manuel de rédaction du site. Ce manuel est un article du site. Il a pour but d’expliquer aux rédacteurs l’architecture du site, dans quelle rubrique ranger quoi, comment encoder et installer une vidéo... Bref tout ce que vous voulez et qui est spécifique à votre site.

Installation

Comme tous les autres plugins, cf. https://www.spip.net/fr_article3396.html

Le plugin nécessite [1] les plugins SPIP Bonux (si Spip2), Saisies (Spip2 et Spip3) et Yaml (Spip2 et Spip3).
Il utilise [2] les plugins Palette et Pages.

Création du manuel

Écrire votre manuel d’utilisation dans un article. Soit dans une rubrique qui ne sera pas affichée dans le site public (par exemple verrouillée avec le plugin accès restreint). Ou bien en utilisant le plugin Page Unique.

Lors de l’affichage du manuel, le plugin applique un effet toggle de jquery sur les intertitres (h3). Si vous utilisez les Enluminures Typographiques pour le Porte Plume, l’effet sera aussi appliqué aux titres de 2e niveau (h4).

Blocs de texte génériques

Depuis la version 0.6, le plugin fournit des blocs de texte que l’on peut insérer directement dans le texte de l’article du manuel. Tous ces blocs peuvent être regroupés sous un sous-titre FAQ par exemple sous la forme <faq|b=nom_du_bloc>. On peut aussi les insérer sans la question : <faq|b=nom_du_bloc|q=non>.

Les blocs sont définis dans un fichier similaire à un fichier de langue, mais dont le nom commence par « faq- ». Les blocs définis par défaut dans ce plugin se trouvent donc dans le fichier faq-manuelsite_fr.php. Les autres plugins peuvent donc proposer leurs propres blocs. Il faut alors rajouter un paramètre au code d’insertion : <faq|p=nom_du_plugin|b=nom_du_bloc>.

L’insertion de ces codes :

produira donc :

Tous les codes des blocs disponibles sont listés dans la colonne de gauche dans la page d’édition du manuel. Les contenus correspondants s’affichent au survol de la souris.

Comme dans les chaînes de langue, on peut insérer dans les blocs des paramètres s’écrivant sous la forme @le_paramètre@ : <faq|b=nom_du_bloc|params=p1:v1;p2:v2>. Par exemple, <faq|b=thumbsites|q=non|params=rubrique:Liens> affichera

Enfin, petite astuce, dans le cadre d’une mutualisation, on peut créer un plugin qui ne servira qu’à fournir des blocs de texte. En activant ce plugin sur chacun des sites de la mutualisation, on aura accès à l’ensemble des éléments de cette FAQ partagée.

Cette collection de textes est évidemment à enrichir... Faites vos demandes dans le forum ou participez directement via l’espace de développement svn.

Configuration du plugin

Affichage du manuel

Une icône est affichée dans le coin haut gauche du navigateur. Si cliquée, le manuel est chargé en ajax et s’ouvre « par dessus » l’espace privé sur la largeur définie dans la configuration.

L’article du manuel peut être créé dès l’installation du site par le webmaster. Si les crayons sont activés dans l’espace privé, le manuel est directement modifiable... Cela permet au webmaster de le rédiger au fur et à mesure de l’avancement du site et de l’installation des fonctionnalités.

Notes

[1Dépendances obligatoires !

[2Dépendances optionnelles

Discussion

28 discussions

  • 2

    Bonjour,

    Sur un spip tout neuf en 4.0.7 et PHP 8.0 avec juste le plugin/theme html5up story qui installe et requiert « crayons », « favicon », « liens vers réseaux sociaux », « meta+ », « saisies » et « spip reset », j’ai installé « manuel » sans problème mais quand je vais sur la page de config du plugin j’ai cette erreur :

    Erreur d’exécution ../plugins/auto/saisies/v4.4.1/inclure/generer_saisies.html | File […]/plugins/auto/saisies/v4.4.1/inc/saisies_lister_disponibles.php Line 45 : array_merge() : Argument #2 must be of type array, null given

    Si je reviens en PHP 7.4 plus d’erreur.
    Pierre

    Répondre à ce message

  • Bonsoir,

    Depuis l’une des dernière mise à jour du plugin, l’icône (bouée) est à droite au lieu d’à gauche, que ce soit sous Spip 3.2* ou spip 4.0.

    Outre que c’est perturbant pour les rédacteurs du site, c’est gênant quand on a activé la lame du Couteau suisse "Bouton « Voir le site public »" car, dans ce dernier cas, la bouée chevauche le logo du site.

    Merci d’avance,

    Cordialement,

    Hervé

    Répondre à ce message

  • Bonjour
    J’utilise ce plugin bien pratique depuis peu sur un site SPIP 3.2.7.
    Tout fonctionne très bien.
    J’ai juste un truc qui m’embête un peu : chacune des pages de l’espace privé intégrant le manuel de rédaction possède un titre (le titre html entre les balises « head » dans le code source des pages) avec la mention « Manuel de rédaction » ajoutée au titre habituel.
    Y a t-il un moyen d’enlever cet ajout ?
    Merci d’avance pour votre réponse.

    Répondre à ce message

  • spipfactory

    Bonjour,

    dans le cadre d’une mutualisation, j’aimerai réalisé un manuel de rédaction pour les sites.
    donc j’ai déposé le plugin dans plugins_dist ce qui forcera son activation pour tous les sites.

    mais j’avoue que je comprend pas bien ce qui est dit ici

    Enfin, petite astuce, dans le cadre d’une mutualisation, on peut créer un plugin qui ne servira qu’à fournir des blocs de texte. En activant ce plugin sur chacun des sites de la mutualisation, on aura accès à l’ensemble des éléments de cette FAQ partagée.

    quelqu’un pourrais t’il m’orienter sur la façon de procéder

    merci

    Répondre à ce message

  • Bonjour,
    J’aurais voulu afficher la page de Manuel dans l’espace public (id_article=xx). Ma boucle a beau inclure « tout », rien ne s’affiche.
    Merci pour vos lumières

    Répondre à ce message

  • 7
    Jaseur Boreal

    Comment rendre multilingue le "Manuel de rédaction du site" ?

    Bonjour,
    les rédacteurs étrangers d’un site multilingue s’expriment dans plusieurs langues et ne maitrisent pas toujours le français. Pour le premier "accueil" des rédacteurs étrangers qui pratiquent le Letton, l’Anglais, le Russe, ... le "Manuel de rédaction du site" avec traduction serait bien utile et pratique.

    Je n’ai pas encore réussi à le concevoir pour d’autres langues, certains l’ont-il déjà réalisé multilingue ?.

    Si vous avez des idées et solutions, bien merci. »

    • utiliser la syntaxe des blocs multilingues dans l’article ne suffit pas ?

      <multi>
      [fr] En francais
      [en] In English
      </multi>

      Qu’as tu essayé ?

    • Jaseur Boreal

      Bonsoir,
      Merci Maïeul pour les réponses.
      ,
      C’est « Écrire une nouvelle traduction » d’un article une fois que celui-ci est fait qui est d’habitude le processus utilisé.

      Pour l’article « Guide de rédaction » du site, comme il semble être unique, je ne sais pas trop comment faire.
      Je vais tester la formule avec le code dans l’article « Guide de rédaction » du site,

      <multi>
      [fr] En francais
      [en] In English
      [lv] Latvian
      </multi>

      Est-ce que l’affichage différencié des langues se produira coté privé « rédacteur » ?
      Le Guide est déjà un article d’une certaine longueur, cela risque de multiplier par 3 sa longueur.

      Y a-t-il d’autres solutions ?

      merci pour toutes vos suggestions et exemples.

    • je ne suis pas auteur dudit plugin, donc je ne peux pas dire. Mais si vous n’arrivez pas avec les traductions d’article c’est que ce n’est pas prévu pour. Cela ne devrait cependant pas être trop dur.

      Mais la solution que je propose devrait fonctionner en attendant (c’est un comportement standard de SPIP)

    • Jaseur Boreal

      Bonsoir,

      Cela semble fonctionner pour les lignes d’écritures relativement simples.

      Mais avec l’explication des tableaux dans SPIP cela se complique ....

      A quel moment mettre les balises multi et les [fr] dans un tableau de trois lignes et quatre colonnes .... on s’emmèle les variations de solutions ...
      c’est en essai ...
       ;-)

    • pourquoi tu ne fais pas tout simplement

      <multi>
      [fr]
      
      le table fr
      
      [en]
      
      le tableau en
      
      </multi>

      J’ai un peu regardé pour gérer via la traduction d’article : il y a pas mal de chose à modifier pour s’assurer que les traductions n’apparaissent pas côté public ...

    • Jaseur Boreal

      Merci de la suggestion,
      c’est vrai que sous cette forme c’est plus simple à gérér
      Bon week-end

    • Bonjour,

      Je reviens sur cette discussion : l’idée de gérer par les balises < multi > a ses limites :
      -  gestion lourde quand on doit gérer 4 langues,
      -  impossibilité de segmenter les fichiers joints par langue (PDF de manuel et testimoniaux par exemple), d’écrire d’intro par langue, etc.

      — > Ne serait-il pas possible de réserver un article par langue à Manuel Site ? Si c’est une bonne solution, cela dit...

      Ce plugin est une merveille, je ne peux plus m’en passer... une version multilingue du plugin, c’est mon voeu de cette année ;-)

    Répondre à ce message

  • 1

    Ce plugin semble ne plus fonctionner avec spip 3.1.13
    La page de configuration n’existe plus :
    « Fichier configurer_manuelsite introuvable »

    Importé à partir d’une copie de l’archive trouvée sur : http://plugins.spip.net/manuelsite.html

    • Oups, je l’avais mal téléchargé. Il fonctionne très bien en fait.

      Désolé...

    Répondre à ce message

  • 2

    J’utilise la lame « blocs dépliables » du couteau suisse
    Pas de problème partie publique ou partie privée... excepté dans l’article « manuel de rédaction du site » : les blocs sont inopérants (les blocs ne se déplient pas).
    Une piste ???
    SPIP 3.0.20 et CS à jour...

    • Un petit up : pas de piste à proposer ? En PJ, un fichier image qui explique le dysfonctionnement observé :
      les blocs dépliables du couteau suisse se déplient bien dans l’espace privé (et l’espace public, mais pas dans le manuel de rédaction du site

      Un conflit qqpart ? Une histoire de pipeline ?

      Merci (beaucoup) d’avance

    Répondre à ce message

  • Bravo pour ce plugin. C’est une solution élégante et bien faite qui répond bien à la question : comment apporter simplement une documentation complémentaire aux rédacteurs du site.

    Un grand merci !
    Peetdu

    Répondre à ce message

  • 1

    depuis la mise à jour 3.0.17 de SPIP, le bouton du manuel, affiché habituellement en haut à gauche de l’Espace privé, à disparu.

    Pour être bien sûr, j’ai, bien entendu vidé le cache de spip, cache des images compris.

    Merci d’avance,

    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