Help.kit

 


Un moteur d'aide pour vos starkits.


Cet outil a deux fonctions : afficher une aide au format html en tant qu'application indépendante, mais il peut aussi bien être intégré à votre propre starkit pour afficher l'aide de votre application.

Téléchargement : http://www.tcl.tk/starkits/Help.kit

Capture d'écran :


MANUEL FRANÇAIS DE HELP KIT


Utilisation avec de l'html embarqué :

Décompresser ce starkit :

 sdx unwrap Help.kit

Effacer tous les fichiers dans Help.vfs/html/ et les remplacer par vos propres fichiers html. Le premier fichier que Help.kit va essayer d'ouvrir sera les 2 premières lettres du code pays de l'utilisateur + .htm(l), puis index + .htm(l). Par exemple, pour un utilisateur français, il essaiera dans l'ordre : fr.htm puis fr.html puis index.htm puis index.html. Donc, si vous souhaitez utiliser cette internationalisation (i18n) automatique, enregistrez les pages d'accueils avec les codes pays. Sinon, utilisez index.htm(l). Si vous utilisez cette fonction i18n, pensez à copier le fichier en.htm(l) vers index.htm(l) pour que votre starkit fonctionne également avec les langues que vous n'aurez pas encore traduites.

Mettre à jour le starkit :

 sdx wrap Help.kit

C'est terminé, votre Help.kit est prêt.

Utilisation avec de l'html externe :

Décompresser ce starkit :

 sdx unwrap Help.kit

Effacer tous les fichiers de Help.vfs/html/

Mettre à jour le starkit :

 sdx wrap Help.kit

Quand vous lancerez Help.kit, il affichera les fichiers html contenus dans le même répertoire. Le premier fichier que Help.kit va essayer d'ouvrir sera les 2 premières lettres du code pays de l'utilisateur + .htm(l), puis index + .htm(l). Par exemple, pour un utilisateur anglais, il essaiera dans l'ordre : en.htm puis en.html puis index.htm puis index.html. Donc, si vous souhaitez utiliser cette internationalisation (i18n) automatique, enregistrez les pages d'accueils avec les codes pays. Sinon, utilisez index.htm(l). Si vous utilisez cette fonction i18n, pensez à copier le fichier en.htm(l) vers index.htm(l) pour que votre starkit fonctionne également avec les langues que vous n'aurez pas encore traduites.

Comment intégrer cet afficheur d'aide dans votre starkit :

Help.kit peut également être intégré dans vos starkits pour afficher leur aide de la manière suivante :

Décompresser ce starkit :

 sdx unwrap Help.kit

Effacer tous les fichiers dans Help.vfs/html/ et les remplacer par vos propres fichiers html. Le premier fichier que Help.kit va essayer d'ouvrir sera les 2 premières lettres du code pays de l'utilisateur + .htm(l), puis index + .htm(l). Par exemple, pour un utilisateur espagnol, il essaiera dans l'ordre : sp.htm puis sp.html puis index.htm puis index.html. Donc, si vous souhaitez utiliser cette internationalisation (i18n) automatique, enregistrez les pages d'accueils avec les codes pays. Sinon, utilisez index.htm(l). Si vous utilisez cette fonction i18n, pensez à copier le fichier en.htm(l) vers index.htm(l) pour que votre starkit fonctionne également avec les langues que vous n'aurez pas encore traduites. Copiez ensuite le sous-répertoire html dans votre_app.vfs et copiez également le contenu de Help.vfs/lib/ dans votre_app.vfs/lib/

Pour afficher l'aide depuis votre application, ajouter cette ligne dans votre script Tk :

 bind . <F1> { source [file join $starkit::topdir lib helpviewer hv.tcl] }

Lors du premier appel, l'aide affichera votre page d'index (spécifiée dans la variable globale $::help_index), ensuite, elle affichera le fichier que vous aurez spécifié dans la variable globale $::help_called s'il existe.

Quelques règles à suivre pour vos fichiers html :

Même si vous restez parfaitement libre d'écrire votre aide html comme bon vous semble, il serait souhaitable que toutes les aides respectent le même modèle. Ainsi, vos utilisateurs se sentiront plus à l'aise car en terrain connu et les autres développeurs tcl pourront plus facilement mettre à jour ou compléter l'aide que vous aurez commencée. C'est pourquoi je vous propose model_fr.htm. La façon la plus simple de l'utiliser consiste à remplacer le texte existant par le vôtre.

Ce modèle suit ces quelques règles : En-tête html très sobre avec seulement les champs requis. Titre de la page en gras et en majuscules entre <hr>. Titres des chapitres en gras. Texte des chapitres entre <blockquote>. Textes importants en gras. Code tcl en police à chasse fixe noire. Mettre le nom de la commande en gras quand on décrit une ligne de commande tcl. Mettre les arguments facultatifs en italique quand on décrit une ligne de commande tcl. N'utiliser que des images gif (pour que Help.kit puisse les afficher). Si vous suivez ces règles, ou tout autre exemple visible dans les fichiers html inclus dans Help.kit, vous pourrez être certain que votre aide html sera affichée correctement avec Help.kit aussi bien qu'avec n'importe quel navigateur et ce sur toutes les plate-formes supportées.