Les options courantes

Les actions de UP se paramètrent à l'aide d'une suite d'option=argument séparés par des caractères pipes (AltGr+6).
Nous allons voir dans cet article comment utiliser les plus courantes d'entre elles.

id

il s'agit de l'identifiant pour le bloc principal de l'action. UP le crée automatiquement, mais vous pouvez le forcer si vous avez besoin de le réutiliser pour une autre action (ex: addcsshead)

?

affiche un résumé des commandes l'action dans la langue de l'utilisateur ainsi que les prefset définis par le webmaster.

debug

affiche la liste des options avec les valeurs actuelles. Celles par défaut et celles saisies dans le shortcode.
Cette information s'affiche également si une erreur est détectée dans le shortcode : option non reconnue, shortcode non fermé, ...
En fin de message, vous trouverez la liste des prefset définis pour votre site.

prefset

Cette option disponible pour toutes les actions à partir de la version 1.7 de UP, permet d'appliquer un ensemble d'options par un nom explicite et facile à retenir
Ces jeux d'options sont à créer par le webmaster de votre site.
Pour les connaitre, afficher l'action en frontend avec le shortcode suivant {up nom-action | ?}.
L'idéal étant qu'il vous ait remis un petit mémento. 😉
Un jeu d'options (prefset) peut aussi être appelé comme argument de l'option principale.
{up hr=param} et {up hr | prefset=param} produisent le même résultat.
Note : pour certaines actions existantes, cela necéssite d'ajouter une option pour indiquer la valeur de l'option principale dans le prefs.ini. Cela devrait être fait assez vite.

style
class
x-style
x-class

ces options permettent de saisir des propriétés CSS ou des noms de classes. style et class ciblent le bloc principal de l'action. Précédé d'un nom, il cible cet élément (ex: titre-class)
Dans la majorité des cas, Dans le but de raccourcir la liste des options, UP accepte que l'on mélange des noms de classes et des propriétés CSS. class=color:red;span3 est valide.

style-*
class-*
x-style-*
x-class-*
identique aux options précédentes, l'ajout de '-*' indique que l'action accepte des options pour 6 sous-éléments maximum.
Un exemple : l'action csv2table permet de styler les colonnes. style-1 cible la 1ère colonne, style-2 la 2è, ...
style-* est la valeur par défaut pour toutes les colonnes.
Il est possible de mélanger styles et classes.
css-head
permets d'ajouter des règles CSS dans le head de la page.
Un exemple : css-head=body[background-color:pink] #id a[text-decoration:underline]
La première règle demande que la couleur de fond de la page soit rose. Pour éviter des conflits, les accolades {} sont remplacées par des crochets []
La seconde demande que les liens affichés par cette action soient soulignés. #id, qui sera remplacé par l'identifiant de l'action, permet de s'assurer que cette règle ne concernera que cette instance de l'action.

filter

dans certains cas, il est possible de limiter l'usage d'une action.
Cette option reprend les possibilités de l'action filter, directement dans l'action concernée.
Syntaxe : filter=motclé:condition;motclé:condition;...

motclé description type valeur
datemax vrai jusqu'à cette date AAAAMMJJHHMM
datemin vrai à partir de cette date AAAAMMJJHHMM
period vrai entre ces dates
Si l'année est omise, le test est fait pour l'année en cours.
Exemple: 1224,01021000 = du 24 décembre minuit au 2 janvier de l'année suivante à 10h
AAAAMMJJHHMM, AAAAMMJJHHMM
day liste des jours autorisés. 1,7 -> lundi ou dimanche
month liste des mois autorisés 1,2 -> janvier ou février
hmax vrai jusqu'à cette heure HHMM
hmin vrai à partir de cette heure HHMM
hperiod vrai entre ces plages horaires (liste possible) HHMM-HHMM
guest vrai si l'internaute n'est pas identifié (invité) 1|0
admin vrai si un admin est connecté 1|0
user liste des userid autorisés 8,12
username liste des username autorisés ex: admin,lomart
group liste des usergroup autorisés 8,12
lang liste des langages autorisés. Seule une partie du code est nécessaire ex: fr,ca
mobile vrai si le site est affiché sur un mobile 1|0
homepage vrai si le shortcode est affiché sur la page d'accueil 1|0
server-host vrai si l'argument figure dans le nom du serveur hôte.
exemple: server-host:.lomart.fr (un sous-domaine de lomart.fr)
tout ou partie du nom
server-ip vrai si l'IP correspond à une de la liste. localhost, ::1, 192.168.0.1 pour des serveurs locaux adresse IP
  • Une condition, comme argument d'une option filter 1, s'exprime en indiquant le type de condition (mot-clé), suivi du signe 2 points et de la valeur. datemax:20191225
  • Plusieurs conditions sont possibles en les séparant par des points-virgules. day:6,7;hperiod:9-12
  • >Pour inverser le sens de la condition, il suffit d'ajouter un point d'exclamation devant le type de condition. !admin
  • Un mot-clé sans valeur est équivalent à mot-clé:1 (ou vrai). Une condition fausse s'exprime par mot-clé:0 ou !mot-clé.
  • Pour les dates, la partie heure (HHMM) est optionnelle.

1 L'action filter permet également d'utiliser une autre forme. Voir filter ~ afficher sous conditions

Note : ne pas utiliser l'action filter si le contenu à filtrer réalise des opérations non annulables

Les arguments

Chaque option attend une valeur qui est propre à sa fonction. Toutefois, quelques généralités sont bonnes à connaitre.

aucune

une option sans argument est considérée comme vraie ou égale à 1.
Pour indiquer qu'une option est fausse, il faut mettre 0 (zéro) comme argument

CSS

pour indiquer du code CSS, il faut remplacer les accolades {} par des crochets []
Si l'on doit saisir des crochets, il faut les précéder d'un antislash

multilangue
pour proposer un argument différent selon la langue de l'utilisateur, on utilise la syntaxe suivante : option=lang[en=YES;fr=OUI]

Petit rappel : un shortcode peut être saisi sur plusieurs lignes pour faciliter sa relecture