(sconsigliato) Sovrascrittura dei template di Discourse da un tema o plugin

Idealmente, quando personalizzi Discourse tramite temi o plugin, dovresti utilizzare CSS, l’API JavaScript per i plugin o i plugin outlets. Se nessuno di questi metodi funziona per il tuo caso d’uso, sentiti libero di aprire una PR nel codice principale di Discourse o di avviare un argomento Development qui su Meta. Siamo sempre felici di discutere l’aggiunta di nuovi outlet/API per rendere la personalizzazione più semplice.

Se hai esaurito tutte le altre opzioni, potresti dover ricorrere all’override dei template. Questa tecnica ti consente di sovrascrivere l’intero template di qualsiasi componente o route Ember dal tuo tema o plugin.

:rotating_light: Questo non è un metodo consigliato per personalizzare Discourse. Le modifiche quotidiane nel codice principale di Discourse entreranno in conflitto con il tuo override di template, causando potenzialmente errori catastrofici durante il rendering del forum.

Se decidi di adottare questo approccio, assicurati di avere processi adeguati di testing automatizzato e QA per rilevare eventuali regressioni. Se distribuisci un tema o un plugin con override di template, assicurati che gli amministratori dei forum siano consapevoli dei rischi di stabilità associati al tuo tema o plugin.

:rotating_light: :rotating_light: :rotating_light: Aggiornamento di ottobre 2023: Per le nuove funzionalità, Discourse sta sempre più passando all’uso di componenti scritti nel formato di file .gjs di Ember. I template per questi componenti sono definiti inline e non possono essere sovrascritti da temi o plugin.

D’ora in poi, tutte le personalizzazioni dei template devono essere eseguite utilizzando Plugin Outlets

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

Sovrascrittura dei template dei componenti

Per sovrascrivere un template di un componente Ember (cioè tutto ciò che si trova sotto components/* nel codice principale di Discourse), dovresti creare un file .hbs con lo stesso nome nel tuo tema o plugin. Ad esempio, per sovrascrivere il template del componente badge-button nel codice principale di Discourse, dovresti creare un file template nel tuo tema o 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 essere sempre annidato all’interno della directory /templates, anche se il componente principale ha un template ‘colocato’.

Sovrascrittura dei template delle route

La sovrascrittura dei template delle route (cioè tutti i template non componenti sotto templates/*) funziona allo stesso modo dei componenti. Crea un template con lo stesso nome nel tuo tema o plugin. Ad esempio, per sovrascrivere discovery.hbs nel codice principale, dovresti 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 o 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 l’id più alto)
  2. Override dei plugin (vince il nome del plugin più recente in ordine alfabetico)
  3. Codice principale

Questa precedenza significa anche che puoi sovrascrivere i template dei plugin dai temi. Tecnicamente puoi anche 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 priorizza i template nella classe DiscourseTemplateMap. Per i template dei componenti colocati, queste informazioni vengono utilizzate durante l’inizializzazione dell’app per sostituire le associazioni dei template principali. Per tutti gli altri template, la mappa viene utilizzata dal resolver a runtime per recuperare il template corretto.


Questo documento è sottoposto a controllo 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