[Devel] r369 - trunk
svn at agendadulibre.org
svn at agendadulibre.org
Mer 27 Aou 22:02:45 CEST 2008
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 :</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>) :</p>
+
+<pre>
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<event>
+ <title>Gulliver - Permanence autour du libre</title>
+ <start-hour>19:00</start-hour>
+ <end-hour>22:00</end-hour>
+ <description><![CDATA[
+<p>L'association <a href="http://www.gulliver.eu.org">Gulliver</a>, groupe d'utilisateurs de logiciels libres d'Ille et Vilaine et des environs de Rennes, tient une permanence à la <a href="http://www.mce-info.org/">Maison de la consommation et de l'environnement</a>, 48 boulevard Magenta à Rennes, chaque vendredi à partir de 19h00. Une permanence aura donc lieu le $date.</p>
+
+<p>Cette permanence est ouverte à tous, membres de l'association ou non. On peut s'y <b>informer</b> sur les logiciels libres, en <b>tester</b>, amener sa machine pour une <b>installation</b>.</p>
+
+<p>Pour une installation ou tout type d'intervention, il est conseillé :</p> <ul> <li>de prévenir auparavant sur la <a href="http://gulliver.eu.org/ml/ml.html">liste de diffusion de Gulliver</a> ou sur l'adresse de contact en précisant sa demande, la configuration de sa machine ;</li> <li>de prendre connaissance de la <a href="http://gulliver.eu.org/wiki/charte3">Charte de Gulliver</a>.</li></ul>
+
+<p>Les <b>partages de compétences et d'expériences</b> complémentaires sur le libre sont tous les bienvenus.</p>
+
+<p>Une connexion Internet est disponible sur place. Accès par le côté ouest de la MCE (fond de la cour) ; demander la clef du parking à la permanence si besoin (transport de machine).</p>
+ ]]></description>
+ <city>Rennes</city>
+ <region>Bretagne</region>
+ <url>http://gulliver.eu.org/wiki/MCEPermanence</url>
+ <contact>contact at gulliver.eu.org</contact>
+ <submitter>contact at gulliver.eu.org</submitter>
+ <tags>gulliver permanence install-party</tags>
+</event>
+</pre>
+
+<p>Ce fichier XML doit contenir toutes les informations qui ne
+changent pas sur votre évènement. Les champs existants sont :</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 :</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 :</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 :</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
Plus d'informations sur la liste de diffusion Devel