agenda de Survie

l'agenda des évènements de Survie

Soumission d'évènement par script

Table des matières

• Principe
• Utilisation
• Questions ? Problèmes ?

Principe

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.

Ce script est disponible ici. Il utilise Python, et le module Curl pour Python (paquets Debian python2.3 et python2.3-pycurl ou python2.4 et python2.4-pycurl.

Utilisation

Il faut tout d'abord rédiger un document XML en prenant exemple sur celui-ci. Ce fichier XML doit contenir toutes les informations qui ne changent pas sur votre évènement. Les champs existants sont :

• title, 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 ;
• start-date, la date de début au format AAAA-MM-JJ ;
• end-date, la date de fin au format AAAA-MM-JJ ;
• start-hour, l'heure de début au format HH:MM ;
• end-hour, la fin de début au format HH:MM ;
• description, une description la plus complète possible. Elle peut contenir du formatage en HTML en utilisant les balises a (liens), b (gras), i (italique), ul et li (liste). Le texte de la description peut également contenir la chaîne $month, qui sera automatiquement remplacée par le mois du début de l'évènement, ou la chaîne $date qui sera remplacée par la date du début de l'évènement ;
• city, la ville où a lieu l'évènement ;
• region, la région où a lieu l'évènement ;
• url, un lien direct vers une page donnant des informations complémentaires sur l'évènement ;
• contact, une adresse e-mail de contact ;
• submitter, adresse e-mail de la la personne ayant proposé l'information (prend la valeur de contact si absent) ;
• tags, liste de tags séparés par des espaces.

Une fois ce fichier écrit, il suffit d'utiliser le script. Tout, d'abord, on passera un paramètre --file event.xml 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. Exceptions : si le champ end-date n'est pas spécifié, alors il prendra la valeur du champ start-date et si le champ submitter n'est pas spécifié, alors il prendra la valeur du champ contact.

Pour un évènement régulier (une fois par mois, par semaine), une utilisation typique sera de renseigner les champs title, start-hour, end-hour, description, city, region, url, contact, submitter et tags dans le fichier XML. On spécifiera alors la date sur la ligne de commande.

On peut tout d'abord vérifier que le formatage de la description de l'évènement est correct, en utilisant l'option --test-output. On peut ainsi générer un fichier HTML, que l'on pourra valider avec un navigateur Web.

./adl-submit.py --file event.xml --start-date 2006-01-23
                --test-output test.html

Une fois ceci fait, il reste plus qu'à soumettre l'évènement :

./adl-submit.py --file event.xml --start-date 2006-01-23

Questions ? Problèmes ?

Si vous avez des questions concernant son utilisation, vous pouvez contacter la liste de développement de l'Agenda du Libre, en vous inscrivant ici.