[sympa-fr] Analyse pour la création de famille et génération automatique de listes

[Gwenaelle Bouteille <adresse@cachée>]

Voici une documentation qui peut aider les utilisateurs de Sympa mettant en place les familles, pour la génération de grands nombre de listes. Ce document permet de faire l'analyse des besoins pour définir le contenu des fichiers d'une famille.

--
Signature

Gwenaelle Bouteille

Title: Analyse pour la création de famille et génération automatique de listes

Analyse pour la création de famille et génération automatique de listes

Copyright © 23 septembre 2005 Gwénaëlle Bouteille

---

1. Définir le contenu des fichiers d'une famille

1.1. Définition des valeurs par défaut

1.2. Définition du degré de liberté

1.3. Scenario d'autorisation

1.4. Autres fichiers personnalisables

2. Fichiers personnalisables dans Sympa

Introduction. Ce document est une aide pour l'analyse des besoins lors de la création de famille pour la génération automatique de listes. Pour des informations plus techniques, consultez la documentation de sympa, chapitre "lists families".

1. Définir le contenu des fichiers d'une famille

Pour créer une famille , il faut fournir deux fichiers indispensables : le config.tt2 et le param_constraint.conf. On peut aussi fournir un edit_list.conf et des fichiers personnalisables (scenario et templates web ou mail). Lors de l'instanciation, il faut fournir un fichier xml décrivant l'aspect variable des listes par rapport à la famille. Voici une méthode pour définir le contenu de ces fichiers :

Il faut commencer par faire la liste des paramètres de listes qui vont être utiles aux besoins (cf documentation de sympa , chapitre "List configuration parameters"). Ces paramètres pourront être mis dans un tableau tel que celui ci :

1.1. Définition des valeurs par défaut

Les valeurs par défaut des paramètres de liste sont définies par le fichier de configuration de la liste lors de sa création. Lors de l'instanciation de famille, celui-ci est construit à partir du fichier config.tt2 et du fichier xml d'instanciation (cf documentation de sympa, chapitre "Lists families", Using family) :

• a : on définit la valeur par défaut du paramètre : soit elle est constante d'une liste à l'autre, soit elle varie. D ans ce dernier cas les valeurs propres à chacune des listes devront être fournies dans le fichier xml. A partir de cela, on peut construit le fichier config.tt2 : Il énumère les paramètres de liste suivis de leur valeur par défaut ou d'une variable xml.

• b : la valeur par défaut est une variable xml, on définit la source de sa valeur. Cela servira lors de la construction "maison" du fichier xml.

1.2. Définition du degré de liberté

On définit le degré de liberté des paramètres vis à vis de la famille avec le fichier param_constraint.conf (cf documentation de symp a, chapitre "Lists families", Using family) :

• c : certains paramètres doivent absolument garder la même valeur tout au long de la vie de la liste dans ce cas, ils seront notés dans le param_constraint.conf avec cette valeur. Ces paramètres sont "fixés".

• d : certains paramètres peuvent être instanciés dans un ensemble de valeurs possibles (ex : scenario). Si l'on veut resteindre cet ensemble de possibilité, il faut noter ce paramètre avec ses valeurs possibles dans le param_constraint.conf. On parle de paramètres "contrôlés". Les paramètres non présents dans le param_constraint.conf sont sans c ontrainte. Ce sont les paramètres "libres".

Concernant l'édition des paramètres modifiables, on dispose du fichier edit_list.conf (cf documentation de sympa, chapitre "List creation, families and list edition",Creating and editing mailing using the web) :

• e : dans ce fichier, on peut définir quelle population d'utilisateur (listmaster, privileged_owner, owner, editor ou user) possède les droits d'éditions sur les paramètres modifiables (contrôlés ou libres). De la même façon, on y indique les droits de lecture des paramètres.

  Pour cela, il faut recopier le edit_list.conf de la distrib ution, car il est assez complet, et le modifier ou le compléter selon les besoins.

1.3. Scenario d'autorisation

• f : pour les paramètres dont la valeur est un scénario d'autorisation (cf documentation de sympa, chapitre "Authorization scenarios"), le degré de personnalisation est très élévé : on peut écrire un ou plusieurs scenario répondant aux besoins précis que l'on a. On définit ainsi nos propres droits d'autorisation. Pour un paramètre on peut alors disposer d'un grand nombre de scénarios (ceux que l'on a écrit plus les scénari os prédéfinis). Le paragraphe précédent explique comment limiter cet ensemble.

• g : les scenarios sont personnalisables au niveau de la famille mais aussi à un niveau global du site, au niveau d'un robot ou au niveau d'une liste.

1.4. Autres fichiers personnalisables

Les autres fichiers personnalisables au niveau de la famille sont les template web (dans le répertoire web_tt2) et les templates mail (répertoire mail_tt2). La famille fournit un nouveau niveau de personnalisation (il sont déjà redéfinissables à différents niveaux :site global, robot, famille ou liste) : cf documentation de sympa, chapitre "Customizing Sympa/WWSympa".

2. Fichiers personnalisables dans Sympa

La famille fournit un niveau de personnalisation, mais le site global, le robot et la liste sont aussi des niveaux de personnalisation (cf documentation de sympa, chapitre "Customizing Sympa/WWSympa"), voici un tableau récapitulatif :

Tableau 1. fichiers personnalisables

Fichiers / Niveau de personnalisation	famille (.../families/famille_X/)	site gl obal (sympa/etc/)	robot (sympa/etc/robot_X/)	liste (sympa/expl/robot_X/liste_X/)
template web (web_tt2/)	oui	oui	oui	oui
template mail (mail_tt2/)	oui		oui	oui
template création de liste (create_list_template/)		oui	oui
scenario (scenari/)	oui	oui	oui	oui
edit_list.conf	oui	oui	oui