diff --git a/doc-interne.tml b/doc-interne.tml index 7e90fae..e2f65f9 100644 --- a/doc-interne.tml +++ b/doc-interne.tml @@ -8,9 +8,20 @@ -

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

+

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

-

Rajouter ~tuteurs/bin dans votre PATH

+

En bref : les pages HTML du site web des tuteurs sont produites + à partir de fichiers dans un format XML maison appelé TML. Le + répertoire ~tuteurs/bin contient plusieurs commandes + utiles pour travailler avec les fichiers TML. + On ne travaille pas directement dans ~tuteurs/www : + tout le contenu du site est sous git, + et l'arborescence HTML est mise à jour automatiquement à chaque + push (de la branche qui va bien) dans + ~tuteurs/www.git. +

+ +

Rajouter ~tuteurs/bin dans votre PATH

La plupart des programmes utilisés dans la suite sont dans @@ -32,121 +43,109 @@ $MISCPATH:\ /users/staffs/tuteurs/bin - -

Se créer un répertoire de travail

+

Récupérer une copie 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. + Le site web des + git. Je ne réexplique pas comment se + servir de git ici, allez voir la page qu'on a déjà à ce sujet...

-

Tapez les commandes suivantes: +

+ La première chose à faire pour modifier le site est donc de cloner le + dépôt git. La meilleure façon est de commencer par mettre une clé ssh + chez tuteurs (si on n'en a pas déjà) puis de faire

- 
- 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. +

$ git clone tuteurs@clipper:www.git
+

+ Cependant, depuis les machines de l'école, on peut aussi faire + directement

-
    -
  1. -Commencez par synchroniser votre répertoire de travail avec le repository: -
     teck ~/tuteurs/cvs/web $ cvstuteurs update
-
    -
    2. -
  2. Pour commencer à travailler sur ce nouveau fichier, faites : +
    $ git clone ~tuteurs/www.git
    +

    + sans clé ssh — du moins, il y a une magouille dans le Makefile qui + essaie de faire en sorte que ça marche. +

    + +

    Écrire une nouvelle page (ou la modifier)

    -
     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
-
    +

    + Supposons que vous souhaitiez créer ou modifier la page + unix/accents.html. Pour cela, il va falloir écrire un + fichier unix/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. - -
  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">
+
      
+  
    • 
+    Commencez par synchroniser votre répertoire de travail avec le dépôt :
+    
      $ git pull
      
+  
      • 
+  
    • 
+    Si unix/accents.html n'existe pas déjà, créez-le :
+    
      $ cd unix
+      $ tmltemplate accents.tml "titre court" "titre long" 
+      $ emacs accents.tml
      
+    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 modifier un fichier existant, idem sauf le
+    tmltemplate. 
+  
      • 
+  
    • 
+    É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.
-
      • 
+</div>
    + Pour le reste, c'est du XHTML 1.0 Strict. Vous pouvez vous aider du + tutoriel XHTML des + tuteurs. +
    4. -
  4. Vérifiez votre page avec : -
     teck ~/tuteurs/cvs/web/unix $ tmlcheck accents.tml
-
    5. +
  5. Vérifiez votre page avec : + 
    $ tmlcheck accents.tml
    +
    6. -
  6. Lancez le script de conversion en .html en faisant : -
     teck ~/tuteurs/cvs/web/unix $ build accents.tml
-
    7. +
  7. + Lancez le script de conversion en .html en faisant : + 
    $ build accents.tml
    + Si vous avez fait beaucoup de modifications, il peut être utile de + lancer + 
     teck ~/tuteurs/cvs/web $ rebuild .
    + à la racine de votre copie de travail.
    8. -
  8. 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 .
-
    9. - -
  9. Passer la page que vous venez de créer au validateur. -
    10. +
  10. + Passez la page que vous venez de créer au validateur. +
    11. -
  11. -Quand tout est au point, vous pouvez « commiter » en faisant (depuis le - répertoire web/) : -
     teck ~/tuteurs/cvs/web $ make install
-
    12. +
  12. + Quand vous avez terminé une modification, vous pouvez « commiter » + en faisant : + 
    +$ git add accents.tml
+$ git commit
+
    + Tâchez de mettre un commentaire explicite. +
    13. -
  13. -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
    14. +
  14. + Répétez ce qui précède autant de fois que nécessaire. À la fin, + installez vos modifications sur le site web avec + 
    $ make install
    + (essentiellement équivalent à git push). +
    15. -
  15. 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.
    16. + -
+

Astuces plus avancées

-

Ne pas publier une page tout de suite

+

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 @@ -165,35 +164,29 @@ interne aux tuteurs (et quelques autres) dans l'index, la racine du CVS contient :

- 
clipper ~tuteurs/www $ cat nolinks
+
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.
-

+
+
+
 Branches 

+
 
 

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