Gabarits de core et suggestions

Soumis par kolossaldrupal le mer, 15/04/2009 - 06:00
in
Date du document original : 8 Janvier 2010 – 05h38 http://drupal.org/node/190815

Remarque : un bug empêche le chargement des fichiers gabarits dérivés si le fichier de base du thème n'est pas également présent dans le dossier. Voir #279573: Themes can't use node-story.tpl.php without node.tpl.php pour plus d'infos.

Ces gabarits et suggestion sont également disponibles dans une cheat sheet (PDF).

Gabarits par défaut:

Ce sont les fichiers gabarits .tpl.php par défaut fournis par le core. La documentation sur les variables et l'usage de ces gabarits se trouve à l'intérieur des gabarits. Il y a un ensemble de variables par défaut default set of variables disponibles pour tous les gabarits.

Les gabarits gérés par PHPTemplate dans les version 5.x de Drupal ont été déplacés. PHPTemplate ne gère plus les fichiers gabarits.

Pour surcharger ces gabarits, il suffit de les copier dans le dossier de votre thème et vider le registre de thème clear the theme registry.

(les liens qui suivent renvoient vers des pages techniques du site api.drupal.org. Je n'ai pas traduit ces pages-là...)

Aggregator 
"modules/aggregator/..."
Block
"modules/system/..."
"modules/block/..."
Book
"modules/book/..."
Comment
"modules/comment/..."
Forum
"modules/forum/..."
Node
"modules/node/..."
Poll
"modules/poll/..."
Profile
"modules/profile/..."
Search
"modules/search/..."
User
"modules/user/..."
System
"modules/system/..."

Template suggestions:

Les suggestions ne sont prises en compte que si elles sont placées dans le même dossier que le gabarit de base. En d'autres termes, en essayant de travailler avec comment-blog.tpl.php, comment.tpl.php doit également se trouver dans votre thème et dans le même dossier.

Des suggestions personnalisées en plus de celles listées ci-dessous peuvent être créés. Reportez-vous à la page Working with template suggestions.

block-[region|[module|-delta]].tpl.php

gabarit de base : block.tpl.php

Les suggestions faites sur ces éléments, dans cet ordre :

  1. block-module-delta.tpl.php
  2. block-module.tpl.php
  3. block-region.tpl.php

« module » étant le nom du module et « delta » l'identifiant interne attribué par le module au bloc. Par exemple, "block-user-1.tpl.php" sera utilisé comme bloc de navigation par défaut pour l'utilisateur 1 puisqu'il a été crée par le module utilisateur avec l'identifiant 1. « region » sera effectif pour des régions spécifiques.

comment-[type].tpl.php

gabarit de base : comment.tpl.php

Une fonctionnalité a été ajoutée pour créer des fichiers comment-type.tpl.php, afin de formater des commentaires d'un type de nœuds particulier différemment d'autres commentaires du site. Semblable à node-[type].tpl.php mais pour les commentaires.

comment-wrapper-[type].tpl.php

gabarit de base : comment-wrapper.tpl.php

Semblable au précédent mais pour les gabarits wrapper.(présentation?)

forums-[[container|topic]-forumID].tpl.php

gabarit de base : forums.tpl.php

Les suggestions faites sur ces éléments, dans cet ordre :

Pour les « containers » de forums:

  1. forums-containers-forumID.tpl.php
  2. forums- forumID .tpl.php
  3. forums-containers.tpl.php

Pour les sujets des forums:

  1. forums-topics-forumID.tpl.php
  2. forums-forumID.tpl.php
  3. forums-topics.tpl.php
maintenance-page-[offline].tpl.php

gabarit de base : maintenance-page.tpl.php

Utilisé lorsque la base de données ne répond pas. Utile pour afficher une page plus personnelle, dépourvue des messages d'erreur standards. La page de maintenance doit avoir été correctement paramétrée avant.

node-[type].tpl.php

gabarit de base : node.tpl.php

Type de nœud de contenu. Par exemple : « node-article.tpl.php », « node-blog.tpl.php », etc. A noter : pour surcharger le gabarit d'un type de node spécifique, le fichier gabarit de base node.tpl.php doit se trouver dans le dossier du thème. Si ce fichier est manquant, le thème ne détectera pas la présence des fichiers node-[type].tpl.php.

page-[front|internal/path].tpl.php

gabarit de base : page.tpl.php

Les suggestions sont nombreuses. Celle qui a la priorité est celle de la page d'accueil. Les autres sont basées sur le chemin interne de la page courante. Ne confondez pas le chemin interne avec l'alias, qui n'est pas pris en compte. Do not confuse the internal path to path aliases which are not accounted for. Ayez à l'esprit que le module « Path auto » travaille avec des alias.

La page d'accueil peut être paramétrée dans Administrer > Configuration du site > Information du site.

Toute indication ici déclenchera la suggestion « page-front.tpl.php ».

(pour le paragraphe qui suit, j'avoue n'avoir compris ni l'esprit, ni la lettre :-( Aussi, je laisse le texte anglais en orange)

The list of suggested template files in order of specificity based on internal paths. One suggestion is made for every element of the current path, though numeric elements are not carried to subsequent suggestions.

Une suggestion est faite pour chaque élément du dossier en cours, bien que les éléments numériques ne soient pas amenées aux suggestions suivantes. Par exemple, http://www.example.com/node/1/edit donnera les suggestions suivantes :

  1. page-node-edit.tpl.php
  2. page-node-1.tpl.php
  • page-node.tpl.php
  • page.tpl.php
    • poll-results-[block].tpl.php

    gabarit de base : poll-results.tpl.php

    La fonction de thème qui génére les résultats de sondages est partagé (are shared ?) pour les nœuds et les blocs. Le comportement par défaut est de l'utiliser pour le nœuds mais une suggestion est faite pour la présentation à l'intérieur des régions blocs. Cette suggestion est utilisée par défaut et le fichier gabarit est situé dans modules/poll/poll-results-block.tpl.php.

    poll-vote-[block].tpl.php

    gabarit de base : poll-vote.tpl.php

    Semblable à poll-results-[block].tpl.php mais pour la création d'un formulaire de vote. Vous devez fournir votre propre gabarit pour qu'il soit pris en compte.

    poll-bar-[block].tpl.php

    gabarit de base : poll-bar.tpl.php

    Comme poll-vote-[block].tpl.php mais pour créer les barres (les barres de résultat ?).

    profile-wrapper-[field].tpl.php

    gabarit de base : profile-wrapper.tpl.php

    Le gabarit de présentation du profil est utilisé lorsque vous naviguez dans la liste des membres. Lorsque vous naviguez sur des champs spécifiques, une suggestion est faite avec le nom du champ. Par exemple, http://drupal.org/profile/country/Belgium proposera profile-wrapper-country.tpl.php.

    search-results-[searchType].tpl.php

    gabarit de base : search-results.tpl.php

    search-results.tpl.php est la présentation par défaut pour le résultat des recherches.

    Selon le type de recherche, différentes suggestions sont faites.

    Par exemple,  « example.com/search/node/Search+Term » pourra utiliser « search-results-node.tpl.php ».

    Comparez avec « example.com/search/user/bob » employant « search-results-user.tpl.php ». Les modules peuvent enrichir les types de recherches en ajoutant davantage de suggestions de leurs propres types.

    search-result-[searchType].tpl.php

    gabarit de base : search-result.tpl.php

    Le même que le précédent, mais pour un résultat de recherche individuelle.