cbbe543fce
Remplacement de toutes les phrases du style « Dernière modification le ... [par ...] » par <date value="from git" />, qui produit une phrase du genre à partir de l'historique du dépôt. Le « from git » n'a pas d'importance, c'est juste parce que la DTD de TML (que je préfère ne pas changer) exige un attribut value. Last-change: ignore this commit
194 lines
6.6 KiB
XML
194 lines
6.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html
|
||
PUBLIC "-//ENS/Tuteurs//DTD TML 1//EN"
|
||
"tuteurs://DTD/tml.dtd">
|
||
<html>
|
||
<head>
|
||
<title>Doc. interne</title>
|
||
</head>
|
||
<body>
|
||
|
||
<h1>Comment mettre à jour le site des tuteurs ou y ajouter du contenu?</h1>
|
||
|
||
<p> 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 <code>~tuteurs/bin</code> contient plusieurs commandes
|
||
utiles pour travailler avec les fichiers TML.
|
||
On ne travaille pas directement dans <code>~tuteurs/www</code> :
|
||
tout le contenu du site est sous <a href="logiciels/git/">git</a>,
|
||
et l'arborescence HTML est mise à jour automatiquement à chaque
|
||
<code>push</code> (de la branche qui va bien) dans
|
||
<code>~tuteurs/www.git</code>.
|
||
</p>
|
||
|
||
<h2> Rajouter <code>~tuteurs/bin</code> dans votre <code>PATH</code></h2>
|
||
|
||
<p>
|
||
La plupart des programmes utilisés dans la suite sont dans
|
||
<code>~tuteurs/bin</code>. Éditez le fichier <code> .profile </code> à
|
||
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) <em>avant</em> de se délogguer.
|
||
</p>
|
||
|
||
<pre>
|
||
PATH=\
|
||
$HOME/bin/$SYSTEMNAME:\
|
||
$HOME/bin:\
|
||
$UTILPATH:\
|
||
$MAINPATH:\
|
||
$GAMESPATH:\
|
||
$MISCPATH:\
|
||
/users/staffs/tuteurs/bin
|
||
</pre>
|
||
|
||
<h2> Récupérer une copie de travail </h2>
|
||
|
||
<p>
|
||
Le site web des
|
||
<a href="logiciels/git/">git</a>. Je ne réexplique pas comment se
|
||
servir de git ici, allez voir la page qu'on a déjà à ce sujet...
|
||
</p>
|
||
|
||
<p>
|
||
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
|
||
</p>
|
||
<pre><span class="prompt">$</span> git clone tuteurs@clipper:www.git </pre>
|
||
<p class="continue">
|
||
Cependant, depuis les machines de l'école, on peut aussi faire
|
||
directement
|
||
</p>
|
||
<pre><span class="prompt">$</span> git clone ~tuteurs/www.git </pre>
|
||
<p class="continue">
|
||
sans clé ssh — du moins, il y a une magouille dans le Makefile qui
|
||
essaie de faire en sorte que ça marche.
|
||
</p>
|
||
|
||
<h2>Écrire une nouvelle page (ou la modifier)</h2>
|
||
|
||
<p>
|
||
Supposons que vous souhaitiez créer ou modifier la page
|
||
<code>unix/accents.html</code>. Pour cela, il va falloir écrire un
|
||
fichier <code>unix/accents.tml</code>. </p>
|
||
|
||
<ul>
|
||
<li>
|
||
Commencez par synchroniser votre répertoire de travail avec le dépôt :
|
||
<pre><span class="prompt">$</span> git pull</pre>
|
||
</li>
|
||
<li>
|
||
Si <code>unix/accents.html</code> n'existe pas déjà, créez-le :
|
||
<pre><span class="prompt">$</span> cd unix
|
||
<span class="prompt">$</span> tmltemplate accents.tml <em>"titre court"</em> <em>"titre long"</em>
|
||
<span class="prompt">$</span> emacs accents.tml</pre>
|
||
Le <em>titre court</em> est celui qui apparaîtra dans l'arborescence du
|
||
site à gauche des pages (choississez-le concis, car l'arbre de
|
||
navigation est étroit), le <em>titre long</em> sera écrit en gros en
|
||
haut de la page. Pour modifier un fichier existant, idem sauf le
|
||
<code>tmltemplate</code>.
|
||
</li>
|
||
<li>
|
||
Écrivez le contenu du fichier. Ce dernier sera passé dans une
|
||
moulinette qui s'appelle <code>xsltproc</code> 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:
|
||
<pre><a href="&url.tuteurs;docs/hublot/typo.html"></pre>
|
||
Il faut mettre à la fin du fichier des lignes du type:
|
||
<pre><div class="metainformation">
|
||
Auteur : Comptes tuteurs.
|
||
Dernière modification le <date value="$Date: 2008-10-05 11:20:36 $" />.
|
||
</div></pre>
|
||
Pour le reste, c'est du XHTML 1.0 Strict. Vous pouvez vous aider du
|
||
<a href="&url.tuteurs;internet/web/html/">tutoriel XHTML</a> des
|
||
tuteurs.
|
||
</li>
|
||
|
||
<li> Vérifiez votre page avec :
|
||
<pre><span class="prompt">$</span> tmlcheck accents.tml</pre>
|
||
</li>
|
||
|
||
<li>
|
||
Lancez le script de conversion en <code>.html</code> en faisant :
|
||
<pre><span class="prompt">$</span> build accents.tml</pre>
|
||
Si vous avez fait beaucoup de modifications, il peut être utile de
|
||
lancer
|
||
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span> rebuild .</pre>
|
||
à la racine de votre copie de travail.</li>
|
||
|
||
<li>
|
||
Passez la page que vous venez de créer au <a
|
||
href="http://validator.w3.org/">validateur</a>.
|
||
</li>
|
||
|
||
<li id="makeinstall">
|
||
Quand vous avez terminé une modification, vous pouvez « commiter »
|
||
en faisant :
|
||
<pre>
|
||
<span class="prompt">$</span> git add accents.tml
|
||
<span class="prompt">$</span> git commit
|
||
</pre>
|
||
Tâchez de mettre un commentaire explicite.
|
||
</li>
|
||
|
||
<li>
|
||
Répétez ce qui précède autant de fois que nécessaire. À la fin,
|
||
installez vos modifications sur le site web avec
|
||
<pre><span class="prompt">$</span> make install</pre>
|
||
(essentiellement équivalent à <code>git push</code>).
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
<h2> Astuces plus avancées </h2>
|
||
|
||
<h3>Ne pas publier une page tout de suite</h3>
|
||
|
||
<p>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.</p>
|
||
|
||
<p>Pour cela, le script de génération des pages regarde dans chaque
|
||
répertoire si un fichier <code>nolinks</code> 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 « <code>fichier</code> » ou encore
|
||
« <code>répertoire/</code> ». Cela désactivera les liens éventuels vers
|
||
la page <code>fichier.html</code> ou vers l'index de
|
||
<code>répertoire</code>.</p>
|
||
|
||
<p>Par exemple, pour ne pas faire apparaître cette page de documentation
|
||
interne aux tuteurs (et quelques autres) dans l'index, la racine du
|
||
<code>CVS</code> contient :
|
||
</p>
|
||
|
||
<pre><span class="prompt">clipper ~tuteurs/www $</span> cat nolinks
|
||
doc-interne
|
||
aide
|
||
404
|
||
actualite
|
||
plan_site
|
||
</pre>
|
||
|
||
<p>Quand vos pages sont prêtes, procédez en plusieurs étapes pour faire
|
||
disparaître le fichier <code>nolinks</code> :</p>
|
||
|
||
<ul>
|
||
<li>Éditez-le pour qu'íl devienne vide ;</li>
|
||
<li>Regénérez les pages avec <code>rebuild</code> (ou <code>make
|
||
install</code>) ;</li>
|
||
<li>Effacez le fichier <code>nolinks</code>.</li>
|
||
</ul>
|
||
|
||
<h3> Branches </h3>
|
||
|
||
|
||
<div class="metainformation">
|
||
Auteurs : Joël Riou, Nicolas George, Éric Levieil, Marc Mezzarobba.
|
||
<date value="from git" />
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|