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

  • 7

    Conflit avec saisies ?
    Sur un site en développement, j’ai un souci avec le plugin manuel du site que je viens d’installer. Son activation provoque des dysfonctionnements dans l’espace privé. L’affichage des pages liste de plugins ou plugins activés est incomplet (la zone où apparaissent les listes des plugins existant ou activés est « blanche ». Tout comme la page de configuration cfg (?exec=cfg).
    J’ai multiplié les tests et en désinstallant tous les plugins et en les réinstallant pour traquer le conflit, c’est le mariage « manuel » + « saisies » qui semble défaillant ce qui est étonnant. Pourtant, je viens de faire l’essai avec seulement saisies (1-9), cfg (1-16-0) + vidage de tmp...
    Une piste ?

    • Salut

      Je viens de refaire une livraison, j’avais oublié un necessite de Bonux. ëux tu retester ?

    • Hummmmm, je viens de refaire une installation. Ce n’est pas mieux... Je te mets une copie d’écarn en pièce jointe (et en attendant, ****MERCI**** pour ce chouette plugin qui est vraiment ce qu’on appelle une bonne idée)

    • J’ai peut être trouvé... Il manque un necessite YAML sur le plugin Saisies... Mais la tu dois êtr bloqué... Donc supprime le dossier manuel_site de plugins/auto, installe et active YAML, puis re-installe manuel_site

    • Yes, c’était bien ça ! Tout est rentré dans l’ordre...

    • Bonjour,

      J’ai le même problème que Manu. J’ai désinstallé tout mes plugins et remis les versions les plus récentes : rien n’y fait.
      J’utilise : Autorité 0.9.8 - cfg 1.16.0 - Liens spip_out ouvrants 1.0 - Pages 0.3.5 - Bonux 2.2.17 - Zpip 1.7.9 - Zen-Garden 1.1.2
      Il semble bien que ce soit le duo Manuel_site/Saisies qui pose problème.

      C’est quoi YAML ? Que faut-il en faire ? Moi pas comprendre langage informatique :-)

      Merci de vos lumières

    • Cela veut dire qu’ill faut simplement que tu installes le plugin YAML

    • Ok, on rajoute un plugin de plus :-) .... et ça marche !

      Merci bien

    Répondre à ce message

  • 4

    Pour cacher l’article on peut aussi (plus radical et en fin de compte plus simple !) utiliser
    /config/mes_options.php avec un genre de code comme ça :

    // Ne pas publier l'article numero 1
    $GLOBALS['spip_pipeline']['pre_boucle'] .= '|cacher_un_article';
    function cacher_un_article($boucle){
      if ($boucle->type_requete == 'articles') {
        $secteur = $boucle->id_table . '.id_article';
        $boucle->where[] = array("'!='", "'$article'", "1");
      }
      return $boucle;
    }
    • Super merci... J’ai rajouté ca en option

    • Il y a une erreur de syntaxe, le code serait plutôt :

      // Ne pas publier l'article numero 1
      $GLOBALS['spip_pipeline']['pre_boucle'] .= '|cacher_un_article';
      function cacher_un_article($boucle){
       if ($boucle->type_requete == 'articles') {
         $article = $boucle->id_table . '.id_article';
         $boucle->where[] = array("'!='", "'$article'", "1");
       }
       return $boucle;
      }
    • J’avais vu... Et de toute façon dans un plugin ca ne se fait pas de cette manière... Mais le principe est là

    • Pour cacher l’article

      En complément d’information a ceux et celles qui utilise le splendide squelette Sarka ( bon j’en fait un peu trop).

      Il suffit d’écrire votre manuel d’utilisation dans un article, qui soit la rubrique le Secteur spécialisé pour le squelette Sarka.
      -  Pour rappel :

      Certaines options de Sarka-SPIP ne sont accessibles qu’au travers d’un secteur spécialisé. Tous objets de ce secteur ne seront jamais affichés comme un article,

    Répondre à ce message

  • 4

    Bonjour, je ne comprends pas ce qui pourrait souci. J’ai téléchargé en mode automatique les plugins requis (saisies - CFG - pages - Palettes), puis le plugin « manuel ». J’obtiens un message d’erreur dans la liste des plugins qui m’empêche de l’activer : Fichier absent : ../plugins/auto/manuel_site/manuelsite_pipelines.php

    J’ai vérifié, ce fichier est pourtant présent dans le dossier en question...

    Quelqu’un a-t-il essuyé le même problème ?

    • J’ai oublié de préciser que la version de spip installée est la 2.1.8 [16966]

    • Après vérification plus attentive, le fichier est bien manquant, puisque c’est manuelsite_prive_pipelines qui se trouve dans le dossier et non manuelsite_pipelines. Si je renomme le fichier, je peux activer le plugin, mais il y a un message d’erreur...

    • Désolé, j’avais oublié le fichier dans la dernière livraison

    • Je télécharge donc la nouvelle version :) j’ai hâte de tester !

    Répondre à ce message

  • que dire ?

    « génial, chouette, extraordinaire, fabuleux, formidable, ingénieux, intelligent, prodigieux, sensationnel, super, talentueux. »

    -  Cela va nous être bien utile dans le cadre de notre projet de mutualisation de spip

    Effectivement le site image aura donc :

    Répondre à ce message

  • GE-NIAL !!! Merci :)

    Répondre à ce message

  • Excellent que dire de plus

    Répondre à ce message

  • salut,
    je fais toujours pour les rédacteurs d’un site un document pdf pour les guider dans les mises à jours, si jamais il y a des comportements propre à leur site.... et j’avais jamais eu l’idée de leur mettre ça en ligne... (certainement que ça me paraissait trop difficile à faire)
    donc l’idée me paraît très très utile, merci d’y avoir pensé !
    niveau test, ça marche très bien, vraiment très beaucoup, alors merci de l’avoir fait !

    c’est trop fort, voilà tout...

    Répondre à ce message

  • 1

    Voilà une idée qui est intéressante, même si bizarrement, je verrais plus ça dans un onglet du navigateur, comme on peut le faire avec l’aide en ligne.

    Une question : le contenu vient il en ajax ? Si c’est pas le cas, ça veut dire qu’il y a plein de contenu non pertinent dans le HTML pour les navigateurs texte ?

    • Salut Matthieu

      Concernant l’affichage dans une div, l’idée vient de Dotclear. Je trouve ça plus accessible et plus rapide que dans une nouvelle fenêtre ou un nouvel onglet.

      Concernant l’ajax, j’y avais pensé mais je n’ai pas encore eu le temps... yakafaire ;-)

    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