Moteur de template - v2.0

Transcription

1 Moteur de template - v2.0 Novembre 2008 Un moteur de template permet de relier la partie développement et la partie graphique d'un site internet. Vous trouverez dans cette documentation toute information utile à son utilisation. Les balises globales ou contextuelles Les balises que vous allez utiliser dans une page html peuvent ne pas fonctionner sur une autre page, mais il en existe certaines, dites globales, qui sont utilisables dans l'ensemble de vos pages, comme les informations sur votre boutique, le nombre de produits dans le panier, et beaucoup d'autres... mais la majorité de nos balises sont contextuelles, elles ne fonctionnent qu'avec l'appel d'un programme précis, c'est pourquoi de façon générale, il est préférable, à la construction de votre page de consulter la liste de ces balises disponibles. Vous pouvez afficher l'ensemble des balises pour chaque page en ajoutant le parametre "?_pr=1 à la fin de l'adresse (URL) de la page concernée. Exemple : Par exemple, pour le site : Vous devez utiliser : Note : Si une adresse contient déjà le "?" avec d'autres paramètres derrière, vous devez alors ajouter "&_pr=1" à la fin de votre adresse. Les différents paramètres de "_pr=" :?_pr=1 vous permet de lister l'ensemble des variables et leur contenu tel qu'il sera affiché sur le site?_pr=2 vous permet de lister les variables, et leur contenu sous forme de code source html?_pr=3 vous permet de lister les variables, leur contenu tel qu'il sera affiché sur le site + le contenu sous forme de code source html?_pr=0 vous permet de visualiser votre site en laissant l'ensemble des balises commentaire du moteur de template pour permettre un débugage plus facile, il permet également de forcer la mémoire cache de se vider sur les pages qui utilisent la fonction include.

2 Les balises PARSE #AAA# Ces balises peuvent provenir de plusieurs sources différentes : les Pages Web Dans votre backoffice, rubrique "Contenu > Pages Web", le champ "Code Page", vous permet de définir le nom de la balise de contenu, si le code page est "footer", vous pouvez alors utiliser dans n'importe quelle page html de votre site la balise #footer#, et le moteur retournera le contenu saisi à l'emplacement de cette balise. Les balises globales Elles sont définies par notre logiciel, elles sont fixes et utilisables dans toutes les pages html de votre site Exemple : #chemin# vous retournera le chemin de votre répertoire personnel #bou_nom# vous retournera le nom de votre boutique #sit_domaine# vous retournera l'adresse de votre site #categorie_html# vous retournera le contenu de vos categories de niv1 et/ou niv2 Les balises contextuelles Elles sont définies par notre logiciel en fonction du programme appelé. Exemple : le programme /panier/ vous retournera l'ensemble des balises permettant l'affichage des informations du panier de votre visiteur. Les balises spécifiques Il existe 2 balises spécifiques indispensables au bon fonctionnement - la balise #page# dans le fichier : /html/structure/structure.htm Elle indique où placer le contenu dans la page structure - la balise #html# dans le fichier : /html/pageweb.htm Elle indique où placer le contenu de votre PageWeb dans le cas où votre PageWeb est appelée directement sans passer par une balise Les balises  Les balises "repeat" permettent de gérer une boucle d'information, comme une liste de produit d'une catégorie, la liste des avis clients, les produits associés, et de nombreuses autres informations. Une balise repeat commence toujours avec la même syntaxe  et fini toujours par  le "/" dans la balise de fin permet de fermer la balise, la syntaxe est identique dans toutes nos autres balises des balises spécifique #AAA# peuvent être placées entre le début et la fin de cette balise. Ces balises ne peuvent pas être placées en dehors des balises "repeat". Exemple : Liste de mes produits :  Nom de mon produit #nomproduit# <br />  Les balises disponibles de repeat sont disponibles dans l'information avec?_pr=1

3 Les balises  Le fonctionnement de repeat2 est identique à la syntaxe de repeat, à la différence que repeat2 doit être placé à l'intérieur d'une balise repeat. Elle permet, lorsque le programme le prévoit, de faire une 2è boucle avec un autre contenu, comme par exemple le fonctionnement de la liste de vos rayons de niveau 1, une 2è boucle permet de lister ceux du niveau 2. Les balises disponibles de repeat2 sont disponibles dans l'information avec?_pr=1 Les balises conditionnelles Il existe 3 types de balise conditionnelles : Par le logiciel - les premières sont gérées par le logiciel directement ; c'est le logiciel qui décide si il doit ou non les afficher. Cʼest ce qui permet, par exemple, d'afficher un message d'erreur. 3 formats sont possibles : - En dehors d'une boucle repeat ou repeat2 : texte à afficher ou à masquer - Dans une boucle repeat : texte à afficher ou à masquer - Dans une boucle repeat2 : texte à afficher ou à masquer Par le contenu d'une balise - Vous pouvez également placer une balise conditionnelle en utilisant comme condition le contenu défini ou non, d'une autre balise de type #AAA#, d'une boucle repeat, ou d'une boucle repeat2. - Pour tester si le contenu d'une balise (en dehors d'une boucle) existe :  ma balise #AAA# existe  - Pour tester si le contenu d'une boucle repeat existe :  ma boucle repeat existe  Mon texte de ma boucle   - Pour tester si le contenu d'une boucle repeat2 existe :  mon texte  La condition inverse est également possible pour afficher un texte uniquement si une balise n'existe pas, pour cela, il vous suffit de placer un "!" devant le nom de la balise, exemple :

4  ma balise #AAA# n'existe pas  Ceci fonctionne avec sibalise, sirepeat, et sirepeat2. Par un opérateur logique - La 3è et dernière balise conditionnelle vous permet d'afficher un contenu en utilisant un opérateur logique et ses conditions pour définir si le contenu doit s'afficher ou non. Cette balise est identique sur tous les niveaux, que ce soit dans une boucle repeat, dans une boucle repeat2, ou même en dehors d'une boucle. La syntaxe de cette balise est :  texte  Il est inutile de remettre les paramètres dans la balise de fin, une balise de fin ce termine donc toujours par : . De plus, Il n'est pas possible d'imbriquer 2 balises "sicond". Le fonctionnement de cette balise en dehors d'une boucle peut différer sur certains opérateurs. le [param1] peut avoir comme valeur les opérateurs suivants : [%] [!%] [>] [<] [>=] [<=] [==] [!=] [~] [in] [!in] si modulo de [param2] est égal a [param3] si modulo de [param2] est différent de [param3] si [param2] est strictement supérieur à [param3] si [param2] est strictement inférieur à [param3] si [param2] est supérieur ou égal à [param3] si [param2] est inférieur ou égal à [param3] si [param2] est égale à [param3] [param2] est différent de [param3] compris entre [param2] et [param3] si [param3] est inclus dans la liste définie dans [param2] si [param3] n'est pas inclus dans la liste définie dans [param2] [param3] n'est jamais obligatoire, si [param3] n'est pas défini, il prendra comme valeur sa position dans la boucle (si on est dans une boucle), sauf pour le [%] et [!%], ou il aura 0 comme valeur par défaut et [~] la fin de la boucle. [param2] et [param3] peuvent avoir une valeur fixe définie dans la condition, ou alors une valeur (numérique) qui proviendrait d'une balise... comme le numéro d'un produit #idp# ou le numéro d'une catégorie #idcat# ou tout autre balise numérique. Il est également possible d'ajouter dans les crochet du param1, en plus de tous les opérateurs, le signe "+", soit [%+], [!%+], [~+], [<+], [<=+] et ainsi de suite... le + a la fin de l'opérateur va forcer, si lʼon est dans une boucle, a l'afficher également en dernier, quoi qu'il arrive! Les exemples Exemple 1) Je suis dans une boucle, je veux afficher mon texte une fois sur 3, en commençant par le 1er et en obligeant le dernier passage de la boucle a s'afficher :  mon texte à afficher  Exemple 2) Je suis dans une boucle, je veux afficher mon texte une fois sur 2 mais en démarrant au 2e, et ne pas forcement le mettre sur le dernier  mon texte à afficher  Exemple 3) je veux afficher mon texte systématiquement après mon 4è passage de ma boucle

5  mon texte à afficher  Exemple 4) Je veux afficher mon texte que pour les 4 premiers de la boucle  mon texte à afficher  Exemple 5) Je veux afficher mon texte a partir du 4è passage de la boucle, et les 3 suivants  mon texte à afficher  Exemple 6) Je veux afficher mon texte uniquement les 2 avant-derniers, et pas le dernier (nous utilisons un chiffre négatif pour démarrer de la fin!)  mon texte à afficher  Exemple 7) Je veux afficher mon texte uniquement sur un seul produit (numéro = ), si la balise correspondante est #idpro#  mon texte à afficher  Exemple 8) je veux afficher mon texte, uniquement si je suis dans la catégorie parent numéro 3402  mon texte à afficher  Exemple 9) même chose que l'exemple 8, mais inversement, uniquement si je ne suis PAS dans la catégorie parent numéro 3402  mon texte à afficher  Exemple 10) vous voulez afficher un texte dans une fiche produit, mais uniquement pour 3 catégories bien particulières  mon texte à afficher  Exemple 11) vous voulez afficher un texte dans une fiche produit, mais exclure 3 catégories particulières  mon texte à afficher  Les balises  Pour inclure du texte provenant d'un autre programme interne à rentashop ou même d'une source extérieure, il est possible d'utiliser la balise  Syntaxe :  /include --> Pour un appel en interne sur votre site, il n'est pas obligatoire d'utiliser le protocole vous pouvez indiquer l'url relatif a votre domaine dans cette balise. Exemple : /html/test.htm

6 Le contenu est récupéré puis enregistré en cache sur nos serveurs pendant une heure, cela permet d'accélérer l'affichage de votre site. Dans le cas où vous ne souhaitez pas que ce contenu soit mis en cache, il est possible d'utiliser la balise "finclude" : url Vous pouvez également vider le cache en appelant votre site avec le paramètre en fin d'adresse :?_pr=0 Lors de vos appels internes à nos programmes dans la fonction include, il est possible de modifier le fichier html par défaut que génère nos programmes avec le paramètre?fajax= Si vous souhaitez par exemple utiliser une présentation de vos catégories spécifiques pour votre page d'accueil : /s/xx?fajax=ajax_categorie.htm XX correspond au numéro de votre catégories. la page "ajax_categorie.htm" de votre dossier HTML sera alors utilisée comme référence de présentation au lieu de votre page categorie.htm l'utilisation du paramètre "?fajax=page.htm" supprime la structure automatiquement, pour faire un appel tout en gardant la structure, il est possible d'utiliser un paramètre supplémentaire : &fajaxstructure=1 Exemple : /s/xx?fajax=ajax_categorie.htm&fajaxstructure=1 Les balises TXT Les balises TXT vous permettent de définir l'ensemble de vos phrases du site pour une modification plus rapide une fois l'intégration finie. Elles s'utilisent dans le moteur de template avec le code de la balise entourée d'arobase. Gestion de la page structure La page "structure" est l'habillage de votre site, le modèle, ou template : le "look" de toutes les pages est déterminé par ce modèle et par la feuille de style CSS qui lui est attachée. Tout le contenu de votre vitrine sera donc toujours présenté en fonction de cette page. Si, pour une raison qui vous est propre, vous souhaitez afficher des pages de votre boutique dans un environnement différent (sans utiliser de structure du tout), il suffit de placer, dans la première ligne de la page HTML, le code suivant :  Dans le cas de sites nécessitants plusieurs structures différenciées, il est possible de multiplier le nombre de structures en créant une deuxième page structure dans le répertoire /structure/ et en la nommant structurexx.htm. Pour indiquer quelles pages sont concernées, placer le code suivant sur la première ligne des pages HTML concernées :  XX : 2 caractères uniquement, exemple "01" ou "AA", ou "AB" etc.