Personnaliser une action

Au départ, j'ai conçu UP pour mes besoins de webmaster : saisir du contenu avec des mises en forme spéciales, modifier du CSS, ...
J'en avais assez de devoir faire la navette entre les différents fichiers et fenêtres de configuration. Sans parler de la doc que l'on ne retrouve jamais 😉
Mon autre problème était de limiter l'envie des rédacteurs de faire de la création artistique avec les boutons des éditeurs wysiwyg.

Ma solution a été UP qui me permet de tout faire dans l'article avec un accès direct à la doc. Mais ce n'était pas suffisant, j'ai donc ajouté la possibilité de mémoriser mes choix et variantes au sein même du plugin UP d'un site. Sans que ceux-ci ne soient effacés, bien entendu.

Personnaliser le style (CSS et/ou JS)

v1.32

Vous désirez uniquement modifier le ou les fichiers CSS pour avoir un rendu différent de celui proposé par défaut pour une action. UP propose un mécanisme très simple :

  1. créer un sous-dossier custom dans le dossier de l'action concernée
  2. dupliquer le fichier CSS, SCSS ou JS à personnaliser dans ce sous-dossier
  3. adapter le contenu selon vos envies.

Vous continuez à bénéficier des mises à jour de UP pour les fichiers 'non customisés'.
Il est toutefois préférable de regarder dans le changelog / historique si les modifications peuvent avoir une incidence sur vos personnalisations. C'est le cas lors d'ajout de fonctionnalités.

Prise en charge du SCSS

Si vous préférez faire vos modifications en SCSS, il suffit de le dupliquer (ou le créer) dans le sous-dossier custom.
Il sera automatiquement compilé lors de l'appel d'une action scss-compiler.

Attention : si le fichier SCSS fait des importations de partiels, il peut être nécessaire d'adapter le chemin. Dans la majorité des cas, il suffit d'ajouter ../ au début du chemin

@import "../../assets/variables"; deviens @import "../../../assets/variables";

En cas de souci, pour revenir au comportement par défaut, il suffit de modifier le nom du sous-dossier custom pour qu'il ne soit plus pris en compte.

Personnaliser les couleurs globalement

Pour adapter les variables (couleurs, espaces, ...) pour toutes les actions, vous pouvez recopier et adapter tout ou partie du fichier plugins/content/up/assets/scss/_variables.scss dans le fichier plugins/content/up/assets/_variables.scss

puis recomplier tous les fichiers CSS avec l'action upscsscompiler  {up upscsscompiler | info | force}

Important : le fichier plugins/content/up/assets/_variables.scss doit toujours exister pour éviter une erreur lors de la compilation. Par défaut, ce fichier est vide.

Note : lors d'une mise à jour de UP, le fichier _variables.scss n'est pas modifié. Consulter les nouveautés de mise à jour pour actualiser votre fichier.

Personnaliser le comportement (PHP)

Vous désirez modifier le comportement d'une action en modifiant son fichier PHP ou créer une nouvelle action en utilisant une autre action comme modèle.

L'opération nécessite 3 étapes :

  1. dupliquer le dossier de l'action originale en le renommant au nom de votre action. Exemple: mon_action
  2. renommer le fichier PHP principal du même nom que le dossier
  3. renommer la classe principale de ce fichier avec le nouveau nom de l'action

Ensuite, c'est à vous de jouer pour créer une action toute neuve!

N'oubliez pas de supprimer ou de mettre à jour le lien vers la page de démo.

  • vous ne prévoyez pas de page de démo : supprimer la ligne $this->set_demopage();
  • vous créez une page de démo sur votre domaine : indiquer l'url complète
    $this->set_demopage('https://monsite.fr/mademo');
  • la démo de l'action d'origine est toujours valide : ne changer rien

N'oubliez pas de documenter votre code, pour que l'action upactionslist puisse l'afficher.

Vous ne bénéficiez plus des mises à jour de UP.

Modifier les valeurs par défaut des paramètres

Depuis la version 1.4 de juillet 2018, le webmaster du site peut indiquer ses préférences dans un fichier /custom/prefs.ini. Ce fichier permet de mettre des choix par défaut si le rédacteur ne les indique pas

En pratique

  1. créer un fichier prefs.ini en UTF-8 no-BOM sans un sous-dossier custom du dossier de l'action
  2. Dans la section options, ajouter vos valeurs par défaut sous une forme identique à celle du shortcode. Une par ligne, pas de pipe (|).

Notes: une action peut utiliser ce fichier pour récupérer des informations comme une clé de licence. Elle doit le faire dans une section

; PREFERENCES WEBMASTER

; ce fichier permet au wenmaster de spécifier 
; - les valeurs par défaut des options dans la section [options] 
; - des jeux d'options en créeant une nouvelle section 
; - de saisir des données spécifiques (clé) à une action. voir doc de l'action concernée 

; Cas particulier : annulation des valeurs précédentes
; pour une valeur texte ou numérique : laisser vide
; pour une valeur logique : saisir 1 ou 0

; ATTENTION : mettre entre guillemets doubles si caractères spéciaux. Doubler des doubles guillemets pour les utiliser

[options]
btn-class ="btn btn-success"
btn-text="<img src="/"/images/img32/pdf.png""> Afficher le fichier : %s"

[mon-jeu-d-option]
style="border:1px dotted tan"
css-head="#id h4:before[content:'\BB']"
videoAutoPlay=1

; autres valeurs définies par l'action.
[key]
xxx = 123456789

Si le fichier prefs.ini n'est pas reconnu, vérifiez la présence des guillemets

Créer des jeux d'options (prefset)

v1.7 Un jeu d'options peut être compris comme une variante des options par défaut définie dans le fichier custom/prefs.ini

Il suffit de définir une section avec un nom explicite, puis les options avec les valeurs souhaitées.


Ce simple shortcode a permis d'afficher la ligne horizontale ci-dessus

{up hr=i-love-up}

Avec cette déclaration dans le fichier custom/prefs.ini de l'action hr.

[i-love-up]
icon-text="I\2764UP"
icon-color="red"
fontname="cursive"
hr-width="80%"
hr-bg="linear-gradient(90deg, rgba(255,255,255,1) 0%, rgba(255,0,255,1) 15%, rgba(255,0,255,1) 30%, rgba(255,255,255,1) 50%, rgba(255,0,255,1) 70%, rgba(255,0,255,1) 85%, rgba(255,255,255,1) 99%, rgba(255,255,255,1) 100%)"
hr-height="2px"

Il faut prendre les précautions suivantes :

  • mettre la valeur des options entre guillemets. Les doubler pour insérer un guillemet
  • ne pas saisir de shortcode comme arguments des options
  • ne pas utiliser le nom de l'action comme option principale, mais l'option "alternative" 1

1 Le prefset pouvant être appelé comme argument de l'option principale, il est impossible de réutiliser le nom de l'action comme argument.

Voir aussi :

185 Créer le dossier technique du site
Tous les sites ont besoin d'un dossier technique pour transmettre les informations et bonnes pratiques aux personnes impliquées. Même et surtout si l'on est seul !
59 Installation et mise à jour
La procédure pour installer UP sur votre site
153 Le fichier custom/prefs.ini
Toutes les infos sur la composition du fichier de préférence webmaster.
50 Gestion des traductions
maitriser les langues avec UP