È possibile aggiungere vari metadati a un tema. Alcuni sono memorizzati nel file about.json, mentre altri sono memorizzati nei file di localizzazione.
about.json
informazioni sul formato del file
name (stringa, obbligatorio): Il nome predefinito per il tema al momento dell’installazione. Questo può essere modificato dagli amministratori dopo l’installazione del tema.
component (booleano, predefinito false): se il tema debba essere trattato come un componente.
license_url (stringa, facoltativo): un URL per un file di licenza. Verrà visualizzato un link a questo nell’interfaccia di amministrazione. La maggior parte dei temi utilizza questo per collegarsi al proprio file di licenza su GitHub.
about_url (stringa, facoltativo): un URL che contiene maggiori informazioni sul tema. Verrà visualizzato un link a questo nell’interfaccia di amministrazione. La maggior parte dei temi utilizza questo per collegarsi al proprio topic su Meta.
authors (stringa, facoltativo): Una stringa per descrivere l’autore del tema. Visualizzata nell’interfaccia di amministrazione.
theme_version (stringa, facoltativo): Una stringa arbitraria per descrivere la versione del tema. Visualizzata nell’interfaccia di amministrazione.
screenshots (array, facoltativo): Fino a due percorsi di screenshot che verranno utilizzati in varie parti dell’interfaccia utente per visualizzare gli screenshot del tema. Vedere sotto per maggiori dettagli sulle restrizioni.
minimum_discourse_version (stringa, facoltativo): la versione di Discourse più vecchia con cui questo tema è compatibile. Se non corrisponde, il tema verrà disattivato automaticamente. Dovrebbe essere nel formato 2.4.0.beta1.
maximum_discourse_version (stringa, facoltativo): la versione di Discourse più recente con cui questo tema è compatibile. Se non corrisponde, il tema verrà disattivato automaticamente. Dovrebbe essere nel formato 2.4.0.beta1.
file di localizzazione (es. en.yml)
informazioni sul formato del file
theme_metadata.description: Una descrizione localizzata del tema. Visualizzata nell’interfaccia di amministrazione.
theme_metadata.settings.setting_name: Una descrizione localizzata di setting_name, visualizzata sotto l’impostazione del tema nel pannello di amministrazione.
Screenshot
I temi e i componenti possono definire un massimo di due screenshot nella chiave screenshots di about.json, che apparirà più o meno così:
"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]
Tieni a mente queste restrizioni:
- Gli screenshot devono trovarsi in una cartella
screenshotsnel repository GitHub del tema - Dimensione massima del file:
1 MB - Risoluzione massima:
3840×2160(4K) - Rapporto consigliato:
16:9 - Formati consentiti:
.webp,.png,.jpeg,.jpg
Seguiamo anche una convenzione per includere screenshot sia light che dark.
Questo documento è controllato tramite versione - suggerisci modifiche su github.