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.
manuel_site.zip
Vos commentaires
# Le 11 octobre 2011 à 23:58, par gilles
En réponse à : Manuel de rédaction du site
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
# Le 12 octobre 2011 à 11:56, par Yffic
En réponse à : Manuel de rédaction du site
Hello
Peux tu recalculer ton flux rss pour voir si l’article en question est toujours dedans ?
# Le 12 octobre 2011 à 15:59, par gilles
En réponse à : Manuel de rédaction du site
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 ? ;(
# Le 13 octobre 2011 à 22:03, par Yffic
En réponse à : Manuel de rédaction du site
Ton flux, c’est bien celui-la ?
http://christophegarda.com/spip.php?page=backend
# Le 13 octobre 2011 à 23:12, par gilles
En réponse à : Manuel de rédaction du site
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é.
# Le 14 octobre 2011 à 09:27, par Yffic
En réponse à : Manuel de rédaction du site
Je vais invalider le cache quand on modifie ce paramètre, comme ca on sera sûr de ne pas diffuser un vieux cache
# Le 18 mars à 10:00, par feeling03
En réponse à : Manuel de rédaction du site
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 !
# Le 22 mars à 14:25, par Yffic
En réponse à : Manuel de rédaction du site
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
# Le 28 juin 2011 à 20:29, par Pierre KUHN
En réponse à : Manuel de rédaction du site
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 ?
# Le 28 juin 2011 à 20:58, par Yffic
En réponse à : Manuel de rédaction du site
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
# Le 28 juin 2011 à 21:02, par Pierre KUHN
En réponse à : Manuel de rédaction du site
Donc pas imaginé et pas réalisable.
Je vais me monter mon plugins pour faire ce que je veux.
# Le 19 octobre 2011 à 23:26, par Yffic
En réponse à : Manuel de rédaction du site
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+
# Le 20 octobre 2011 à 18:10, par Pierre KUHN
En réponse à : Manuel de rédaction du site
Merci Yffic
Je regarderais cela à l’occasion et te ferais le rapport.
Répondre à ce message
# Le 15 avril 2011 à 11:11, par Perline
En réponse à : Manuel de rédaction du site
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é < :-).
# Le 18 avril 2011 à 22:17, par Yffic
En réponse à : Manuel de rédaction du site
Heum... Peux tu reformuler ? Qu’est-ce donc que « la hauteur de fond de couleur de l’article »
# Le 19 avril 2011 à 00:40, par Perline
En réponse à : Manuel de rédaction du site
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.
# Le 27 avril 2011 à 22:09, par Yffic
En réponse à : Manuel de rédaction du site
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 ) ?
# Le 26 juin 2011 à 18:27, par Perline
En réponse à : Manuel de rédaction du site
Désolée pour le retard.
SPIP 2.1.10 , firefox et chrome.
# Le 28 juin 2011 à 18:29, par Yffic
En réponse à : Manuel de rédaction du site
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
# Le 3 mars 2011 à 01:58, par gilles
En réponse à : Manuel de rédaction du site
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
???
# Le 3 mars 2011 à 10:44, par Yffic
En réponse à : Manuel de rédaction du site
Salut
C’est plutot un soucis avec le plugin saisies... reinstalle le pour voir
# Le 3 mars 2011 à 16:59, par gilles
En réponse à : Manuel de rédaction du site
Effectivement, j’ai réimporté le plugin qui est sur http://plugins.spip.net/Saisies (est-ce la meme source que sur spip-contrib ?),
et maintenant les deux plugins fonctionnent correctement.
Bravo et merci pour ce plugin. :)
# Le 6 avril 2011 à 17:24, par Perline
En réponse à : Manuel de rédaction du site
Ce plugin fait partie des choses qui semblent petites mais qui vous changent grandement la pédagogie de votre site < :-)
Je confirme en ce qui concerne cette erreur : même motif, même punition !
Les versions ne sont-elles pas les mêmes dans les divers lieux de téléchargement ?
# Le 6 avril 2011 à 17:40, par Yffic
En réponse à : Manuel de rédaction du site
Salut
Apparemment plugin.spip.net ne se met pas a jour tout seul :
http://article.gmane.org/gmane.comp.web.spip.zone/23145
Répondre à ce message
# Le 15 mars 2011 à 23:04, par Manu
En réponse à : Manuel de rédaction du site
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 ?
# Le 16 mars 2011 à 00:31, par Yffic
En réponse à : Manuel de rédaction du site
Salut
Je viens de refaire une livraison, j’avais oublié un necessite de Bonux. ëux tu retester ?
# Le 16 mars 2011 à 07:29, par Manu
En réponse à : Manuel de rédaction du site
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)
# Le 16 mars 2011 à 12:26, par Yffic
En réponse à : Manuel de rédaction du site
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
# Le 16 mars 2011 à 12:56, par Manu
En réponse à : Manuel de rédaction du site
Yes, c’était bien ça ! Tout est rentré dans l’ordre...
# Le 16 mars 2011 à 15:50, par Béat
En réponse à : Manuel de rédaction du site
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
# Le 16 mars 2011 à 15:59, par Manu
En réponse à : Manuel de rédaction du site
Cela veut dire qu’ill faut simplement que tu installes le plugin YAML
# Le 16 mars 2011 à 16:17, par Béat
En réponse à : Manuel de rédaction du site
Ok, on rajoute un plugin de plus :-) .... et ça marche !
Merci bien
Répondre à ce message
# Le 8 mars 2011 à 10:23, par Perline
En réponse à : Manuel de rédaction du site
Pour cacher l’article on peut aussi (plus radical et en fin de compte plus simple !) utiliser
/config/mes_options.phpavec 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;
}
# Le 8 mars 2011 à 21:50, par Yffic
En réponse à : Manuel de rédaction du site
Super merci... J’ai rajouté ca en option
# Le 9 mars 2011 à 09:11, par Perline
En réponse à : Manuel de rédaction du site
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;
}
# Le 9 mars 2011 à 10:51, par Yffic
En réponse à : Manuel de rédaction du site
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à
# Le 16 mars 2011 à 06:51, par spipfactory
En réponse à : Manuel de rédaction du site
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 :
Répondre à ce message
# Le 11 mars 2011 à 19:47, par marjorie
En réponse à : Manuel de rédaction du site
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 ?
# Le 11 mars 2011 à 19:48, par marjorie
En réponse à : Manuel de rédaction du site
J’ai oublié de préciser que la version de spip installée est la 2.1.8 [16966]
# Le 11 mars 2011 à 22:00, par marjorie
En réponse à : Manuel de rédaction du site
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...
# Le 11 mars 2011 à 23:15, par Yffic
En réponse à : Manuel de rédaction du site
Désolé, j’avais oublié le fichier dans la dernière livraison
# Le 12 mars 2011 à 08:40, par marjorie
En réponse à : Manuel de rédaction du site
Je télécharge donc la nouvelle version :) j’ai hâte de tester !
Répondre à ce message
# Le 5 mars 2011 à 17:56, par spipfactory
En réponse à : Manuel de rédaction du site
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
# Le 2 mars 2011 à 10:30, par Loiseau2nuit
En réponse à : Manuel de rédaction du site
GE-NIAL !!! Merci :)
Répondre à ce message
# Le 28 février 2011 à 22:50, par ?
En réponse à : Manuel de rédaction du site
Excellent que dire de plus
Répondre à ce message