(non consigliato) Sovrascrivere i template di Discourse da un tema o plugin

Idealmente, quando si personalizza Discourse tramite temi/plugin, si dovrebbe utilizzare CSS, l’API dei plugin JavaScript o le plugin outlets. Se nessuna di queste opzioni è adatta al proprio caso d’uso, non esitate a aprire una PR su Discourse core o a iniziare un topic Development qui su Meta. Siamo sempre lieti di discutere l’aggiunta di nuove outlets/API per rendere la personalizzazione più semplice.

Se si sono esaurite tutte le altre opzioni, potrebbe essere necessario ricorrere agli override dei template. Questa tecnica consente di sovrascrivere l’intero template di qualsiasi Componente o Route Ember dal proprio tema/plugin.

:rotating_light: Questo non è un metodo consigliato per personalizzare Discourse. I cambiamenti quotidiani in Discourse core causeranno inevitabilmente conflitti con il vostro override del template, potenzialmente generando errori catastrofici durante il rendering del forum.

Se si decide di adottare questo approccio, assicuratevi di avere processi di test automatizzati e QA sufficienti per rilevare i regression. Se si distribuisce un tema/plugin con override dei template, si prega di assicurarsi che gli amministratori del forum siano a conoscenza dei rischi di stabilità associati al vostro tema/plugin.

:rotating_light: :rotating_light: :rotating_light: Aggiornamento di ottobre 2023: Per le nuove funzionalità, Discourse si sta sempre più orientando verso l’utilizzo di componenti creati utilizzando il formato file .gjs di Ember. I template per questi componenti sono definiti inline e non possono essere sovrascritti da temi/plugin.

In futuro, tutte le personalizzazioni dei template dovranno essere effettuate utilizzando le Plugin Outlets

Ho capito che questo si romperà in futuro, mostrami comunque la documentazione

Sovrascrittura dei template dei componenti

Per sovrascrivere un template di un componente Ember (ovvero qualsiasi cosa sotto components/* in Discourse core), è necessario creare un file .hbs con lo stesso nome nel proprio tema/plugin. Ad esempio, per sovrascrivere il template del componente badge-button in Discourse core, si dovrebbe creare un file di template nel proprio tema/plugin in questa posizione:

:art: {theme}/javascripts/discourse/templates/components/badge-button.hbs

:electric_plug: {plugin}/assets/javascripts/discourse/templates/components/badge-button.hbs

L’override deve sempre essere annidato all’interno della directory /templates, anche se il componente core ha un template ‘collocato’ (colocated).

Sovrascrittura dei template delle route

La sovrascrittura dei template delle route (ovvero tutti i template non-componenti sotto templates/*) funziona allo stesso modo dei componenti. Creare un template con lo stesso nome nel proprio tema/plugin. Ad esempio, per sovrascrivere discovery.hbs nel core, si dovrebbe creare un file come

:art: {theme}/javascripts/discourse/templates/discovery.hbs

:electric_plug: {plugin}/assets/javascripts/discourse/templates/discovery.hbs

Interazione tra più temi / plugin

Se più temi/plugin installati sovrascrivono lo stesso template, il ‘vincitore’ è quello con il ranking numerico più basso in questa lista:

  1. Override dei temi (vince il tema con ‘id’ più alto)
  2. Override dei plugin (vince il nome del plugin più recente in ordine alfabetico)
  3. Core

Questa priorità significa anche che è possibile sovrascrivere i template dei plugin dai temi. Tecnicamente è anche possibile sovrascrivere i template dei temi da altri temi, e i template dei plugin da altri plugin, ma il comportamento può essere sorprendente a causa della dipendenza dal nome del plugin e dall’id del tema.

Come funziona?

Discourse assembla e dà priorità ai template nella classe DiscourseTemplateMap. Per i template dei componenti collocati, queste informazioni vengono utilizzate durante l’inizializzazione dell’app per sostituire le associazioni dei template core. Per tutti gli altri template, la mappa viene utilizzata da il resolver in runtime per recuperare il template corretto.


Questo documento è sottoposto a controllo di versione - suggerisci modifiche su github.

17 Mi Piace

E per quanto riguarda i modelli per dispositivi mobili? Qual è la struttura delle directory per riscrivere i modelli dal core

Dovrebbe funzionare esattamente allo stesso modo: si abbina il nome del modello principale. Quindi, se ha /mobile, includilo nella tua sovrascrittura.

Sto provando a riscrivere il template mobile login.hbs e non funziona Imgur: The magic of the Internet, ho il percorso giusto?

Il percorso completo non è visibile nel tuo screenshot, per quanto posso vedere. Puoi incollarlo qui come testo.

themeroot/javascripts/mobile/modal/login.hbs

Manca discourse/templates nel tuo percorso

Quindi, nel tuo caso, sarebbe {theme}/javascripts/discourse/templates/mobile/modal/login.hbs

2 Mi Piace

È ancora così?

Sono un po’ triste che la capacità di sovrascrivere molto codice venga rimossa.

Ha senso sostituire il sistema di Widget su misura, in una certa misura, ma questo ci ha dato la capacità di agganciarci al codice esistente a più livelli, riducendo molti rischi di modifiche che rompono, poiché potevamo puntare solo a piccoli blocchi in modi intelligenti che ci avrebbero permesso di:

  • aggiungere funzionalità
  • non disturbare nient’altro.

Ho appena dovuto rimuovere DUE funzionalità significative da Discourse Journal, ad esempio, che si basavano su sovrascritture a grana fine dei widget perché l’unico modo per averle ricreate in Glimmer è tramite una coppia di sovrascritture di template (incluso un tentativo di modificare un file .gjs) che apparentemente non è più supportato.

Anche se questo fosse supportato, ci rimarrebbe la sovrascrittura di tratti di codice più ampi rispetto al framework widget, con un aumento associato del rischio che le modifiche principali entrino in conflitto con le sovrascritture.

Questo non fa bene all’estensibilità della piattaforma.

Si può fare qualcosa al riguardo?

7 Mi Piace

Sì, ti capisco: c’erano alcune cose interessanti nelle API di estensibilità dei widget.

Ma il rovescio della medaglia è che è stato incredibilmente difficile per noi modificare QUALSIASI interfaccia utente basata su widget nel core, perché non abbiamo idea di quali metodi/decorazioni casuali le persone potrebbero introdurre. Ecco perché le personalizzazioni dei widget sono sembrate relativamente stabili: eravamo troppo spaventati per toccare le implementazioni principali.

La nostra soluzione per questo in futuro sono i Plugin Outlets Wrapper. Questi consentono a temi e plugin di sovrascrivere facoltativamente piccoli frammenti di template con la propria implementazione.

Ad esempio, vedi come Chat sovrascrive condizionalmente il logo della home con un componente personalizzato. Questo funziona per l’intestazione esistente basata su widget e per la nuova intestazione basata su glimmer (in arrivo! :tm:).

Siamo generalmente felici di accettare PR per aggiungere nuovi wrapper outlets in vari punti. Se non sei sicuro di un particolare caso d’uso, non esitare ad aprire un topic Dev con i dettagli!

10 Mi Piace

OK, questo sembra un modo per andare avanti, grazie.

Dovrò digerire le implicazioni di ciò e adattarmi a una strategia in quella direzione.

Apprezzo la risposta!

6 Mi Piace