Comment mettre à jour le site des tuteurs ou y ajouter du contenu?

Rajouter ~tuteurs/bin dans votre PATH

La plupart des programmes utilisés dans la suite sont dans ~tuteurs/bin. Éditez le fichier .profile à la racine de votre compte, trouvez le passage qui parle du PATH et modifiez la fin. Attention, ne pas oublier de mettre :\ (non suivi d'espace !) à la fin de l'avant-dernière ligne, et de tester (en vous logguant une deuxième fois) avant de se délogguer. 

PATH=\
$HOME/bin/$SYSTEMNAME:\
$HOME/bin:\
$UTILPATH:\
$MAINPATH:\
$GAMESPATH:\
$MISCPATH:\
/users/staffs/tuteurs/bin

Se créer un répertoire de travail

Tout d'abord, créez-vous un répertoire de travail sur votre compte avec mkdir. Par la suite, nous supposerons que ce répertoire s'appelle tuteurs/cvs.

Tapez les commandes suivantes: 

 teck ~/tuteurs/cvs $ cvstuteurs checkout web
 teck ~/tuteurs/cvs $ cd web
 teck ~/tuteurs/cvs/web $ rebuild .

Écrire une nouvelle page (ou la modifier)

Prenons un exemple. Supposons que vous souhaitiez écrire la page unix/accents.html. Pour cela, il va falloir écrire un fichier unix/accents.tml.

  1. Commencez par synchroniser votre répertoire de travail avec le repository: 
     teck ~/tuteurs/cvs/web $ cvstuteurs update
  2. Pour commencer à travailler sur ce nouveau fichier, faites : 
     teck ~/tuteurs/cvs/web $ cd unix
 teck ~/tuteurs/cvs/web/unix $ tmltemplate accents.tml "titre court" "titre long" 
 teck ~/tuteurs/cvs/web/unix $ cvstuteurs add accents.tml
 teck ~/tuteurs/cvs/web/unix $ emacs accents.tml
    Si vous voulez modifier un fichier existant, il ne faut pas taper les commandes du milieu. Le titre court est celui qui apparaîtra dans l'arborescence du site à gauche des pages (choississez-le concis, car l'arbre de navigation est étroit), le titre long sera écrit en gros en haut de la page.

    Pour ajouter des fichiers binaires (par exemple des images), il faut taper :

     teck ~/tuteurs/cvs/web/unix $ cvstuteurs add -kb foobar.png
  3. Écrivez le contenu du fichier. Ce dernier sera passé dans une moulinette qui s'appelle xsltproc qui rajoute automatiquement un plan du site à gauche et un sommaire de la page en cours de lecture. Les liens internes à la page des tuteurs doivent être sous la forme: 
    <a href="&url.tuteurs;docs/hublot/typo.html">
    Il faut mettre à la fin du fichier des lignes du type: 
    <div class="metainformation">
Auteur : Comptes tuteurs.
Dernière modification le <date value="$Date: 2008-10-05 11:20:36 $" />.
</div>
    Pour le reste, c'est du XHTML 1.0 Strict. Vous pouvez vous aider du tutoriel XHTML des tuteurs.
  4. Vérifiez votre page avec : 
     teck ~/tuteurs/cvs/web/unix $ tmlcheck accents.tml
  5. Lancez le script de conversion en .html en faisant : 
     teck ~/tuteurs/cvs/web/unix $ build accents.tml
  6. Si vous avez fait beaucoup de modifications, il peut être utile de retourner dans le répertoire web/ et de taper : 
     teck ~/tuteurs/cvs/web $ rebuild .
  7. Passer la page que vous venez de créer au validateur.
  8. Quand tout est au point, vous pouvez « commiter » en faisant (depuis le répertoire web/) : 
     teck ~/tuteurs/cvs/web $ make install
  9. On vous demandera d'indiquer des commentaires sur les manœuvres que vous avez faites dans les différents répertoires. Il est extrêmement important que ceux-ci soient précis et circonstanciés, autant que possible. En clair, éviter de mettre 
    Correction d'un problème important dans foobar.tml
  10. L'arborescence du site se trouve dans le fichier 00INDEX et le fichier 00TODO contient ce qui est en cours, avec diverses rubriques. Il est important que ces deux fichiers soient mis-à-jour.

Ne pas publier une page tout de suite

Vous pouvez décider de ne pas faire apparaître dans un premier temps vos nouvelles pages dans l'arbre de navigation qui se trouve sur la gauche des pages.

Pour cela, le script de génération des pages regarde dans chaque répertoire si un fichier nolinks s'y trouve. Ce fichier doit contenir une liste séparée par des espaces ou des retours à la ligne de choses de la forme « fichier » ou encore « répertoire/ ». Cela désactivera les liens éventuels vers la page fichier.html ou vers l'index de répertoire.

Par exemple, pour ne pas faire apparaître cette page de documentation interne aux tuteurs (et quelques autres) dans l'index, la racine du CVS contient : 

clipper ~tuteurs/www $ cat nolinks
doc-interne
aide
404
actualite
plan_site

Les fichiers nolinks peuvent être écrits directement, sans passer par CVS. Comme cela, sur votre copie de travail, vous avez tous les liens.

Quand vos pages sont prêtes, procédez en plusieurs étapes pour faire disparaître le fichier nolinks :

Vous trouverez des informations plus complètes sur la page de documentation interne avancée.

Auteurs : Joël Riou, Nicolas George et Éric Levieil. Dernière modification le .