[Devel] r369 - trunk

[svn AT agendadulibre.org]

Author: thomas
Date: Wed Aug 27 22:01:19 2008
New Revision: 369

Log:
Mise à jour de la documentation du script de soumission d'évènement,
et ajout d'une section expliquant comment soumettre un grand nombre
d'évènements.

Petite modification de la CSS pour donner les indications de rendu
d'un <pre>.



Modified:
   trunk/calendar.css
   trunk/submit-script-doc.php

Modified: trunk/calendar.css
==============================================================================
--- trunk/calendar.css  (original)
+++ trunk/calendar.css  Wed Aug 27 22:01:19 2008
@@ -115,6 +115,8 @@
 .main hr {     margin: 10px 20px;}
 
 .main p {      margin: 15px 0px; line-height: 1.3em;}
+
+.main pre {  text-align: left; background: #eeeeee; overflow: auto; width: 
60%; margin: auto; }
 /* Info box rss/ical */
 #important {
        position: absolute;

Modified: trunk/submit-script-doc.php
==============================================================================
--- trunk/submit-script-doc.php (original)
+++ trunk/submit-script-doc.php Wed Aug 27 22:01:19 2008
@@ -29,6 +29,17 @@
 
 <h2>Soumission d'�v�nement par script</h1>
 
+<h3>Table des mati�res</h3>
+
+<ul>
+ <li><a href="#principe">Principe</a></li>
+ <li><a href="#utilisation">Utilisation</a></li>
+ <li><a href="#bcp-evenements">Soumettre un grand nombre d'�v�nements
+ r�guliers</a></li>
+ <li><a href="#qa">Questions ? Probl�mes ?</a></li>
+</ul>
+
+<a name="principe"></a>
 <h3>Principe</h3>
 
 <p>Afin de faciliter la soumission d'�v�nement r�gulier, un
@@ -43,13 +54,41 @@
 <i>python2.3</i> et <i>python2.3-pycurl</i> ou <i>python2.4</i> et
 <i>python2.4-pycurl</i>.</p>
 
+<a name="utilisation"></a>
 <h3>Utilisation</h3>
 
-<p>Il faut tout d'abord r�diger un document XML en prenant exemple
-sur <a
-href="http://www.agendadulibre.org/svn/scripts/event.xml";>celui-ci</a>.
-Ce fichier XML doit contenir toutes les informations qui ne changent
-pas sur votre �v�nement. Les champs existants sont&nbsp;:</p>
+<p>Il faut tout d'abord r�diger un document XML dont voici un exemple
+(qui peut �galement �tre t�l�charg� <a
+href="http://www.agendadulibre.org/svn/scripts/event.xml";>ici</a>)&nbsp;:</p>
+
+<pre>
+&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
+&lt;event&gt;
+ &lt;title&gt;Gulliver - Permanence autour du libre&lt;/title&gt;
+ &lt;start-hour&gt;19:00&lt;/start-hour&gt;
+ &lt;end-hour&gt;22:00&lt;/end-hour&gt;
+ &lt;description&gt;&lt;![CDATA[
+&lt;p&gt;L'association &lt;a 
href="http://www.gulliver.eu.org"&gt;Gulliver&lt;/a&gt;, groupe 
d'utilisateurs de logiciels libres d'Ille et Vilaine et des environs de 
Rennes, tient une permanence � la &lt;a 
href="http://www.mce-info.org/"&gt;Maison de la consommation et de 
l'environnement&lt;/a&gt;, 48 boulevard Magenta � Rennes, chaque vendredi � 
partir de 19h00. Une permanence aura donc lieu le $date.&lt;/p&gt;
+  
+&lt;p&gt;Cette permanence est ouverte � tous, membres de l'association ou 
non. On peut s'y &lt;b&gt;informer&lt;/b&gt; sur les logiciels libres, en 
&lt;b&gt;tester&lt;/b&gt;, amener sa machine pour une 
&lt;b&gt;installation&lt;/b&gt;.&lt;/p&gt;
+
+&lt;p&gt;Pour une installation ou tout type d'intervention, il est 
conseill�&nbsp;:&lt;/p&gt; &lt;ul&gt; &lt;li&gt;de pr�venir auparavant sur la 
&lt;a href="http://gulliver.eu.org/ml/ml.html"&gt;liste de diffusion de 
Gulliver&lt;/a&gt; ou sur l'adresse de contact en pr�cisant sa demande, la 
configuration de sa machine&nbsp;;&lt;/li&gt; &lt;li&gt;de prendre 
connaissance de la &lt;a href="http://gulliver.eu.org/wiki/charte3"&gt;Charte 
de Gulliver&lt;/a&gt;.&lt;/li&gt;&lt;/ul&gt;
+
+&lt;p&gt;Les &lt;b&gt;partages de comp�tences et d'exp�riences&lt;/b&gt; 
compl�mentaires sur le libre sont tous les bienvenus.&lt;/p&gt;
+
+&lt;p&gt;Une connexion Internet est disponible sur place. Acc�s par le c�t� 
ouest de la MCE (fond de la cour)&nbsp;; demander la clef du parking � la 
permanence si besoin (transport de machine).&lt;/p&gt;
+ ]]&gt;&lt;/description&gt;
+ &lt;city&gt;Rennes&lt;/city&gt;
+ &lt;region&gt;Bretagne&lt;/region&gt;
+ &lt;url&gt;http://gulliver.eu.org/wiki/MCEPermanence&lt;/url&gt;
+ &lt;contact&gt;contact AT gulliver.eu.org&lt;/contact&gt;
+ &lt;submitter&gt;contact AT gulliver.eu.org&lt;/submitter&gt;
+ &lt;tags&gt;gulliver permanence install-party&lt;/tags&gt;
+&lt;/event&gt;
+</pre>
+
+<p>Ce fichier XML doit contenir toutes les informations qui ne
+changent pas sur votre �v�nement. Les champs existants sont&nbsp;:</p>
 
 <ul>
 
@@ -95,6 +134,23 @@
  <li><b>tags</b>, liste de tags s�par�s par des espaces.</li>
 </ul>
 
+<p>Des remplacements de texte sont �galement faits dans la
+description&nbsp;:</p>
+
+<ul>
+
+ <li><b>$month</b> est remplac� par le mois o� aura lieu l'�v�nement
+ (en toutes lettres: janvier, f�vrier, mars, etc.)</li>
+
+ <li><b>$date</b> est remplac� par la date o� aura lieu l'�v�nement,
+ sous la forme � 24 janvier �</li>
+
+</ul>
+
+<p>Ces remplacements servent � cr�er des fichiers XML g�n�riques, qui
+pourront �tre utilis�s pour un �v�nement qui se r�p�te dans le
+temps.</p>
+
 <p>Une fois ce fichier �crit, il suffit d'utiliser le script. Tout,
 d'abord, on passera un param�tre <code>--file event.xml</code> pour
 sp�cifier le fichier XML pr�c�dement cr��. On passera
@@ -133,6 +189,68 @@
 ./adl-submit.py --file event.xml --start-date 2006-01-23
 </pre>
 
+<a name="bcp-evenements"></a>
+<h3>Soumettre un grand nombre d'�v�nements r�guliers</h3>
+
+<p>Un cas d'utilisation typique du script est l'ajout d'un grand
+nombre d'�v�nements r�guliers, par exemple les rencontres ou les repas
+d'un groupe d'utilisateur, dont les dates sont pr�vues longtemps �
+l'avance.</p>
+
+<p>Tout d'abord, pr�parez un fichier XML avec tous les champs, sauf
+<b>start-date</b> et <b>end-date</b>. Le texte de la description
+utilisera avec int�r�t les mots cl�s <b>$date</b> ou <b>$month</b> qui
+seront automatiquement remplac�s par la date ou le mois de
+l'�v�nement.</p>
+
+<p>Une fois ce fichier XML pr�t, validez que le r�sultat est correct,
+en utilisant l'option <code>--test-output</code>. Vous pouvez
+�galement l'envoyer aux mod�rateurs de l'Agenda du Libre
+(<code>moderateurs AT agendadulibre.org</code>) pour qu'ils valident la
+description: ainsi, lors de la soumission, vous serez s�r que tous les
+�v�nements seront valid�s d'un seul coup.</p>
+
+<p>Les v�rifications �tant faites, cr�ez un fichier texte, s'appelant
+par exemple <code>liste-dates</code>, contenant les dates de tous les
+�v�nements, sous la forme&nbsp;:</p>
+
+<pre>
+2008-09-10
+2008-09-24
+2008-10-08
+2008-10-22
+2008-11-12
+2008-11-26
+2008-12-03
+2008-12-17
+2009-01-07
+2009-01-21
+2009-02-04
+2009-02-25
+2009-03-11
+2009-03-25
+2009-04-22
+2009-05-06
+2009-05-20
+2009-06-03
+2009-06-17
+</pre>
+
+<p>Puis, gr�ce � la magie du shell, on va ex�cuter le script de
+soumission d'�v�nements autant de fois que n�cessaire&nbsp;:</p>
+
+<pre>
+for date in $(cat liste-dates) ; do
+ ./adl-submit.py --file event.xml --start-date $date ;
+done
+</pre>
+
+<p>Et le tour est jou�. Lorsque les �v�nements seront valid�s, vous
+recevrez un courrier �lectronique de notification, contenant notamment
+les instructions pour �diter ou annuler un �v�nement si cela s'av�rait
+n�cessaire.</p>
+
+<a name="qa"></a>
 <h3>Questions ? Probl�mes ?</h3>
 
 <p>Si vous avez des questions concernant son utilisation, vous pouvez