SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

286 Plugins, 197 contribs sur SPIP-Zone, 249 visiteurs en ce moment

Accueil > Rédaction > Manuel de rédaction > Manuel de rédaction du site

Manuel de rédaction du site

21 février 2011 – par kent1, Yffic – 92 commentaires

66 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. http://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.

Voir en ligne : http://plugins.spip.net/manuelsite

Notes

[1Dépendances obligatoires !

[2Dépendances optionnelles

Dernière modification de cette page le 25 septembre 2015

Retour en haut de la page

Tout afficher

Vos commentaires

  • Le 8 octobre 2015 à 22:50, par Manu En réponse à : Manuel de rédaction du site

    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...

    • Le 26 octobre 2015 à 17:07, par Manu En réponse à : Manuel de rédaction du site

      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

      GIF - 230.2 ko
    • Le 27 octobre 2015 à 16:31, par Manu En réponse à : Manuel de rédaction du site

    Répondre à ce message

  • Le 2 avril 2015 à 11:04, par Jaseur Boreal En réponse à : Manuel de rédaction du site

    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. »

    • Le 2 avril 2015 à 17:04, par Maïeul En réponse à : Manuel de rédaction du site

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

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

      Qu’as tu essayé ?

    • Le 2 avril 2015 à 19:13, par Jaseur Boreal En réponse à : Manuel de rédaction du site

      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.

    • Le 2 avril 2015 à 22:41, par Maïeul En réponse à : Manuel de rédaction du site

      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)

    • Le 2 avril 2015 à 23:47, par Jaseur Boreal En réponse à : Manuel de rédaction du site

      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 ...
       ;-)

    • Le 2 avril 2015 à 23:50, par Maïeul En réponse à : Manuel de rédaction du site

      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 ...

    • Le 3 avril 2015 à 12:00, par Jaseur Boreal En réponse à : Manuel de rédaction du site

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

    Répondre à ce message

  • Le 2 septembre 2014 à 14:38, par peetdu En réponse à : Manuel de rédaction du site

    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

  • Le 14 août 2014 à 13:49, par Fennec72 En réponse à : Manuel de rédaction du site

    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

  • Le 27 septembre 2013 à 18:15, par Cyril Marion En réponse à : Manuel de rédaction du site

    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 !

    • Le 4 décembre 2013 à 11:47, par tcharlss En réponse à : Manuel de rédaction du site

      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

  • Le 26 février 2013 à 18:03, par Miguel En réponse à : Manuel de rédaction du site

    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

  • Le 28 mars 2013 à 19:14, par Raphaël En réponse à : Manuel de rédaction du site

    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.

    • Le 28 mars 2013 à 20:25, par kent1 En réponse à : Manuel de rédaction du site

      1. 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 ?

    • Le 29 mars 2013 à 09:16, par kent1 En réponse à : Manuel de rédaction du site

      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

    • Le 29 mars 2013 à 11:13, par Raphaël En réponse à : Manuel de rédaction du site

      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)...

    • Le 29 mars 2013 à 11:23, par Pierre KUHN En réponse à : Manuel de rédaction du site

      Salut

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

    • Le 29 mars 2013 à 12:08, par Raphaël En réponse à : Manuel de rédaction du site

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

    Répondre à ce message

  • Le 27 février 2013 à 09:47, par Pierre KUHN En réponse à : Manuel de rédaction du site

    Bonjour

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

    Répondre à ce message

  • Le 21 août 2012 à 11:17, par Mist. GraphX En réponse à : Manuel de rédaction du site

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

    Voila @+

    • Le 29 septembre 2012 à 22:04, par Mist. GraphX En réponse à : Manuel de rédaction du site

      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 `faqs`
      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 ?

    • Le 3 octobre 2012 à 12:23, par Yffic En réponse à : Manuel de rédaction du site

      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

    • Le 3 octobre 2012 à 17:07, par Mist. GraphX En réponse à : Manuel de rédaction du site

      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 ;-)

    • Le 3 octobre 2012 à 18:22, par Yffic En réponse à : Manuel de rédaction du site

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

    Répondre à ce message

  • Le 16 juillet 2012 à 06:22, par davduf En réponse à : Manuel de rédaction du site

    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 !

    • Le 16 juillet 2012 à 09:07, par Yffic En réponse à : Manuel de rédaction du site

      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.

    • Le 16 juillet 2012 à 09:27, par Manu En réponse à : Manuel de rédaction du site

      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...

    • Le 16 juillet 2012 à 15:50, par davduf En réponse à : Manuel de rédaction du site

      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 !

    • Le 16 juillet 2012 à 20:36, par Yffic En réponse à : Manuel de rédaction du site

      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...

    • Le 16 juillet 2012 à 23:25, par davduf En réponse à : Manuel de rédaction du site

      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 !

    • Le 17 juillet 2012 à 20:12, par Yffic En réponse à : Manuel de rédaction du site

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

    • Le 17 juillet 2012 à 21:45, par davduf En réponse à : Manuel de rédaction du site

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

      Merci, top ce plug in !

    Répondre à ce message

Répondre à cet article

Qui êtes-vous ?

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 Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • Métas +

    3 décembre – 14 commentaires

    Améliorez l’indexation de vos articles dans les moteurs et leur affichage sur les réseaux sociaux grâce aux métadonnées Dublin Core, Open Graph et Twitter Card. Installation Activer le plugin dans le menu dédié. Dans le panel de configuration, (...)

  • Adaptive Images

    15 novembre 2013 – 69 commentaires

    Un plugin pour permettre aux sites responsive d’adapter automatiquement les images de la page à l’écran de consultation. Adaptive Images, que l’on pourrait traduire par Images adaptatives, désigne la pratique qui vise à adapter les taille, (...)

  • Social tags

    8 septembre 2008 – 428 commentaires

    Le plugin Social Tags permet d’ajouter des icônes de partage de liens vers les sites tels que Digg, Facebook, Delicious.... Une fois le plugin installé et activé (voir doc.), le choix des sites se fait via un menu de configuration. Insertion (...)

  • Module de Paiement Stripe

    17 octobre – commentaires

    Stripe est un prestataire de paiement externe https://stripe.com/fr qui propose une API moderne et une interface de paiement extrêmement conviviale et efficace. Ce module permet les paiements à l’acte et les paiement récurrents. Configuration (...)

  • Métas

    8 août 2009 – 50 commentaires

    Ce petit plugin permet l’ajout, depuis l’espace privé, de metatags aux articles et rubriques de SPIP, ainsi que la mise en exergue de mots importants.

Ça spipe par là