SPECIFICHE DI CONFIGURAZIONE PER TYPO3 (C) 2007 Amministrazione Provinciale di Pesaro e Urbino Ufficio 2.3.1.2 Gestione Rete Telematica Provinciale Autore: Davide Principi Versione: 1.0 Data: 2 Gennaio 2007 Revisione (svn): $Rev: 2020 $ RIASSUNTO Questo documento elenca delle regole sull'utilizzo di Typoscript (TS) per la configurazione di Typo3 [1]. Un sito e' detto CONFORME a questo documento quando e' configurato nel rispetto di queste regole. OBIETTIVI L'obiettivo primario delle regole enunciate in questo documento e' di definire una modalita' di utilizzo di Typoscript [2] per la configurazione del template di un sito che sia facilmente riutilizzabile e condivisibile con altri siti ospitati sulla stessa installazione di Typo3 (ovvero siti che condividono lo stesso backend/database). Questa configurazione deve inoltre essere rilocabile e facilmente modificabile per poter essere impiegata su diverse installazioni; deve consentire lo sviluppo e l'aggiunta di nuove funzionalita' da parte di diversi sviluppatori. A questo scopo e' specificato come mantenere il codice TS su filesystem mediante il meccanismo di inclusione (INCLUDE_TYPOSCRIPT) [2]. Vengono specificate le regole per la suddivisione della configurazione in piu' file e la struttura delle directory in cui posizionare questi file. La struttura delle directory e' replicabile in maniera ricorsiva allo scopo di fornire diversi livelli di raffinamento/specializzazione di una certa configurazione. Le regole chiariscono anche i requisiti della documentazione allegata, per consentire un facile caricamento e messa a punto. CONFORMITA' Per essere considerato CONFORME, la configurazione di un sito e la documentazione devono rispettare le regole enunciate in questo documento. DEFINIZIONI Livello. Un sito conforme e' detto di livello N se ha una struttura ricorsiva (cfr. "Struttura ricorsiva") di profondita' massima N. Il livello iniziale e' 1. Pacchetto/package. E' l'insieme strutturato secondo la regola "Struttura ricorsiva" delle directory e dei file in esse contenuti. REGOLE 1. Nomi di file I nomi di file hanno tutte le lettere in minuscolo. Le estensioni rispecchiano il contenuto del file stesso. Per i file di testo che contengono Typoscript utilizzare l'estensione "ts". Sono riservati ad un uso specifico i seguenti nomi di file: * tlo.ts (top level objects) 2. Nomi di directory I nomi di directory hanno tutte le lettere in minuscolo. Sono riservati ad un uso specifico i seguenti nomi: * css (fogli di stile) * doc (documentazione) * img (immagini) * lib (altre risorse...) * tss (TypoScript Setup) css, img, doc, lib possono contenere directory a nome libero. tss puo' contenere uno o piu' file "ts" e/o altre directory con nome soggetto alla regola "Distribuzione del Typoscript template". 3. Struttura ricorsiva La directory radice della configurazione e' considerata il primo livello (livello 1). Ogni livello puo' contenere uno o piu' elementi scelti tra * file * directory con nome riservato * directory con nome libero rappresentanti delle alternative di sottolivello (quindi varianti di una certa configurazione) 4. Distribuzione del Typoscript template Il codice Typoscript puo' essere suddiviso in piu' file "ts". Per il Typoscript config i file sono a nome libero e vanno posizionati sotto la directory "lib". Per il Typoscript template la suddivisione deve rispettare uno dei seguenti metodi, in cui il nome del file e il percorso suggeriscono il contenuto del file stesso: * flat/piatto * a directory La scelta di uno dei due metodi e' libera, ma va mantenuta coerente in tutto il livello. In uno stesso livello il TS va organizzato con UNO dei due metodi. Con il metodo piatto il nome del file rispecchia l'"object path" [2] prefisso a tutti gli assegnamenti contenuti nel file stesso. I file vanno posizionati alla radice del livello. Per i Top Level Objects si usa il file con nome riservato "tlo.ts", posizionato alla radice del livello. Con il metodo a directory l'"object path" rispecchia la struttura di directory contenuta nella directory a nome riservato "tss" (TypoScript Setup). In questa configurazione il file "tlo.ts" e' posizionato sotto la directory "tss". Quindi il nome (e il percorso) del file dichiarano implicitamente l'"object path" utilizzato nel file stesso. Vale l'eccezione per l'"object path" "temp.", che puo' essere inserito in qualsiasi file TS. E' possibile posizionare un file contenente TS template sotto "lib" sotto certe condizioni (cfr. "Caricamento della configurazione" e "Documentazione"). 5. Costanti Il percorso delle costanti "tmpl." va utilizzato per tutte le costanti della configurazione TS (cfr. "Distribuzione del Typoscript template") definite all'interno del package. Sono riservate e devono essere valorizzate le seguenti costanti TS: * tmpl.root Va impostata alla directory del livello radice. Tutti i percorsi delle risorse del template vanno impostati con questa costante come base. Va opportunamente evidenziato dove questo metodo non garantisce la rilocabilita' dell'intero pacchetto su filesystem (cfr. "Documentazione"). * tmpl.home_uid ID della pagina radice del sito. 6. Caricamento della configurazione Il caricamento della configurazione distribuita avviene mediante l'utilizzo del comando INCLUDE_TYPOSCRIPT [2], descritto nel documento doc_core_ts. Vanno caricati TUTTI i file "ts" definiti per ogni livello scelto (cfr. "Distribuzione del Typoscript template"). L'insieme dei livelli scelti e' costituito, nell'ordine, dal livello 1 e a seguire i sotto-livelli (2, 3...), fino al raggiugimento della profondita' desiderata. Quando ad un certo livello sono presenti piu' directory che rappresentano dei sotto-livelli (quindi dello stesso grado) puo' essere effettuata la scelta di UN percorso. L'ordine di caricamento per i file di uno stesso livello non e' specificato. La modalita' di caricamento di un file TS posizionato sotto "lib" va documentata (cfr. Documentazione). 7. Documentazione La documentazione e' posizionata nelle directory a nome riservato "doc". Per la documentazione vanno utilizzati dei formati trasparenti [3] (txt, html, docbook, latex...). Un file in formato trasparente puo' avere (in aggiunta) un corrispettivo in formato opaco (pdf, doc...). Nella documentazione vanno specificate: * il nome e la funzione delle costanti utilizzate nel TS template; * la funzione e le modalita' di caricamento di eventuale codice TS template contenuto in file posizionati sotto le directory "lib"; * eventuali requisiti particolari sull'ordine di caricamento dei file "ts"; * dipendenze del TS da estensioni e user functions Typo3; RIFERIMENTI [1] http://typo3.org -- TYPO3 Content Management System [2] http://typo3.org/documentation -- doc_core_ts, doc_core_tstemplates, doc_core_tsref, doc_core_tsconfig [3] http://www.gnu.org/licenses/fdl.txt -- GNU Free Documentation License -------------- $URL: svn://10.111.111.130/REPOS01/Typo3/tmpl/sici/trunk/doc/SPEC-CONF.txt $ $Id: SPEC-CONF.txt 2020 2007-01-30 08:50:30Z davide $