e0b5ac496f
coquilles dans la doc interne. Par ailleurs, il semble y avoir un probleme vers la fin de meta/plan_site.html, mais je n'ai pas essaye de corriger ca; je ne m'y connais pas assez pour comprendre ce qu'il faut faire.
201 lines
6.7 KiB
XML
201 lines
6.7 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||
<!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>
|
||
|
||
<h3> Rajouter <code>~tuteurs/bin</code> dans votre <code>PATH</code></h3>
|
||
|
||
<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>
|
||
|
||
|
||
<h3>Se créer un répertoire de travail</h3>
|
||
|
||
<p>
|
||
Tout d'abord, créez-vous un répertoire de travail sur votre compte avec
|
||
<code>mkdir</code>. Par la suite, nous supposerons que ce répertoire
|
||
s'appelle <code> tuteurs/cvs</code>.
|
||
</p>
|
||
|
||
<p>Tapez les commandes suivantes:
|
||
</p>
|
||
<pre>
|
||
<span class="prompt"> teck ~/tuteurs/cvs $</span> cvstuteurs checkout web
|
||
<span class="prompt"> teck ~/tuteurs/cvs $</span> cd web
|
||
<span class="prompt"> teck ~/tuteurs/cvs/web $</span> rebuild .
|
||
</pre>
|
||
|
||
<h3>Écrire une nouvelle page (ou la modifier)</h3>
|
||
|
||
<p>Prenons un exemple. Supposons que vous souhaitiez écrire la page
|
||
<code>unix/accents.html</code>. Pour cela, il va falloir écrire
|
||
un fichier <code>unix/accents.tml</code>.
|
||
</p>
|
||
<ol>
|
||
<li>
|
||
Commencez par synchroniser votre répertoire de travail avec le repository:
|
||
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span> cvstuteurs update
|
||
</pre>
|
||
</li>
|
||
<li>Pour commencer à travailler sur ce nouveau fichier, faites :
|
||
|
||
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span> cd unix
|
||
<span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span> tmltemplate accents.tml <em>"titre court"</em> <em>"titre long"</em>
|
||
<span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span> cvstuteurs add accents.tml
|
||
<span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span> emacs accents.tml
|
||
</pre>
|
||
|
||
Si vous voulez modifier un fichier existant, il ne faut pas taper les
|
||
commandes du milieu.
|
||
|
||
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.
|
||
|
||
<p>Pour ajouter des fichiers binaires (par exemple des images), il faut
|
||
taper :</p>
|
||
<pre>
|
||
<span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span> <code>cvstuteurs add -kb foobar.png </code>
|
||
</pre>
|
||
</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:
|
||
<!-- <blockquote><p> -->
|
||
<pre>
|
||
<a href="&url.tuteurs;docs/hublot/typo.html">
|
||
</pre>
|
||
<!-- </p></blockquote> -->
|
||
|
||
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"> teck ~/tuteurs/cvs/web/unix $</span> tmlcheck accents.tml
|
||
</pre></li>
|
||
|
||
<li> Lancez le script de conversion en <code>.html</code> en faisant :
|
||
<pre><span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span> build accents.tml
|
||
</pre> </li>
|
||
|
||
<li> Si vous avez fait beaucoup de modifications, il peut être utile de
|
||
retourner dans le répertoire <code>web/</code> et de taper :
|
||
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span> rebuild .
|
||
</pre></li>
|
||
|
||
<li> Passer la page que vous venez de créer au <a
|
||
href="http://validator.w3.org/">validateur</a>.
|
||
</li>
|
||
|
||
<li><a name="makeinstall" id="makeinstall"></a>
|
||
Quand tout est au point, vous pouvez « commiter » en faisant (depuis le
|
||
répertoire <code>web/</code>) :
|
||
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span> make install
|
||
</pre></li>
|
||
|
||
<li>
|
||
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
|
||
<pre>Correction d'un problème important dans foobar.tml</pre></li>
|
||
|
||
<li>L'arborescence du site se trouve dans le fichier
|
||
<code>00INDEX</code> et le fichier <code>00TODO</code> contient ce qui
|
||
est en cours, avec diverses rubriques. Il est important que ces deux
|
||
fichiers soient mis-à-jour.</li>
|
||
|
||
</ol>
|
||
|
||
<h4>Ne pas publier une page tout de suite</h4>
|
||
|
||
<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>
|
||
Les fichiers <code>nolinks</code> peuvent être écrits directement, sans
|
||
passer par <code>CVS</code>. Comme cela, sur votre copie
|
||
de travail, vous avez tous les liens.
|
||
</p>
|
||
|
||
<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>
|
||
|
||
<p> Vous trouverez des informations plus complètes sur la page de
|
||
<a href="doc-interne-avancee.html">documentation interne avancée</a>.
|
||
</p>
|
||
|
||
<div class="metainformation">
|
||
Auteurs : Joël Riou, Nicolas George et Éric Levieil.
|
||
Dernière modification le <date value="$Date: 2008-10-05 11:20:36 $" />.
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|