Documentation en ligne

Mécanique de gabarits (templates)

Généralités

Les gabarits permettent de construire des modèles à l'aide d'instructions entourées des symboles {% .... %}.

Dans ces gabarit, des variables entre accolades {{ }} vont être remplacées par des valeurs, comme pour un publipostage. Exemple d'un courriel :

Bienvenue {{session_user_display_name}},

Toute l'équipe de {{site_name}} vous remercie de votre
inscription et vous souhaite une agréable visite.

Lors de l'envoi, les variables proposées entre accolades seront remplacées par des valeurs, pour donner un résultat du type :

Bienvenue Lætitia,

Toute l'équipe de Portail citoyen de Connecteville vous remercie de votre
inscription et vous souhaite une agréable visite.

Le même principe est à l'oeuvre partout où l'on utilise des gabarits (templates) : envoi de SMS, création de document, messages dans l'historique, alertes, notifications...

Les variables utilisables dans ces gabarits sont très diverses.

Gabarit conditionnels

Il est également possible d'afficher du contenu de manière conditionnelle, en utilisant une de ces syntaxes :

  • {% if variable %}...{% endif %}
  • {% if variable %}...{% else %}...{% endif %}
  • {% if variable %}...{% elif variable2 %}...{% endif %}

Tester la présence d'une variable

Pour vérifier qu'une variable existe (qu'elle contient quelque chose), on procèdera comme suit :

Pour rappel, voici les renseignements que vous nous avez fournis :

{% if form_var_regime_alimentaire %}
 - Régime alimentaire : {{form_var_regime_alimentaire}}
{% else %}
 - Aucun régime alimentaire précisé.
{% endif %}

Tester la valeur d'une variable

Pour tester non pas la présence d'une valeur mais le contenu de celle-ci, la syntaxe est

{% if variable == valeur %}...{% endif %}, avec également la possibilité d'un {% else %}.

Pour toute information complémentaire, n'hésitez pas à nous contacter au numéro
{% if form_var_pays == "France" %}0800123456{% else %}+33112345678{% endif %}.

Choisir la première variable existante

Il peut souvent s'avérer utile d'afficher la première variable existante parmi une liste de variables. Cela se fera en utilisant cette syntaxe :

{% firstof form_var_nom_autre_professionnel form_var_professionnel_referent %}

Si form_var_nom_autre_professionnel existe, sa valeur sera affichée. Sinon c'est la valeur de  form_var_professionnel_referent qui sera affichée (et si aucune des deux variables n'existe rien ne sera affiché).

Pour plus d'informations la syntaxe utilisée est celle des gabarits Django, il en existe une documentation détaillée en ligne.

Précemment un autre langage de description des gabarits était utilisé (EZT), caractérisé par l'utilisation de crochets (ex: [form_var_email]), il est toujours disponible mais désormais déconseillé ; pour mémoire sa référence détaillée (en anglais) est toujours en ligne.

Dernière mise à jour le 13 décembre 2019 12:23 — Éditer