Documentation de daCode
Documentation de l'utilisateur

 Menu
 · Sommaire
 · Que faire avec cette doc ?
 · Guide de l'utilisateur


Sommaire
   La documentation utilisateur est déstinée avant tout à vos lecteurs. Vous n'aurez sans doute pas besoin de la lire. Le document principal est le guide de l'utilisateur, un petit guide expliquant comment utiliser les fonctionnalités les plus utiles de daCode.

Que faire avec cette doc ?
   Si vous pensez que vos utilisateurs auront besoin de cette doc, il vous faudra sans doute l'adapter. En effet, le guide de l'utilisateur est écrit pour l'habillage LinuxFR, et certains habillages ont une mise en page très différente ; de plus, vous avez peut-être interdit l'accès à certaines fonctionnalités, et ajouté d'autres.

   Pour l'adaptation, vous avez trois possibilités
  • copier-coller les passages qui vous intéressent pour faire votre propre document ;
  • éditer les fichiers HTML avec votre logiciel favori (vim ? emacs ? ;) );
  • ou éditer le source XML.
La dernière façon est la meilleure et la plus flexible (surtout si vous utilisez CVS), mais il y a certaines limites :
  • vous devez disposer d'un convertisseur XML DocBook vers HTML (jade par exemple)
  • vous aurez aussi besoin de Perl pour pouvoir générer le véritable fichier source (lancez scripts/doctranslator.pl pour convertir le fichier usersguide.xml en un fichier valide, avec une seule langue) ;
  • la personnalisation de la sortie n'est pas forcément aisée.
Comme je l'ai dit, le fichier XML source est multilingue, avec la format suivant : tout ce qui est entre <:lg et :> sera gardé dans la traduction dans la langue désignée par lg, et ignorée dans tous les autres cas. Tout ce qui est en dehors de <:?? et :> sera présent dans toutes les traductions du document. lg représente un code de langue (par exemple « en », « fr » ou « es »), ?? n'importe quelle suite de deux lettres.