Annonce des paramètres de site thématiques

[martin (Martin Brennan)]

Ceci est un sujet connexe à l’annonce sur Themeable site settings are now available afin que les développeurs soient informés.

@martin

Où sont-elles définies ?

Les paramètres de site personnalisables sont définis dans le fichier principal config/site_settings.yml. Chaque paramètre de site personnalisable a l’option themeable: true définie.

Pour le moment, seuls deux paramètres de site sont personnalisables : enable_welcome_banner et search_experience, mais à l’avenir, nous rendrons probablement plus de paramètres de site personnalisables.

Comment les auteurs de thèmes peuvent-ils contrôler les valeurs par défaut ?

Les auteurs de thèmes peuvent définir des remplacements de paramètres de site personnalisables dans le fichier about.json sous une clé theme_site_settings comme suit :

"theme_site_settings": {
  "enable_welcome_banner": false
}

Toute valeur ici sera enregistrée dans la base de données et associée au thème. Une fois qu’une valeur a été enregistrée, les modifications apportées à theme_site_settings dans le fichier about.json lors de la mise à jour d’un thème n’affecteront pas la valeur actuellement enregistrée dans la base de données, car nous ne pouvons pas savoir si l’administrateur a modifié le paramètre entre-temps.

Quelles sont les limitations des paramètres de site personnalisables ?

Les paramètres de site personnalisables sont uniquement destinés à contrôler des éléments de l’interface utilisateur, et lors de la récupération de leur valeur, nous avons besoin d’un ID de thème. Par conséquent, ces limitations s’appliquent :

• Les paramètres de site personnalisables ne peuvent pas être utilisés dans les tâches Sidekiq.
• Les paramètres de site personnalisables ne peuvent pas être utilisés dans les règles Markdown.
• Les paramètres de site personnalisables seront mis en cache séparément des paramètres de site client en utilisant l’ID du thème comme clé.
• Les paramètres de site personnalisables remplaceront les clés du service siteSettings sur le client à l’aide du préchargeur d’application.
• SiteSetting.client_settings_json n’inclura pas les paramètres de site personnalisables ; vous pouvez plutôt appeler SiteSetting.theme_site_settings_json avec un ID de thème.

En règle générale, les paramètres de site de thème ne concerneront que des paramètres simples qui contrôlent des parties de l’interface utilisateur, rien du côté serveur.

La PR initiale est ici https://github.com/discourse/discourse/pull/32233

La documentation pour les développeurs est ici https://meta.discourse.org/t/controlling-site-settings-with-themes/374376