Documentation avec wikit

 

dc 29/01/06

Le but est d'intégrer un wiki (non modifiable par l'utilisateur) à une application starkit pour documenter une application.

Voulant documenter une application, j'ai utilise le wikit. Mais voilà, celui-ci est en anglais.

Étape 1 : récupérer le wikit.kit

http://www.equi4.com/pub/sk/wikit.kit

Étape 2 : le décompresser

 sdx unwrap wikit.kit

on obtient le répertoire wikit.vfs

Étape 3 : les modifications

a) On francise le fichier lib/wikit/gui.tcl

b) On francise le fichier lib/wikit/search.tcl

Étape 4 : on recompresse le tout

 sdx wrap wikit.kit

trouvable sur http://dcobac.free.fr/tcl/wikit_fr/wikit.kit

Étape 5 : on fait notre documentation

 tclkit wikit.kit

on obtient alors cette fenêtre :

On remarque que le bouton Help est en anglais ! C'est normal, il correspond à une page existante (dans le wikidoc.tkd). On clique sur Help et on appuie sur Éditer, on change alors dans la barre d'entrée le nom de la page en Aide, on sauve :

Ensuite on va sur la page d'accueil, et on fait la même manipulation, je change My Wiki en Documentation de mon super logiciel. La barre de titre de la fenêtre ne se mofifie alors pas...je ferme puis redémarre

 tclkit wikit.kit

et là tout est ok :

Pour se rassurer, je vais dans Chercher, et là, même tarif, la page s'appelle Search :

je la renomme Recherche :

Étape 6 : où ont été faites les modifications ?

Le wikit a créé un fichier nommé wikit.tkd qui contient les modifications de l'étape précédente. ce fichier contient toutes les pages de votre documentation (et les pages à venir...).

À vous d'ajouter des pages, de supprimer même tous les passages en anglais qui ne font pas partie de votre documentation.

Une fois la documentation prête, on pourra, pour plus de clarté, renommer le fichier en madocumentation.tkd, et appelez le wikit avec :

 tclkit wikit.kit madocumentation.tkd

Étape 7 : intégration dans un starkit

En lisant cette page, [1], on y apprend que seuls trois répertoires du wikit.vfs nécessitent d'être intégrés dans un starkit :

et en lisant celle-ci [2] on y apprend qu'il faut modifier le fichier lib/wikit/db.tcl pour y commenter la ligne :

 namespace import ::Wikit::Format::*

Ainsi, on redécompresse notre wikit.kit [3] francisé, on modifie le fichier db.tcl et on place les trois répertoires cités ci-dessus dans notre arborescence de starkit dans le même répertoire lib.

Notre fichier madocumentation.tkd, nous le plaçons dans un répertoire doc situé sur la racine de notre [strakit].

Étape 8 : appeler notre documentation

Notre application (que je suppose graphique) va appeler la documentation avec, par exemple, les lignes ci-dessous :

 package require Wikit
 Wikit::init [file join $::starkit::topdir doc madocumentation.tkd] 1 .aide

j'ai ici supposé que .aide est une toplevel existante. On peut imaginer la situation commune d'un bouton appelant la fenêtre d'aide :

 button $b -text "Documentation" -command documentation
 proc documentation {} {
    package require Wikit
    destroy .aide
    toplevel .aide
    Wikit::init [file join $::starkit::topdir doc tortue.tkd] 1 .aide
 }

Commentaires et ajouts

dc Cette page est aussi à voir sur le sujet : installation Wikit

Pour modifier les pages du wikit à la source (plutôt que par l'interface graphique), il faut modifier le fichier wikidoc.tkd avec l'utilitaire wikitool trouvable sur http://www.tcl.tk/starkits/