SPIP

[ar] [ast] [bg] [br] [ca] [co] [cpf] [cs] [da] [de] [en] [eo] [es] [eu] [fa] [fon] [fr] [gl] [id] [it] [ja] [lb] [nl] [oc] [pl] [pt] [ro] [ru] [sk] [sv] [tr] [uk] [vi] [zh] Espace de traduction

Télécharger

Étendre l’aide en ligne

Avril 2010 — mis à jour le : Juillet 2012

Toutes les versions de cet article :

Le script d’aide en ligne (à partir de la version SPIP 2.1) est désormais capable de fusionner plusieurs sources d’informations, et de les présenter de manière unifiée dans la fenêtre à deux frames qui s’ouvre lorsqu’on clique sur les icones de point d’interrogation depuis les pages de l’espace privé.


Principes

La globale help_server est à présent non plus l’unique URL d’un répertoire d’aide, mais un tableau de telles URL (la compatibilité est assurée néanmoins). Lorsque de l’aide est demandée dans une langue « L », SPIP va récupérer toutes les pages nommées « L-aide.html » existantes aux URL indiquées par cette globale, et fusionner les informations. Par défaut, ce tableau global a pour seul élément http://www.spip.net/aide, ce qui permet de retomber sur le comportement habituel mais peut donc être désormais complété par d’autres éléments.

On déclarera donc dans le fichier mes_options.php [1] l’URL pointant vers ce ou ces nouveaux fichiers d’aide.

Exemple

L’objectif est d’ajouter un paragraphe personnel d’aide au chapitre « Les raccourcis typographiques » de l’aide en ligne.

-  Dans le répertoire squelettes/, créer le fichier fr-aide.html [2] ainsi rédigé :

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr" lang="fr" dir="ltr">
<head>
<link rel='stylesheet' href='http://www.spip.net/prive/spip_admin.css' type='text/css' />
</head>
<body>
<h2>raccourcis/Les raccourcis typographiques</h2>
<!-- ajout d'aide personnalisée -->
<h3 class="spip">Mes raccourcis personnels</h3>
<p style="color:red;">
Ici un paragraphe d'aide personnalisée sur les raccourcis typographiques.
</p>
<p style="color:navy;">
Ici un autre paragraphe d'aide personnalisée.
</p>
<!-- fin ajout d'aide personnalisée -->
</body>
</html>

-  Dans le fichier mes_options.php, déclarer l’URL pointant vers le répertoire contenant ce fichier :

// URL supplémentaire où trouver de l'aide en ligne
$GLOBALS['help_server'][] = url_de_base(1) . 'squelettes/';

Attention : depuis SPIP3, il convient d’écrire :

$GLOBALS['help_server'][] = url_de_base() . (test_espace_prive()? '../' : '') . 'squelettes/';

-  Désormais, dans la fenêtre habituelle d’aide, un clic sur « Les raccourcis typographiques », dans le menu de gauche, affiche le texte de l’aide par défaut de spip.net complété (à sa fin) par le texte personnalisé [3].

Points d’entrée par défaut du menu de l’aide

Pour pouvoir greffer un supplément d’aide il faut baliser sa page d’aide personnelle en utilisant l’une des sections <h2>clef/titre_menu</h2> disponibles sur spip.net.

En voici la liste :

Installation de SPIP

  • install0/Régler les droits d’accès
  • install1/Votre connexion SQL
  • install2/Choix de votre base
  • install5/Informations personnelles
  • ftp_auth/Vérification par FTP
  • erreur_mysql/Un problème de squelette ?

Les articles

  • raccourcis/Les raccourcis typographiques
  • arttitre/Titre, surtitre, soustitre
  • artrub/Choisir la rubrique
  • artdesc/Descriptif rapide
  • artchap/Chapeau
  • artvirt/Redirection d’article
  • arttexte/Texte
  • artdate/Date
  • artdate_redac/Date de rédaction antérieure
  • artauteurs/Les auteurs
  • logoart/Logo de l’article
  • artstatut/Le statut de l’article
  • artprop/Proposer son article

Les rubriques

  • rubhier/Une structure hiérarchisée
  • rubrub/Choisir la rubrique
  • rublogo/Logo de la rubrique

Les brèves

  • breves/Les brèves
  • brevesrub/Choisir la rubrique
  • breveslien/Le lien hypertexte
  • brevesstatut/Le statut de la brève
  • breveslogo/Le logo de la brève

Images et documents

  • ins_img/Insérer des images
  • ins_doc/Joindre des documents
  • ins_upload/Installer des fichiers par FTP ou SSH

Les mots-clés

  • mots/Principe des mots-clés
  • artmots/Les mots-clés
  • motsgroupes/Les groupes de mots

Les sites référencés

  • reference/Référencer un site
  • rubsyn/Sites syndiqués
  • artsyn/Articles syndiqués
  • confhttpproxy/Utiliser un proxy

La messagerie interne

  • messut/ Les messages entre utilisateurs
  • messpense/ Les pense-bête
  • messcalen/Le calendrier
  • messconf/Configuration personnelle de la messagerie

Suivi des forums

  • suiviforum/Suivi des forums

Configuration du site

  • confnom/Nom et adresse de votre site
  • confart/Contenu des articles
  • confdates/Articles post-datés
  • confforums/Fonctionnement des forums
  • confbreves/Système de brèves
  • confmessagerie/Messagerie interne
  • confstat/Statistiques des visites
  • confmails/Envoi automatique de mails
  • confmoteur/Moteur de recherche intégré [4]

Configuration de l’interface personnelle

  • intersimple/Interface simplifiée / complète [4]
  • cookie/Le cookie de correspondance
  • deconnect/Se déconnecter

Usages avancés

  • artmodif/Articles en cours de « modification »
  • suivimodif/Suivi des révisions
  • corrortho/Correction orthographique [4]
  • previsu/La prévisualisation
  • latex/Formules mathématiques
  • confurl/Type d’adresses URL

SPIP, un logiciel libre

  • licence/Licence et conditions d’utilisation

Ajouter un bloc supplémentaire dans le menu de gauche

On peut aussi vouloir ajouter un bloc supplémentaire dans le menu vertical de gauche. Pour cela il suffit d’ajouter un élément <h1> </h1> dans notre fichier ..-aide.html :

<body>
<h1>Aide particulière personnalisée</h1>
<h2>bloc_perso/De l'aide sur tel élément</h2>
<h3 class="spip">Utilisation de tel élément</h3>
<p>
Ici un paragraphe d'aide personnalisée.
</p>
<p>
Ici un autre paragraphe d'aide personnalisée.
</p>
<h2>autre_bloc_perso/De l'aide sur tel autre élément</h2>
<h3 class="spip">Utilisation de tel autre élément</h3>
<p>
Encore un paragraphe d'aide personnalisée.
</p>
</body>

Ranger et organiser ses fichiers d’aide

Si vous préférez organiser vos fichiers d’aide supplémentaires dans un sous-répertoire particullier (« mes_aides/ » par exemple), vous devrez déclarer dans votre fichier « mes_options.php » :

$GLOBALS['help_server'][] = url_de_base(1) . 'squelettes/mes_aides/';

et depuis SPIP3 :

$GLOBALS['help_server'][] = url_de_base() . (test_espace_prive()? '../' : '') . 'squelettes/mes_aides/';
 
 
 
 

Voir aussi la balise #AIDER

Notes

[1Dans le cadre d’un plugin (« monplugin » par exemple, on déclarera cette URL dans le fichier monplugin_options.php. Par exemple : $GLOBALS['help_server'][] = url_de_base(1) . str_replace("../", "", _DIR_PLUGIN_MONPLUGIN); ou encore, si vous préférez ranger vos fichiers d’aide dans un sous-répertoire particulier : $GLOBALS['help_server'][] = url_de_base(1) . str_replace("../", "", _DIR_PLUGIN_MONPLUGIN) . "mes_aides/";

[2Dans le cadre d’une utilisation multilingue, multiplier ces fichiers : ar-aide.html, en-aide.html, es-aide.html, ...

[3Ne pas oublier que pour voir effectivement les modifications apportées, il conviendra de vider le cache (pour supprimer le dossier tmp/cache/aide/)

[4fonctionnalité abandonnée depuis SPIP 2.0


Voir le squelette de cette page Site réalisé avec SPIP | Espace de traduction | Espace privé