Méthode pour construire l'aide contextuelle d'un plugin

L'onglet d'aide

La méthode helpBlock de la classe dcPage permet de créer automatiquement et surtout de formater l'onglet qui sera affiché sur la page administration de votre plugin (si elle existe).

Exemple avec l'onglet plié :

Et déplié :

Mise en place

Supposons que notre plugin s'appelle applepie.

Astuce :

Les noms du plugin et du fichier d'aide peuvent être différents. Dans cet exemple ils sont identiques par commodité.

Dans le fichier index.php de celui-ci, ajouter à la fin :

<?php dcPage::helpBlock('applepie');?>
</body>
</html>

Dans les sous-répertoires /locales/en et /locales/fr, ajouter le fichier resources.php suivant :

<?php
if (!isset($__resources['help']['applepie']))
{
	$__resources['help']['applepie'] = dirname(__FILE__).'/help/applepie.html';
}
?>

Et voilà, il ne reste plus qu'à créer vos deux fichiers d'aide (en anglais et en français) applepie.html respectivement dans un répertoire help créé dans chaque répertoire /locales/en et /locales/fr. Vous aurez alors l'arborescence suivante :

locales/
	en/
		resources.php
		help/
			applepie.html
	fr/
		resources.php
		help/
			applepie.html

Astuce :

Vous pouvez créer plusieurs fichiers d'aide pour votre plugin en donnant des noms différents aux fichiers. Par exemple si le nouveau fichier d'aide s'appelle crumble.html, dupliquez les lignes de code présentées au-dessus dans les fichiers correspondants en remplaçant applepie par crumble.

(Écrit par Osku pour dcplugins)

Format du fichier d'aide

Le fichier .html peut suivre le schéma suivant :

<html>
<head>
  <title>Titre du plugin</title>
</head>
 
<body>
 
<h4>Paramètres</h4>
<dl>
  <dt>Nom d'une option du plugin</dt>
  <dd>Description de cette option</dd>
 
  <dt>Nom d'une autre option du plugin</dt>
  <dd>Description de cette autre option</dd>
</dl>
 
<h4>Une autre section</h4>
<dl>
  <dt>Lorem ipsum</dt>
  <dd>dolor sit amet, consectetur adipiscing elit.</dd>
</dl>
 
</body>
</html>

Aide intégrée

Pour intégrer de l'aide aux formulaires, on peut utiliser la classe form-note pour les paragraphes :

<p class="form-note">
	<?php echo(__('Hello World!')); ?>
</p>