Le blogue d’Infoglobe

TYPO3 utilise ce que l’on pourrait appeller un langage ou un fichier de configuration qui s’appele le Typoscript. Je ne rentrerais pas ici dans le détail de ce qu’est le Typoscript ou l’utilisation au sein de TYPO3. Mais je partirais du principe que vous êtes déjà un utilisateur de TYPO3 et que vous avez déjà intégré du code TS à l’intérieur du système. Ce billet fera donc la lumière sur l’utilisation du Typoscript, car il existe deux manières de gérer du code TS dans l’interface backend :

1. Soit en mettant votre code directement dans un enregistrement de type GABARIT (template)
2. Soit en mettant votre code dans un fichier externe (texte) et de l’inclure dans un enregistrement de type GABARIT (template)

Pour ma part, ma préférence serait plutôt la première option. Mais voici pour moi les avantages et inconvénients de ces deux approches.

::: Avantages :

• Agir sur les sous-pages : Si l’on passe par le backend, on peut inclure des gabarits qui n’agiront que pour les sous-pages. L’option se trouve lors de l’édition du gabarit dans son ensemble :
• Completion, colorisation : À partir de la version 4.2 de TYPO3 on pourra profiter de la completion et la colorisation en éditant notre code directement depuis le bakckend. Mais si vous utilisez des fichiers externes, vous pourriez bénéficier de l’extension “SweeTS 1.15” avec le programme PSPaD et ainsi profiter de nombreux avantages qui sont :
  • L’explorateur de code
  • L’auto-completion
  • L’aide en ligne
  • Une intégration parfaite avec PSPad

::: Inconvénients :

• Gestion du cache : La gestion du cache peut devenir un problème si votre code TS est dans un fichier externe, car il faudra vider la cache du site en entier après chaque changement (voir aussi le site de SweetTS qui indique du code TSCONFIG pour palier à ce programme de cache) alors que normalement il n’est même pas obligatoire de toucher à la cache si on édite un gabarit TS depuis le backend et qu’on s’assure d’éditer que la section SETUP ou CONSTANTE.
• Sous-fichiers : On ne peut pas inclure de sous fichier lorsque l’on travail avec des fichiers externes (sauf dans la version 4.2 qui s’en vient ou ce problème a été corrigé)
• Éditeur de constantes : On ne peut plus profiter de l’éditeur de constante si on édite notre code à l’externe, sauf si on recopie le code à chaque.
• Exportation du typoscript : J’avais donné une astuce pour exporter tout votre code Typoscript depuis l’interface de TYPO3. Cela peut paraitre inutile au premier abord, mais je peux vous dire que cela m’a déjà rendu service. Lors de l’utilisation de fichiers externes, on perd cette fonctionnalité, ce qui est un peu dommage.
• La recherche : Il n’est plus possible de rechercher une ligne de code TS depuis le moteur de recherche internet à TYPO3.

Finalement si on regarde bien, l’une ou l’autre des techniques est tout aussi simple, même si ma préférence va pour l’éditeur du code Typoscript directement en ligne et non en passant par un fichier externe et ceci pour deux raisons :

• La gestion du cache (vider le cache de tout le site à chaque fois n’est pas une bonne chose en production)
• Retrouvez facilement un bout de code typoscript

::: La meilleure approche :

Il y a une approche idéale que je vais vous décrire ci-dessous. Je l’ai apprise lors de la migration du site du MDEIE vers TYPO3 en regardant les autres prendre en main l’interface de TYPO3.

Jusqu’à ce jour, je créais un enregistrement de type Gabarit et y mettais mon code là ou j’en avais besoin. Puis j’avais au moins un gabarit principal sur la page ROOT (la plus haute de mon arborescence) qui appelait plusieurs bouts de code classé dans un dossier système. Cela fonctionnait bien, mais je me suis rendu compte que l’on pouvait faire mieux, parce qu’avec cette approche, cela pouvait être difficile de retrouver un bout de code, car je pouvais me retrouver avec une quinzaine voir encore plus d’enregistrements de ce type sur toute l’arborescence du site.

Même si la recherche fonctionne bien ou le mode INFO (enregistrement vue d’ensemble), cela ne suffit pas toujours.

La solution idéale pour moi est donc une adaptation de cette approche, mais au lieu de laisser le code sur chacune des pages ou section du site (exemple dans la section actualité, laisser le code de tt_news), je ne fais qu’un lien vers ce même code mais organisé dans un dossier système. Comme je le fais pour la page ROOT. Cela permet d’avoir l’ensemble des codes sans exception (constante ou setup) dans un même endroit et de pouvoir les retrouver facilement.

En voici un exemple simple avec 4 gabarits, mais si vous utilisez cette approche, vous pouvez vous retrouver avec une vingtaine d’enregistrements :

Existe t’il une approche encore meilleure, je ne le sais pas.. laissez-moi déjà appréhender celle-ci