Annuncio delle impostazioni del sito personalizzabili

[martin (Martin Brennan)]

Questo è un argomento correlato all’annuncio su Themeable site settings are now available in modo che gli sviluppatori ne siano a conoscenza.

@martin

Dove sono definiti?

Le impostazioni del sito personalizzabili per tema sono definite nel file principale config/site_settings.yml. Ogni impostazione del sito personalizzabile per tema ha l’opzione themeable: true definita.

Per ora, solo due impostazioni del sito sono personalizzabili per tema: enable_welcome_banner e search_experience, ma in futuro probabilmente renderemo personalizzabili più impostazioni del sito.

Come possono gli autori dei temi controllare i valori predefiniti?

Gli autori dei temi possono definire le sovrascritture delle impostazioni del sito personalizzabili per tema nel file about.json sotto una chiave theme_site_settings come segue:

"theme_site_settings": {
  "enable_welcome_banner": false
}

Qualsiasi valore qui verrà salvato nel database e associato al tema. Una volta salvato un valore, le modifiche a theme_site_settings in about.json durante l’aggiornamento di un tema non influenzeranno il valore attualmente salvato nel database, poiché non possiamo sapere se l’amministratore ha modificato l’impostazione nel frattempo.

Quali sono i limiti delle impostazioni del sito personalizzabili per tema?

Le impostazioni del sito personalizzabili per tema sono destinate solo al controllo degli elementi dell’interfaccia utente e, quando si recupera il loro valore, è necessario un ID tema, quindi si applicano queste limitazioni:

• Le impostazioni del sito personalizzabili per tema non possono essere utilizzate nei processi Sidekiq
• Le impostazioni del sito personalizzabili per tema non possono essere utilizzate nelle regole markdown
• Le impostazioni del sito personalizzabili per tema verranno memorizzate nella cache separatamente dalle impostazioni del sito client utilizzando l’ID tema come chiave
• Le impostazioni del sito personalizzabili per tema sovrascriveranno le chiavi sul servizio siteSettings sul client utilizzando il precaricatore dell’applicazione
• SiteSetting.client_settings_json non includerà le impostazioni del sito personalizzabili per tema; invece, è possibile chiamare SiteSetting.theme_site_settings_json con un ID tema.

Come regola generale, le impostazioni del sito dei temi saranno solo per impostazioni semplici che controllano parti dell’interfaccia utente, niente lato server.

La PR iniziale è qui https://github.com/discourse/discourse/pull/32233

La documentazione per sviluppatori è qui https://meta.discourse.org/t/controlling-site-settings-with-themes/374376