Kit de Développement Logiciel Open Source

L'ajout à votre application d'une aide en ligne contextuelle consiste à rédiger des pages HTML pour les vues que vous avez développées et pour lesquelles vous souhaitez apporter une aide aux utilisateurs .

L'aide en ligne une fois publiée est alors affichée directement dans l'application à la demande de l'utilisateur, dans une fenêtre dédiée, en superposition de la vue concernée, tel que cela vous est montré sur la photo ci-contre.

Activation de l'aide en ligne

Pour activer l'accès à l'aide en ligne dans votre application, modifiez à la valeur true le paramètre CFG_HELP_ENABLED du fichier /applications/default/app/config.php.

	/* Help parameter */
	define('CFG_HELP_ENABLED',true);

Après activation de l'aide en ligne, une icône et un lien hypertexte () sont ajoutés sur la droite de l'entête de l'application.

Ajout des pages d'aide

Pour publier une page d'aide contextuelle, ajoutez dans le dossier /applications/default/app/help/ le fichier nommé <menuid>.php contenant le code HTML de la page d'aide, où <menuid> correspond dans le script /applications/default/app/menu.php, à l'identifiant de menu passé à l'appel de la méthode \core\MenuManager::addMenuItem() pour le paramètre $menuItemID.

Par exemple, si la définition de votre menu de navigation dans le script /applications/default/app/menu.php est la suivante :

class Menu implements \core\iMenu {
	static public function initAppMenuItems() {
		\MenuManager::addMenuItem(null,'example1',"My example 1");
		\MenuManager::addMenuItem(null,'example2',"My example 2");
		\MenuManager::addMenuItem(null,'example3',"My example 3");
	}
}

Alors, pour afficher une page d'aide correspondant à la vue du menu My example 3 d'identifiant example3, ajoutez au dossier /applications/default/app/help/, le fichier nommé example3.php.

Enfin, pour afficher des images dans votre page d'aide, utilisez la constante PHP ZNETDK_APP_URI qui contient le chemin relatif d'accès aux ressources web de votre application ZnetDK dans le dossier /www de publication HTTP du serveur web, comme cela est illustré dans l'exemple de page d'aide ci-dessous :

<h3>My help page</h3>
<p>As shown on the image below...</p>
<img src="<?php echo ZNETDK_APP_URI;?>images/mypicture.png" />
<p>Other description of the view currently displayed...</p>

Dans cet exemple de page d'aide, l'image mypicture.png a été placée dans le dossier /applications/default/public/images de l'application.

Pages d'aide multilingue

Dans le cas où votre application a été développée pour un affichage multilingue (voir rubrique Gestion multilingue), vous devez ajouter autant de pages d'aide que de langues d'affichage supportées.

Si l'on se réfère à l'exemple du paragraphe précédent et si les 3 langues d'affichage supportées sont l'anglais, le français et l'espagnol, alors la page d'aide example3.php doit être déclinée en trois pages nommées respectivement example3_en.php, example3_fr.php et example3_es.php.