Réaliser un template-extension (modèles)

C'est quoi un template ?
Un template c'est un peu comme notre squelette à nous. C'est comme une architecture autour de quoi vient s'ajouter divers éléments. Un template c'est comme un modèle ou un moule. En template donne la forme générale à prendre et ensuite, le reste viendra compléter le dispositif avec d'autres informations.

Kézako un T-E ?!
Un template-extension (T-E) est un moyen proposé pour personnaliser l'affichage d'une galerie.
En se basant sur un fichier template d'origine, vous fabriquerez votre propre template qui deviendra dès lors une extension du template d'origine.

Le pourquoi du comment

Avant de se lancer dans de grandes démonstrations, il faut savoir qu'un template (fichiers qui se termine par .tpl) n'est ni plus ni moins qu'un type de fichier qui va donner des instructions pour l'affichage de vos pages. C'est ainsi, grâce aux templates, que l'on modifiera l'apparence pour tel ou tel besoin.
Toutefois il est impératif de ne pas modifier les fichier d'origine de Piwigo. C'est pourquoi vous ne travaillerez pas directement sur les fichiers d'origine.

Voilà pourquoi on parle de template-extension car votre future fichier viendra se positionner comme une extension du template d'origine.

Le template-extension

Le template-extension est littéralement une extension de template. En d'autres termes : un fichier qui viendra compléter d'autres fichiers.
Sa création est très logique : on partira d'un fichier original que l'on dupliquera et que l'on modifiera selon ses envies. Votre propre fichier viendra ainsi remplacer le fichier original. Vous conservez du coup le fichier original et donc lors d'une mise à jour, votre propre fichier (qui portera un nom différent du fichier original) ne sera pas affecté par la mise à jour.

Créer son fichier personnalisé

Fig.01 Avec l'aide de LocalFiles Editor
Fig.01 Avec l'aide de du plugin LocalFiles Editor


Deux possibilités. Soit vous dupliquez un fichier existant, soit vous êtes bidouilleur et vous partez d'une page vierge.

Mise en œuvre

Nous allons dire que nous voulons réaliser une template-extension du fichier picture.tpl qui est le responsable de l'affichage de la photo à la taille web (vue normale).

Fig.02 Création d'un nouveau fichier
Fig.02 Création d'un nouveau fichier


Rendez vous dans [ Administration » Plugins » LocalFiles Editor > onglet Templates ]
Cliquez sur ”Créer un nouveau fichier” (Voir Fig.01 et Fig.02)

  • Nom du fichier : Entrez un nom de fichier. Le nom de mon nouveau fichier sera quelque chose comme ”my-picture.tpl” ou ”picture-perso.tpl”…
  • Dossier parent : Par défaut laissez templates-extension. Seuls les webmasters aguerris se risqueront à changer de répertoire de stockage.
  • Modèle : Nous pouvons partir soit d'un document vierge, soit d'un document déjà existant qui nous servira de modèle. Pour notre exemple, choisissons le fichier picture.tpl
Personnaliser son fichier .tpl

Dans le mesure où vous travaillez maintenant sur une copie du fichier original, vous pouvez apportez toutes les modifications que vous souhaitez. Votre fichier original sera toujours préservé.

Appliquer son fichier template-extension

Ce n'est pas le tout de faire et d'adapter un fichier à sa guise. Il faut maintenant dire à Piwigo de prendre en considération non plus le fichier original mais le vôtre. Rien de compliqué. Suivez le guide.

Rendez vous dans [ Administration » Configuration » Templates (modèles) ]

Dans le tableau, apparaît une liste de 4 colonnes.

Fig.03 Appliquer son template-extension
Fig.03 Appliquer son template-extension


  • Remplaçants (templates modifiés) Fichiers qui serviront au remplacement. Dans cette liste, certains fichiers ne sont pas de vous. Ils ont été installés avec Piwigo et sont là pour vous servir d'exemples.
  • Templates d'origine C'est le fichier que vous allez remplacer par le vôtre.
  • Paramètre facultatif de l'URL Sauf si vous savez ce que vous faites, laissez ce champ vide.
  • Template rattaché Les effets seront visibles uniquement sur le template que vous choisirez dans cette liste. Si aucun thème n'est choisi, le template-extension sera appliqué à tous les thèmes présents sur la galerie.

La limite d'un template-extension

Un T-E n'est autre qu'une copie à un jour J d'un fichier d'origine.
Lors d'une mise à jour importante de Piwigo, il arrive que certains templates (les originaux donc) évoluent. Du coup, votre T-E qui était basé sur l'ancienne version devient obsolète…

Pensez-donc qu'en cas d'une mise à jour importante, il est nécessaire de contrôler la bonne conformité de ses template-extension.
Pour comparer il y a des logiciel comme WinMerge ou Notepad++ (avec un petit plugin) qui peuvent vous aider. Il y a aussi le site de développement de Piwigo qui peut vous renseigner.
Pour obtenir de l'aide, n'hésitez pas à nous laisser votre message sur notre forum

Pour aller plus loin...

MERCI DE NE PAS TOUCHER AUX LIGNES QUI SUIVENT.

 
Haut de page
utiliser/utilisation/fonctionnalites/template.txt · Dernière modification: 2013/11/18 14:29 par flop25
 
 
github twitter facebook google+ newsletter Faire un don Piwigo.org © 2002-2017 · Contact