tuteurs.ens.fr/doc-interne.tml

203 lines
6.7 KiB
Text
Raw Normal View History

<?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 <20> 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<69>s dans la suite sont dans
<code>~tuteurs/bin</code>. <20>ditez le fichier <code> .profile </code> <20>
la racine de votre compte, trouvez le passage qui parle du PATH et
modifiez la fin. Attention, ne pas oublier de mettre&nbsp;:\ (non suivi
d'espace&nbsp;!) <20> la fin de l'avant-derni<6E>re ligne, et de tester (en
vous logguant une deuxi<78>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<63>er un r<>pertoire de travail</h3>
2002-12-06 18:19:11 +01:00
<p>
Tout d'abord, cr<63>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>.
2002-12-06 18:19:11 +01:00
</p>
<p>Tapez les commandes suivantes:
2002-11-16 19:28:04 +01:00
</p>
<pre>
<span class="prompt"> teck ~/tuteurs/cvs $</span><3E>cvstuteurs checkout web
<span class="prompt"> teck ~/tuteurs/cvs $</span><3E>cd web
<span class="prompt"> teck ~/tuteurs/cvs/web $</span><3E>rebuild .
</pre>
<h3><3E>crire une nouvelle page (ou la modifier)</h3>
<p>Prenons un exemple. Supposons que vous souhaitiez <20>crire la page
<code>unix/accents.html</code>. Pour cela, il va falloir <20>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 ~/tuteurscvs/web $</span><3E>cvstuteurs update
</pre>
</li>
<li>Pour commencer <20> travailler sur ce nouveau fichier, faites<65>:
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span><3E>cd unix
<span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span> tmltemplate accents.tml <em>"titre court"</em><3E><em>"titre long"</em><3E>
<span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span><3E>cvstuteurs add accents.tml
<span class="prompt"> teck ~/tuteurs/cvs/web/unix $</span><3E>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<72>tra dans l'arborescence du
site <20> gauche des pages (choississez-le concis, car l'arbre de navigation
est <20>troit), le <em>titre long</em> sera <20>crit en gros en
haut de la page.
<p>Pour ajouter des fichiers binaires (par exemple des images), il faut
taper&nbsp;:</p>
<pre>
<span class="prompt"> teck ~/tuteurs/cvs/web/unix
$</span> <code>cvstuteurs add -kb foobar.png </code>.
</pre>
</li>
<li><3E>crivez le contenu du fichier. Ce dernier sera pass<73> dans une moulinette
qui s'appelle <code>xsltproc</code> qui rajoute automatiquement
un plan du site <20> gauche et un sommaire de la page en cours de lecture.
Les liens internes <20> la page des tuteurs doivent <20>tre sous la forme:
<!-- <blockquote><p> -->
<pre>
&lt; a href="&amp;url.tuteurs;docs/hublot/typo.html"&gt;
</pre>
<!-- </p></blockquote> -->
2002-12-06 18:19:11 +01:00
Il faut mettre <20> la fin du fichier des lignes du type:
<pre>
&lt;div class="metainformation"&gt;
Auteur<EFBFBD>: Comptes tuteurs.
Derni<EFBFBD>re modification le &lt;date value="$Date: 2007-07-05 13:32:08 $" /&gt;.
&lt;/div&gt;
</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<6C>accents.tml
</pre> </li>
<li> Si vous avez fait beaucoup de modifications, il peut <20>tre utile de
retourner dans le r<>pertoire <code>web/</code> et de taper&nbsp;::
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span><3E>rebuild .
</pre></li>
<li> Passer la page que vous venez de cr<63>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 <20><>commiter<65><72> en faisant (depuis le
r<>pertoire <code>web/</code>)&nbsp;:
<pre><span class="prompt"> teck ~/tuteurs/cvs/web $</span><3E>make install
</pre></li>
<li>
On vous demandera
d'indiquer des commentaires sur les man&#339;uvres que vous avez faites
dans les diff<66>rents r<>pertoires. Il est extr<74>mement important que ceux-ci
soient pr<70>cis et circonstanci<63>s, autant que possible. En clair, <20>viter de
mettre
<pre>Correction d'un probl<62>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-<2D>-jour.</li>
</ol>
<h4>Ne pas publier une page tout de suite</h4>
<p>Vous pouvez d<>cider de ne pas faire appara<72>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<EFBFBD>ration des pages regarde dans chaque
r<EFBFBD>pertoire si un fichier <code>nolinks</code> s'y trouve. Ce fichier doit
contenir une liste s<>par<61>e par des espaces ou des retours <20> la ligne de
choses de la forme <20><><code>fichier</code><3E><> ou encore
<EFBFBD><EFBFBD><code>r<>pertoire/</code><3E><>. Cela d<>sactivera les liens <20>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<72>tre cette page de documentation
interne aux tuteurs (et quelques autres) dans l'index, la racine du
<code>CVS</code> contient<6E>:
</p>
<pre><span class="prompt">clipper ~tuteurs/www $</span><3E>cat nolinks
doc-interne
aide
404
actualite
plan_site
</pre>
<p>
Les fichiers <code>nolinks</code> peuvent <20>tre <20>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<70>tes, proc<6F>dez en plusieurs <20>tapes pour faire
dispara<EFBFBD>tre le fichier <code>nolinks</code><3E>:</p>
<ul>
<li><3E>ditez-le pour qu'<27>l devienne vide<64>;</li>
<li>Reg<65>n<EFBFBD>rez les pages avec <code>rebuild</code><3E>(ou <code>make
install</code>)<29>;</li>
<li>Effacez le fichier <code>nolinks</code>.</li>
</ul>
<p> Vous trouverez des informations plus compl<70>tes sur la page de
<a href="doc-interne-avancee.html">documentation interne avanc<6E>e</a>.
</p>
<div class="metainformation">
Auteurs : Jo<4A>l Riou, Nicolas George et <20>ric Levieil.
Derni<EFBFBD>re modification le <date value="$Date: 2007-07-05 13:32:08 $" />.
</div>
</body>
</html>