Manuel de rédaction du site

Publié le : 21 février 2011 – Dernière modification le 21 décembre 2021 – par kent1, Yffic – 102 commentaires

1
2
3
4
5
71 votes

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

[1] Dépendances obligatoires !

[2] Dépendances optionnelles

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

28 discussions

  • 1
    Cyril Marion

    Bonjour,

    J’ai un curieux « Au secours : help2. » qui s’affiche en dessous de l’intro du manuel, juste avant le contenu de l’article du manuel, et qui pointe vers un lien bizarre : .../ecrire/?exec=_edit&new=oui... C’est normal, docteur ? (Manuel 0.9.3 sur un SPIP 2.1.23)

    Merci !

    • tcharlss

      Je confirme, même problème ici. C’est un peu gênant.
      Le lien « help2 » est une chaîne de langue qui n’existe pas. Il est défini d’après l’option du formulaire de configuration qui n’a pas non plus de chaîne de langue correspondante : « label formu ».
      A mon avis, c’est donc une option encore en développement qui n’a rien à faire sur la version stable.

    Répondre à ce message

  • 3
    Miguel

    J’ai toujours utilisé ce plugin.

    depuis de actualiser a la version 0.9.0 il ne fonction plus (avant j’utilisait la version 69661). Je ne vois plus le icon an haut a gauche.

    Il y a d’autre webmasters avec le même probleme ?

    Merci

    Répondre à ce message

  • 5
    Raphaël

    Bonjour,

    Ce petit plugin est très pratique et je l’ai utilisé sur plusieurs sites. Cependant, je viens de tenter de l’installer sur un nouveau site avec SPIP 3.0.7 et j’ai deux petits bugs :

    Sur la page de configuration du plugin, après avoir validé les changements, j’ai ce message d’erreur :

    Fatal error : Call to undefined function lire_config() in /home/www/c140b23ef45a091456f5d65c44ad8a39/web/plugins/auto/manuelsite/v0.9.1/formulaires/configurer_manuelsite.php on line 106

    Sur le petit manuel (la bouée de sauvetage), avant le contenu proprement dit, j’ai ce message :

    Warning : Division by zero in /home/www/c140b23ef45a091456f5d65c44ad8a39/web/ecrire/inc/filtres_images_lib_mini.php on line 873

    Warning : Division by zero in /home/www/c140b23ef45a091456f5d65c44ad8a39/web/ecrire/inc/filtres_images_lib_mini.php on line 873

    Warning : Division by zero in /home/www/c140b23ef45a091456f5d65c44ad8a39/web/ecrire/inc/filtres_images_lib_mini.php on line 873

    Savez-vous comment corriger cela ?

    Merci de votre aide.

    • kent1 
      Fatal error : Call to undefined function lire_config() in /home/www/c140b23ef45a091456f5d65c44ad8a39/web/plugins/auto/manuelsite/v0.9.1/formulaires/configurer_manuelsite.php on line 106

      Le commit suivant http://zone.spip.org/trac/spip-zone/changeset/71243 devrait réparer cette erreur donc il va falloir mettre à jour le plugin (attendre le nouveau zip si besoin)

      Pour les autres erreurs, peut on avoir une capture d’écran ? Est ce que ton article de manuel a des images ? As tu GD2 d’activé pour la réduction d’images ?

    • kent1

      Ok suite au message de Pierre KUHN j’ai pu voir le problème des erreurs PHP et patcher par : http://zone.spip.org/trac/spip-zone/changeset/71262

      Ca devrait régler ce problème

    • Raphaël

      Bonjour,

      Merci pour cette réaction très rapide ! Je viens de faire la mise à jour et les erreurs ont disparu.

      Il y a cependant encore un petit détail concernant la largeur de la boîte. A la base, la largeur est bien celle que j’indique dans la configuration du plugin. Mais lorsque je déplie un intertitre, la boîte s’étend sur toute la largeur de la plus grande ligne (sans faire un paragraphe sur plusieurs lignes)...

    • Pierre KUHN

      Salut

      Moi j’ai plus de message d’erreur et j’ai pas le dernier soucis évoquer, tu vides tes caches ?

    • Raphaël

      En effet, j’ai tout rechargé et cela fonctionne. Merci beaucoup.

    Répondre à ce message

  • 5
    Pierre KUHN

    Bonjour

    Depuis le dernier commit, le plugins sauvegarde pas l’article souhaiter, chez vous aussi ?

    Répondre à ce message

  • 4
    Mist. GraphX

    Aucun problème, jusqu’ici, mais je tenais a dire : Merci et félicitations pour ce plugin ;-)

    Voila @+

    • Mist. GraphX

      Après quelques semaines d’utilisation spip 3.0.5 ..., je remarque dans mes log des erreurs de ce genre :

      Sep 29 21:59:46 127.0.0.1 (pid 1096) :Pri:WARNING: table_objet(faq) calculee sans verification
Sep 29 21:59:46 127.0.0.1 (pid 1096) :Pri:ERREUR: Erreur mysql 1146
Sep 29 21:59:46 127.0.0.1 (pid 1096) :Pri:ERREUR: Table 'test_spip3.faqs' doesn't exist - SHOW CREATE TABLE <span class="base64" title="PGNvZGUgY2xhc3M9InNwaXBfY29kZSBzcGlwX2NvZGVfaW5saW5lIiBkaXI9Imx0ciI+ZmFxczwvY29kZT4="></span>
Sep 29 21:59:46 127.0.0.1 (pid 1096) :Pri:!INFO: trouver_table: table inconnue '' 'faqs'

      une idee de ou ça peut venir ?

    • Yffic

      Hello

      C’est un problème de log un peu trop verbeux de spip. Sans conséquence sur le fonctionnement. Voir cette discussion : http://thread.gmane.org/gmane.comp.web.spip.zone/29221/focus=29236

    • Mist. GraphX

      ok merci de ta réponse, j’avais pourtant fait des recherche , mais je ne suis pas tombé sur ce fil.

      Ce qui m’étonne, dans ce cas précis c’est que je dois avoir une trentaine de plugins installé sur le site de test et je n’ai des log d’erreur que sur celui la, hors le thread parle d’une généralité de spip, j’aurais donc due avoir plus d’erreurs, mais bon, a par moi qui regarde les logs ^^, faut relativiser !

      merci encore pour le plugin et bonne journée ;-)

    • Yffic

      Moi, j’en ai sur d’autres plugins... Donc attendons la correction dans le core et ensuite on verra...

    Répondre à ce message

  • 7
    davduf

    Super plug in, bravo !

    J’ai un seul soucis : impossible de poursuivre ma FAQ sur le modèle de ce qui est présenté.
    J’ai fait (sans les espace, bien sûr)

    < h 3 > Evenements : < /h 3 >
    < h 4 > Pour créer un évenement < / h 4 >
    Aller dans Edition > Evenements > Créer un évenement
    Attention, tout événement doit être lié à un article.

    ... mais tout s’affiche de la même manière, en H3
    Comment faire ?{{}}

    Merci !

    • Yffic

      Hello

      Je ne pense pas que ce soit une bonne idée d’écrire du html dans l’article. Actuellement pour créer plusieurs niveaux, il faut passer par les enluminures typo du porte plume.

    • Manu

      N’y-a-t’il pas également un problème d’écriture ? j’ai l’impression qu’il y a des espaces en trop
      <h 3> au lieu de <h3> etc...

    • davduf

      Oui, oui, bien sûr, je passe par les enluminures typo du porte plume.

      Mes < h 3 > étaient juste là pour que vous compreniez.

      Mais j’a comme l’impression qu’il y a une incompatibilité entre utiliser les FAQ déjà prêtes (et bien faites !) et y ajouter les siennes avec un format similaire. Non ?

      Autrement dit, comment faire cohabiter les deux ?

      Merci !

    • Yffic

      Je ne sais pas comment tu as fait les tiennes. Moi j’ai fait un plugin « faqcommune » qui contient juste un fichier paquet.xml et les chaines de langues pour la faq dans un fichier lang/faq-faqcommune_fr.php. Et ca fonctionne...

    • davduf

      Yffic

      Ah, bah moi j’édite directement l’article... Ce n’est pas ce qu’il faut faire ?
      Où est ce plugin « faqcommune » ?

      Je peux voir un exemple ?

      Merci !

    • Yffic

      Je ne comprends pas bien le problème... Est-ce que tu peux m’envoyer en privé un accès admin à ton site ?

    • davduf

      Une réinstallation des enluminures a tout résolu.

      Merci, top ce plug in !

    Répondre à ce message

  • 7
    gilles

    Petit bug concernant la publication de l’article contenant le mode d’emploi dans le flux rss ?

    Je viens de me rendre compte que l’article que j’utilise pour le mode d’emploi est publié dans le flux rss du site,

    bien que j’ai coché la case pour cacher l’article dans les paramètres cfg du plugin.

    J’ai essayé de modifier le statut de l’article pour qu’il ne soit visible que des administrateurs. Mais si l’article n’est pas associé au statut « publié en ligne », il n’apparaît pas dans le back office.

    C’est génant car le mode d’emploi peut contenir de l’infos qu’il n’est pas nécessaire de rendre publique.

    Sinon bravo pour ce plugin

    • Yffic

      Hello

      Peux tu recalculer ton flux rss pour voir si l’article en question est toujours dedans ?

    • gilles

      Oui il y est toujours.

      Sur le rss de spip.

      Mais, Je m’en suit rendu compte en essayant ce site de curation par flux rss :

      http://memolane.com/gillesklein_sites

      Et le mode d’emploi apparaît à la date du « tue oct 11 2011 ». C’est le deuxième item.

      J’ai vérifier dans cfg, la fonction cacher l’article est bien activée.

      Je suis le seul à qui cela arrive ? ;(

    • gilles

      Oui :)

      Il a maintenant disparu du flux...

      Je pense que c’était un bête problème de cache de spip.

      Rien à voir avec le plugin...

      Merci d’avoir répondu.

      Et désolé.

    • Yffic

      Je vais invalider le cache quand on modifie ce paramètre, comme ca on sera sûr de ne pas diffuser un vieux cache

    • feeling03

      Bonjour,
      j’avais aussi ce problème. Mon article apparaissait dans le site public alors que j’avais coché la case « ne pas publié sur le site public ».
      En effet, j’ai vidé le cache et celui-ci a disparu.

      Une astuce à savoir !

    • Yffic

      C’est intégré dans la version 0.7.5 : Invalider le cache si on modifie l’option de config permettant de ne pas afficher l’article dans l’espace public

    Répondre à ce message

  • 4
    Pierre KUHN

    Bonsoir

    Dans le cas d’une mutualisation, comment pourrais je faire pour que tous les sites l’ai dans leurs sites et non sur un site précis ?

    • Yffic

      Salut

      Ce n’est pas trop l’objet... enfin, je ne l’ai pas imaginé pour ça... Pour moi, ce qu’il y a dans ce manuel est justement ce qui est spécifique à chacun des sites d’une mutu. Bon c’est vrai y’a des paragraphes communs (du genre comment insérer une vidéo ou un son). Tu pourrais à la limite rajouter dans le chapeau un lien vers un pdf qui serait commun à l’ensemble de tes sites et stocké dans le répertoire IMG de la racine) mais Il y a déjà le lien vers le manuel du rédacteur spip, ça risque d’être trop compliqué pour le rédacteur qui veut un accès rapide à l’aide.

      Et puis chacun a sa manière de rédiger,le niveau de son public cible... donc difficile de faire du générique pour parler du cas particulier

    • Pierre KUHN

      Donc pas imaginé et pas réalisable.

      Je vais me monter mon plugins pour faire ce que je veux.

    • Yffic

      Hello

      Avec les blocs génériques de la version 0.6, et en créant un plugin spécifique (fournissant les blocs que tu désires) à activer sur tous les sites de ta mutu, tu dois pouvoir arriver à faire ce que tu veux...

      A+

    • Pierre KUHN

      Merci Yffic

      Je regarderais cela à l’occasion et te ferais le rapport.

    Répondre à ce message

  • 5
    Perline

    Une petite suggestion : ne pas limiter la hauteur de fond de couleur de l’article. Quand l’article est long ou que les blocs dépliables le sont ils dépassent du fond bleu et cassent l’homogénéité.
    Et cerise sur le gâteau : que le fond change en fonction de la couleur choisie dans l’espace privé < :-).

    • Yffic

      Heum... Peux tu reformuler ? Qu’est-ce donc que « la hauteur de fond de couleur de l’article »

    • Perline

      Quand l’article est très long le début est sur fond bleu et ensuite il s’arrête soudain et on est sur le fond blanc.
      Il faudrait que le fond soit extensible, qu’il ait la taille de l’article, quelle que soit cette taille.

    • Yffic

      Salut
      Désolé pour la réponse tardive. Je viens de retester chez moi, ca fonctionne correctement. Peux tu me donner plus d’infos sur ta configuration ( navigateur et version ) ?

    • Perline

      Désolée pour le retard.
      SPIP 2.1.10 , firefox et chrome.

    • Yffic

      Bon ben je reviens de vérifier chez moi ça fonctionne pour ces 2 navigateurs FF4 et FF5 et Chrome tout neuf...
      On ne doit pas se comprendre...
      Envoie moi une copie écran

    Répondre à ce message

  • 4
    gilles

    J’ai un bug à l’installation du plugin : un message d’erreur apparait dans l’espace privée après l’activation du plugin :

    “2 Erreur(s) dans le squelette
    1 Aucun squelette saisies/email.html n’est disponible... ../plugins/auto/saisies/saisies
    2 Aucun squelette saisies/email.html n’est disponible... ../plugins/auto/saisies/saisies

    ou voir pièce jointe

     ???

    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