Titre du plugin

====== 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é : {{:2.0:resources:plugins:help:folded.png?300|}} Et déplié : {{:2.0:resources:plugins:help:unfolded.png?300|}} ==== Mise en place ==== Supposons que notre plugin s'appelle ''applepie''. 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 :

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

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

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 :




  Titre du plugin




Paramètres

  Nom d'une option du plugin
  Description de cette option

  Nom d'une autre option du plugin
  Description de cette autre option


Une autre section

  Lorem ipsum
  dolor sit amet, consectetur adipiscing elit.

===== Aide intégrée ===== {{:2.0:resources:plugins:help:form-note.png|}} Pour intégrer de l'aide aux formulaires, on peut utiliser la classe ''form-note'' pour les paragraphes :