Le fichier custom/prefs.ini

Ajouter un fichier prefs.ini dans le sous-dossier custom d'une action permet de la personnaliser.

Pour le créer, le plus simple est de faire une copie d'un fichier prefs.ini.dist

Valeur par défaut des options

Il suffit d'ajouter dans la section options vos valeurs par défaut sous une forme identique à celle du shortcode. Une par ligne, pas de pipe (|).

Voici un exemple pour l'action osmap. On définit le niveau de zoom et la hauteur par défaut. On indique également le marqueur personnalisé pour le site. Le rédacteur pourra toujours saisir ses options qui seront prioritaires.

[options]
zoom="17"
height="400px"
popup-clic=0
marker-image="images/osmap/marker-hg-icon.png"
marker-options="iconSize:[60,63],iconAnchor:[0,0],popupAnchor:[0,0]"
 

Les avantages :

  • réduire la quantité d'options à saisir
  • éviter les fautes
  • adapter le style des actions à celui du site

Les jeux d'options

Des valeurs par défaut, c'est bien ! mais les choisir, c'est mieux !

La version 1.7 de UP permet de créer des ensembles d'options que l'on peut appeler dans le shortcode par l'option prefset=nom-du-jeu-d-options.

Pour comprendre le principe, je vais utiliser l'action hr. La première étape, pour le webmaster, est de créer une section dans le fichier prefs.ini avec la valeur pour les options de l'action. Le nom de la section sera celui utilisé pour l'appliquer.

[typo-feuille]
hr-class=degrade-gris
hr-border-top=none
hr-height=2px
icon=Ux1F65A
icon-size=36px
icon-color=tan
icon-v-offset=-3px
hr-style=margin-top:36px

Pour l'utiliser, il suffit d'indiquer le nom de la section comme argument principal

{up hr=typo-feuille}

Il est aussi possible de l'utiliser avec l'option prefset. Cette méhode est obligatoire pour passer un argument à l'option principale. Voir les 2 exemples ci-dessous

{up hr | prefset=typo-feuille}
{up file-download=Mon_Fichier.pdf | prefset=Mon_Jeu_dOptions}

Si vous avez oublié le nom du jeu d'options, ajouter debug ou ? au shortcode puis appeler la page en frontend. Vous aurez la liste de toutes les sections définies pour l'action.

Si vous spécifier une option dans le shortcode, elle sera prioritaire sur la valeur définie dans le jeux d'options.

Ordre de priorité pour la prise en compte des arguments des options :

  1. option saisie dans le shortcode
  2. argument du jeu d'option
  3. argument par défaut (section options du prefs.ini)
  4. argument défini par le développeur de l'action