[Devel] r137 - trunk

[thomas AT lolut.utbm.info]

Author: thomas
Date: 2006-01-15 22:25:50 +0100 (Sun, 15 Jan 2006)
New Revision: 137

Added:
   trunk/submit-script-doc.php
Modified:
   trunk/infos.php
   trunk/submit.php
Log:
Documentation du script + mention du script dans la page de soumission + mise 
a jour du changelog.

Modified: trunk/infos.php
===================================================================
--- trunk/infos.php     2006-01-15 20:16:07 UTC (rev 136)
+++ trunk/infos.php     2006-01-15 21:25:50 UTC (rev 137)
@@ -286,6 +286,21 @@
   </ul>
  </li>
 
+ <li>21/12/2005
+  <ul>
+   <li>Ajout d'une CSS alternative propos�e par <i>Air1</i></li>
+  </ul>
+ </li>
+
+ <li>11/01/2006-15/01/2006
+  <ul>
+   <li>Ajout d'une bo�te de recommandations sur la page de <a 
href="submit.php">soumission d'un �v�nement</a></li>
+   <li>Correction de probl�mes avec Internet Explorer au niveau de la carte 
et de la feuille CSS</li>
+   <li>Affichage des LUGs de la r�gion dans la carte, et lors de la 
consultation des informations sur un �v�nment</li>
+   <li>Ajout d'une page de <a href="stats.php">statistiques</a></li>
+   <li>Am�lioration du script de soumission et r�daction d'une <a 
href="submit-script-doc.php">documentation</a></li>
+  </ul>
+
 </ul>
 
 <?php //'

Added: trunk/submit-script-doc.php
===================================================================
--- trunk/submit-script-doc.php 2006-01-15 20:16:07 UTC (rev 136)
+++ trunk/submit-script-doc.php 2006-01-15 21:25:50 UTC (rev 137)
@@ -0,0 +1,121 @@
+<?php
+
+/* Copyright 2004
+ * - M�lanie Bats <melanie POINT bats CHEZ utbm POINT fr>
+ * - Thomas Petazzoni <thomas POINT petazzoni CHEZ enix POINT org>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+ * 02111-1307, USA.
+ */
+
+include("bd.inc.php");
+include("funcs.inc.php");
+
+put_header ("Agenda du Libre - Soumission d'�v�nement");
+
+?>
+
+<h2>Soumission d'�v�nement par script</h1>
+
+<h3>Principe</h3>
+
+<p>Afin de faciliter la soumission d'�v�nement r�gulier, un
+petit script vous est propos�. � partir de la description d'un
+�v�nement dans un fichier XML et d'informations donn�es sur
+la ligne de commande, il permet de soumettre automatiquement un
+�v�nement dans l'Agenda du Libre.</p>
+
+<p>Ce script est disponible <a
+href="http://www.agendadulibre.org/svn/scripts/adl-submit.py";>ici</a>.
+Il utilise Python, et le module Curl pour Python (paquets Debian
+<i>python2.3</i> et <i>python2.3-pycurl</i> ou <i>python2.4</i> et
+<i>python2.4-pycurl</i>.</p>
+
+<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>
+
+<ul>
+
+ <li><b>title</b>, le titre de l'�v�nement, sans le nom du lieu
+ ni la date. Il doit faire en g�n�ral moins de cinq
+ mots&nbsp;;</li>
+
+ <li><b>start-date</b>, la date de d�but au format
+ <code>AAAA-MM-JJ</code>&nbsp;;</li>
+
+ <li><b>end-date</b>, la date de fin au format
+ <code>AAAA-MM-JJ</code>&nbsp;;</li>
+
+ <li><b>start-hour</b>, l'heure de d�but au format
+ <code>HH:MM</code>&nbsp;;</li>
+
+ <li><b>end-hour</b>, la fin de d�but au format
+ <code>HH:MM</code>&nbsp;;</li>
+
+ <li><b>description</b>, une description la plus compl�te
+ possible. Elle peut contenir du formatage en HTML en utilisant les
+ balises <i>a</i> (liens), <i>b</i> (gras), <i>i</i> (italique),
+ <i>ul</i> et <i>li</i> (liste)&nbsp;;</li>
+
+ <li><b>city</b>, la ville o� a lieu l'�v�nement&nbsp;;</li>
+
+ <li><b>region</b>, la r�gion o� a lieu
+ l'�v�nement&nbsp;;</li>
+
+ <li><b>url</b>, un lien direct vers une page donnant des informations
+ compl�mentaires sur l'�v�nement&nbsp;;</li>
+
+ <li><b>contact</b>, une adresse e-mail de contact&nbsp;;</li>
+
+</ul>
+
+<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
+�galement en param�tre toutes les informations manquantes dans
+le fichier XML. Les options ont le m�me nom que les champs du
+fichier XML. Si une option est fournie alors que le champ existe dans
+le fichier XML, alors la valeur de l'option sera pr�f�r�e
+� la valeur du fichier XML. Au total, entre les options de la ligne
+de commande et les valeurs du fichier, tous les champs doivent �tre
+remplis pour que la soumission fonctionne. � une exception
+pr�s&nbsp;: si le champ <b>end-date</b> n'est pas sp�cifi�,
+alors il prendra la valeur du champ <b>start-date</b>.</p>
+
+<p>Pour un �v�nement r�gulier (une fois par mois, par
+semaine), une utilisation typique sera de renseigner les champs
+<i>title</i>, <i>start-hour</i>, <i>end-hour</i>, <i>description</i>,
+<i>city</i>, <i>region</i>, <i>url</i> et <i>contact</i> dans le
+fichier XML. On sp�cifiera alors la date sur la ligne de
+commande&nbsp;:</p>
+
+<pre>
+./adl-submit.py --file event.xml --start-date 2006-01-23
+</pre>
+
+<h3>Questions ? Probl�mes ?</h3>
+
+<p>Si vous avez des questions concernant son utilisation, vous pouvez
+contacter la liste de d�veloppement de l'Agenda du Libre, en vous
+<a
+href="http://lolut.utbm.info/cgi-bin/mailman/listinfo/devel";>inscrivant
+ici</a>.</p>
+
+<?php put_footer(); ?>

Modified: trunk/submit.php
===================================================================
--- trunk/submit.php    2006-01-15 20:16:07 UTC (rev 136)
+++ trunk/submit.php    2006-01-15 21:25:50 UTC (rev 137)
@@ -238,6 +238,11 @@
 lisibilit� sera meilleure pour les utilisateurs de l'Agenda du
 Libre.</p>
 
+<p>Si vous soumettez souvent un �v�nement r�gulier dans
+l'Agenda du Libre, vous pouvez automatiser cette proc�dure �
+l'aide d'un <a href="submit-script-doc.php">script que nous vous
+proposons</a>.</p>
+
 <ul>
 
  <li>Le texte des �v�nements doit �tre r�dig� en