Ankündigung von thematisierbaren Website-Einstellungen

[martin (Martin Brennan)]

Dies ist ein verwandtes Thema zur Ankündigung unter Themeable site settings are now available, damit Entwickler informiert sind.

@martin

Wo werden sie definiert?

Themeable Site Settings werden in der zentralen Datei config/site_settings.yml definiert. Jede themeable Site Setting hat die Option themeable: true definiert.

Vorerst sind nur zwei Site Settings themeable – enable_welcome_banner und search_experience – aber in Zukunft werden wir wahrscheinlich mehr Site Settings themeable machen.

Wie können Theme-Autoren Standardwerte steuern?

Theme-Autoren können Theme-Site-Setting-Überschreibungen in der Datei about.json unter einem Schlüssel theme_site_settings definieren, wie folgt:

"theme_site_settings": {
  "enable_welcome_banner": false
}

Jeder Wert hier wird in der Datenbank gespeichert und dem Theme zugeordnet. Sobald ein Wert gespeichert wurde, wirken sich Änderungen an theme_site_settings in der Datei about.json bei einem Theme-Update nicht auf den aktuell gespeicherten Datenbankwert aus, da wir nicht wissen können, ob der Administrator die Einstellung in der Zwischenzeit geändert hat.

Was sind die Einschränkungen von themeable Site Settings?

Themeable Site Settings sind nur wirklich dazu gedacht, UI-Elemente zu steuern, und wenn ihr Wert abgerufen wird, benötigen wir eine Theme-ID. Daher gelten diese Einschränkungen:

• Themeable Site Settings können nicht in Sidekiq-Jobs verwendet werden.
• Themeable Site Settings können nicht in Markdown-Regeln verwendet werden.
• Themeable Site Settings werden separat von Client-Site-Settings mit der Theme-ID als Schlüssel zwischengespeichert.
• Themeable Site Settings überschreiben Schlüssel im siteSettings-Dienst auf dem Client mithilfe des Application Preloaders.
• SiteSetting.client_settings_json enthält keine themeable Site Settings. Stattdessen können Sie SiteSetting.theme_site_settings_json mit einer Theme-ID aufrufen.

Als allgemeine Regel gilt, dass Theme-Site-Settings nur für einfache Einstellungen gedacht sind, die Teile der UI steuern, nichts serverseitiges.

Der initiale PR ist hier https://github.com/discourse/discourse/pull/32233

Entwicklerdokumente sind hier https://meta.discourse.org/t/controlling-site-settings-with-themes/374376