SPIP

#SLOGAN_SITE_SPIP

cam.lafit — 2014-08-15T06:00:00Z

La balise #SLOGAN_SITE_SPIP affiche le slogan (aussi appelée baseline) du site.

Sommaire

Utilisation

Cette balise qui s'utilise en général hors-boucle.

Ainsi dans /squelettes-dist/inclure/header.html, elle est appelée ainsi :

 [(#LOGO_SITE_SPIP|image_reduire{224,96})]#NOM_SITE_SPIP
 [(#SLOGAN_SITE_SPIP)

Définir le slogan du site

Le slogan du site est à définir dans Configuration -> Identité du site.

Voir à ce propos Modifier le nom de « Mon site SPIP »

#DOUBLONS

cam.lafit, denisb, Fil — 2010-07-08T22:28:27Z

#DOUBLONS{mots} donne l'état des doublons (MOTS) à cet endroit, sous forme de tableau d'id_mot array(1,2,3,...)

#DOUBLONS tout seul donne la liste brute de tous les doublons

#DOUBLONS*{mots} donne la chaîne brute ",1,2,3,..."
(changera si la gestion des doublons évolue)

Pour des doublons « nommés » (exemple : 100}{doublons A}>) on utilisera :
#DOUBLONS{articles, A} pour avoir le tableau des id_articles.

Pour passer le ou les tableaux de doublons à un INCLURE, on notera :

#INCLURE{fond=noisette, env, doublons=#DOUBLONS{articles, A}}

pour un tableau nommé {doublons A} d'une BOUCLE(ARTICLES)
et

#INCLURE{fond=noisette, env, doublons}

pour tous les tableaux de doublons déclarés dans le squelette appelant (avant l'appel de l'INCLURE).

Pour récupérer un tableau de doublons depuis un INCLURE, il conviendra de ne faire retourner par cet INCLURE que #DOUBLONS*{articles, B} et, dans le squelette appelant, d'utiliser

#SET{ret, #INCLURE{fond=noisette, env, doublons}|explode{','}}

le #GET{ret} résultant pouvant alors être utilisé dans un critère de boucle ({id_article IN #GET{ret}}).

Participer à la documentation des balises, critères, filtres de SPIP

cam.lafit, denisb, Teddy — 2010-07-08T08:32:25Z

Sommaire

Toute personne peut participer. Les pré-requis sont réduit à l'essentiel :

avoir un compte sur spip.net
connaitre une balise, un critère, ... non documenté et connaitre un cas d'utilisation associé.
avoir lu cet article pour comprendre les quelques spécificités liées à la documentation

Titrer l'article

un filtre : |nom_du_filtre
une balise : #NOM_DE_LA_BALISE
un critère : {nom_du_critère}

Résumer l'élément documenté

Le chapeau sert à introduire le concept présenté :

une ou deux phrases de résumé du texte ou de présentation de l'élément. Ce texte est utilisé par les modeles , (exemple de cas d'utilisation La boucle ARTICLES)

Décrire le concept

Le champ Texte sert à la description exhaustive (autant que possible) de l'élément documenté :

une majuscule en début de phrase
encadrer par les tags > et le nom de l'élément (exemple : « la balise #BALISE ... »), les urls de l'espace privé (exemple : « en allant sur ?exec=config_fonctions ... »), parfois le résultat affiché (exemple : « la date retournée sera du type 1970-01-01 00:00:00 »)
privilégier les tags (plus lisibles) et à et
hiérarchiser son texte (intertitres, paragraphes)

- Globalement

s'en tenir à documenter le seul élément dont il est question (ne pas vouloir tout dire, éviter les digressions, les trucs et astuces, ...)
vérifier a minima (en lisant le code) les informations fournies

Utiliser les mots clefs

Indiquer la version de spip ayant introduit l'élément documenté. Pour cela utiliser l'écriture : (depuis [{}->artxxxx]) où « xxxx » est l'id de l'article présentant la version de SPIP et où les {} permettent, si nécessaire, un renvoi automatique sur la traduction de l'article, facilitant ainsi le travail des traducteurs (voir : Les auto-références multilingues de la documentation).
Pour les balises
Indiquer si c'est une balise « statique » (issue de la base de donnée) ou bien « dynamique » (calculée, traitée par une fonction)
indiquer si nécessaire (pour une balise par exemple) le type de boucle concernée
faire au mieux :)
... à suivre

#INSERT_HEAD_CSS

cam.lafit — 2010-07-05T12:51:15Z

La balise #INSERT_HEAD_CSS indique aux plugins où insérer leurs feuilles de style.

Sommaire
Voir aussi
Les squelettes peuvent surcharger ces feuilles de style en fonction de leur ordre d'appel dans les squelettes.

À noter que, pour conserver la compatibilité avec les squelettes existants, si la balise #INSERT_HEAD_CSS n'est pas présente dans le squelette, #INSERT_HEAD insérera son contenu, mais l'ordre d'insertion ne sera pas optimal.

Important : #INSERT_HEAD_CSS doit toujours être appelée avant #INSERT_HEAD dans vos squelettes.

Voir aussi
#INSERT_HEAD

#SESSION_SET

cam.lafit, VALLETEAU de MOULLIAC — 2010-05-22T15:33:12Z

Permet d'insérer dans la balise #SESSION des données supplémentaires

Sommaire
Voir aussi
#SESSION_SET s'utilise ainsi on a #SESSION_SET{variable, valeur}, la valeur sauvegardée dans le tableau php sous la forme $GLOBALS['visiteur_session']['variable'] = 'valeur';

L'information peut être à nouveau lue via #SESSION{variable}

Cette balise permet donc d'ajouter une donnée quelconque à la session ouverte lors de l'accès d'un internaute à SPIP. Elle peut être utilisée sans modération pour conserver des éléments dont on souhaite disposer tout au long de la session ouverte, sans avoir besoin de refaire une boucle ou une autre manipulation.

La syntaxe

La syntaxe de base est très simple :
#SESSION_SET{variable,valeur}
L'élément 'variable' est un nom quelconque qui permettra de faire référence à ce que l'on veut utiliser, et 'valeur' est son contenu. Mais un exemple vaut un long discours.

Par exemple, je suis passionné par les éléphants, et je voudrais l'afficher à tout moment ... Donc :
#SESSION_SET{mapassion,éléphants} mettra 'éléphants' dans 'ma passion'.

Pour l'utiliser, c'est très simple : #SESSION{mapassion} affichera 'éléphants'.

Utilisation pratique

Vous n'avez vu ci-dessus qu'un exemple pas forcément très concret. L'utilisation de la balise #SESSION_SET{variable,valeur} est particulièrement pertinent dès lors qu'un accès à un site se fait avec identification (du type 'login public') afin d'ajouter certaines données liées d'une façon ou d'une autre, dans la session de la personne loguée.

Si vous affichez la balise #SESSION sur une page, vous verrez qu'elle contient un grand nombre de données, notamment concernant l'auteur ou visiteur identifié. L'affichage d'une de ces données se fait directement via #SESSION, sauf si vous avez ajouté des champs extra.

Dans #SESSION{extra}, vous verrez s'afficher, en format texte le contenu de ce champ, sous la forme (par ex.)

a:2{s:10:"id_salarie";s;1:"1";s:7:"college";s:5:"Cadre";}.

Cela vous permet bien sûr de vérifier qu'il y a bien ce que vous cherchez, mais l'affichage laisse à désirer ... [1]

Que faire pour remédier à cela ? Utiliser #SESSION_SET bien sûr, avec la balise #EXTRA !!

Je voudrais afficher le collège :

Dans une boucle AUTEURS, je vais ajouter à ma session le collège de la personne identifiée :

#SESSION_SET{college,(#EXTRA|college)}

Et voilà ! Maintenant, sur n'importe quelle page du site, affichez le collège :

[(#SESSION{college})]

Vous pouvez l'utiliser tout seul, ou dans une boucle, soit pour afficher le collège, soit dans un critère spécifique, par ex.

Aller plus loin ?

Rappelons-nous que spip 2.0.x permet maintenant d'ouvrir des connexion à des bases de données extérieures à celles de spip, même distantes ... Quoi de plus simple, maintenant, d'ajouter une ou des données issues de ces bases à la session ouverte ... Une (ou plusieurs) boucles à l'ouverture, quelques #SESSION_SET{variable,valeur}, et j'ai à ma disposition, rapidement, tout ce que dont j'ai besoin pour dynamiser mon site ...

Voir aussi
#SESSION
|setenv
#SET et #GET
|set

[1] rappel : pour afficher en mode brut (pour vérification) le contenu détaillé de la balise, il est possible d'utiliser l'écriture :
[
(#SESSION*|unserialize|var_export{1})
]

|singulier_ou_pluriel{xxx:chaîne_un, xxx:chaîne_plusieurs}

cam.lafit, denisb — 2010-04-28T14:02:17Z

Le filtre |singulier_ou_pluriel permet de faire varier un affichage en fonction de la valeur numérique retournée par la balise à laquelle il est appliqué.

Sommaire
Personnaliser le filtre
Le filtre |singulier_ou_pluriel est la plupart du temps utilisé pour accorder (singulier ou pluriel) les chaînes de langue en fonction du retour d'une balise.

Exemple

Dans notre fichier local_xx.php, nous déclarons :

'nombre_truc_un' => 'il y a 1 retour dans cette boucle.', 'nombre_truc_plus' => 'il y a @nb@ retours dans cette boucle.'

Puis nous écrivons notre boucle :

... [(#TOTAL_BOUCLE|singulier_ou_pluriel{local:nombre_truc_un, local:nombre_truc_plus})]

- Si la boucle ne retourne qu'un enregistrement, elle affichera :

il y a 1 retour dans cette boucle.

- Si la boucle retourne 36 enregistrements (par exemple), elle affichera :

il y a 36 retours dans cette boucle.

Note : si la valeur fournie est nulle, le filtre ne retourne rien, ce qui permet d'utiliser le filtre |sinon à la suite.

Attention :
Ce filtre attend explicitement des item de langue comme arguments. Il ne faudra donc pas lui passer des balises de langue :
|singulier_ou_pluriel{module:item_un, module:item_plus}
est la bonne écriture ;
|singulier_ou_pluriel{<:module:item_un:>, <:module:item_plus:>}
est une mauvaise écriture.

Personnaliser le filtre

À partir de SPIP 4.0, il est possible de définir des fonctions pour personnaliser le fonctionnement de ce filtre
- pour une langue particulière. Pour cela, il faut définir une fonction suffixée par le code de langue. Par exemple, la fonction singulier_ou_pluriel_ar() pour la langue arabe.
- ou de manière générique pour toutes les langues. En effet, SPIP fait appel à charger_fonction pour récupérer la version de singulier_ou_pluriel spécialisée par vos soins.

#BOUTON_ACTION

cam.lafit, denisb, JLuc — 2010-04-22T07:14:47Z

La balise #BOUTON_ACTION{libellé, url, class, confirm_message,title,callback} produit le source html complet d'un formulaire (methode POST) comportant uniquement un bouton de type submit.

Sommaire
Voir aussi
L'intérêt de cette balise est qu'elle permet de transmettre des arguments à une url grâce à un pseudo-lien non suivable par un robot (les robots ne « cliquent » pas sur un bouton submit).
C'est particulièrement utile dans le cadre d'une url qui renvoit vers un script d'intervention sur les données en base. Il faut alors protéger le lien vers cette url de tout risque d'être suivi par un robot.
#BOUTON_ACTION est là pour ça.

La balise est à utiliser ainsi :

#BOUTON_ACTION{libellé, url, class, message de confirmation}

Le 1^er argument indique le libellé du bouton.

Le 2^e argument, url, pourra être fourni par la balise #URL_ACTION_AUTEUR.

Le 3^e argument, optionnel, est un nom de classe css ou une suite de classes CSS, qui s'appliquent au bouton ; lui donner la valeur « ajax » permet au bouton de se comporter comme un lien ajax ; avec la classe « noscroll » en plus, l'appel ajax se fait sans que le navigateur ne scrolle au début de la page.

Depuis SPIP 4.0, si cet argument contient 'ajax', c'est au formulaire qui contient le bouton qu'est affectée la classe 'ajax'. Au besoin, on peut utiliser le filtre |ajouter_class pour attribuer d'autres classes au formulaire.

Le 4^e argument, optionnel, permet de préciser le message de confirmation affiché lors de la validation du bouton.

- Attention :

si vous désirez préciser un message de confirmation, vous devez aussi renseigner le 3^e argument : #BOUTON_ACTION{libellé, url ,message de confirmation} ne fonctionnera pas comme vous l'entendez (« message de confirmation » sera passé comme nom de classe css). Pour préciser un message de confirmation sans préciser de classe css, écrire :
#BOUTON_ACTION{libellé, url , '', message de confirmation}
Si vous utilisez des caractères accentués dans votre message de confirmation, vous devez les traduire en référence numérique de caractère (é => é).

Exemple :

#BOUTON_ACTION{valider, #URL_PAGE{mon_script}|parametre_url{var1, val1}|parametre_url{var2, val2}|parametre_url{var3, val3}, ajax, êtes-vous sûr ?}

produira le source html suivant :

Le 5eme argument, facultatif, est le title du bouton

Le 6eme argument, facultatif, est un callback sur le onclick de la balise générée. Des exemples figurent dans la documentation de ajaxReload.

Voir aussi

- Sur programmer.spip : https://programmer.spip.net/+-BOUTON_ACTION-+
- Source : La fonction balise_BOUTON_ACTION_dist qui apporte encore quelques précisions sur la balise éponyme.

|lien_ou_expose

cam.lafit, denisb — 2010-04-16T16:55:01Z

Le filtre |lien_ou_expose retourne soit un lien cliquable soit un simple intitulé.

Sommaire
Voir aussi
Appliqué à une URL, le filtre |lien_ou_expose{intitulé, condition} affiche en fonction du résultat de la condition soit le lien cliquable vers cette url si la condition n'est pas vérifiée, soit seulement l'intitulé passé en argument si la condition est vérifiée.

Exemple :

[(#URL_RUBRIQUE|lien_ou_expose{#TITRE, #ENV{test}|=={en_cours}})]

affichera s'il existe une variable de nom « test » et de valeur « en_cours » dans l'environnement :
Titre_de_la_rubrique
affichera sinon :
Titre_de_la_rubrique

Le filtre accepte aussi 3 arguments supplémentaires optionnels « class », « title » et « rel ». Ces arguments s'appliquent au lien dans le cas où la condition n'est pas vérifiée.

[(#URL_RUBRIQUE|lien_ou_expose{#TITRE, #ENV{test}|=={en_cours}, spip_lien, la super rubrique, biblioentry})]

produisant alors soit le source HTML suivant (en fonction de la condition) :
Titre_de_la_rubrique
soit :
Titre_de_la_rubrique

À partir de SPIP 4.0 Le 2eme argument du filtre SPIP (3eme argument de la fonction PHP) peut valoir un selecteur CSS simplifié de type a.active ou strong.active.expose pour préciser la balise (a, span ou strong uniquement) et la ou les classes à utiliser quand on est exposé.

Exemple :

[(#URL_RUBRIQUE|lien_ou_expose{#TITRE, #ENV{test}|=={en_cours}|?{a.monlien.active}, 'monlien'})]
Voir aussi
Exposer un article dans une liste
Utiliser des URLs personnalisées

|balise_img

cam.lafit, peetdu — 2010-04-16T15:52:18Z

Le filtre |balise_img génère un tag image complet à partir de l'url relative d'un fichier image ou d'une balise image déjà formée.

Sommaire
Utilisation
Paramètres optionnels
Voir aussi
Utilisation

[(#CHEMIN{monimage.png}|balise_img)]

produira le tag :

Le filtre |balise_img s'applique à un fichier JPG, PNG ou GIF et à partir de SPIP 4.0, il peut également
- s'appliquer aux fichiers .SVG
- s'appliquer à une balise déjà formée, par exemple issue d'un filtre image :

[(#FICHIER|image_reduire{200,200}|balise_img{'un nuage','spip_logo'})]

Paramètres optionnels
alt texte alternatif ; une valeur nulle pour explicitement ne pas avoir de balise alt sur l'image (au lieu d'un alt vide)
class null par defaut (ie si img est une balise, son attribut class sera inchangé. pas de class insérée
size permettant de spécifier la taille du rendu - à partir de SPIP 4.0.
[(#CHEMIN{monimage.png}|balise_img{paysage, spip_doc})]

produira le tag :

À partir de SPIP 4.0, le dernier argument size permet de forcer la taille. Cet argument peut prendre plusieurs formes :

- @1.5x, @2x ou @3x permet de forcer une densité de 1.5, 2 ou 3 (le x est ici le multiplicateur de densité par rapport a la taille initiale). Une image de largeur 200px affichée avec un @2x aura donc un attribut width='100'.

- Un nombre seul comme 64 pour forcer une image carrée avec width='64' height='64'

- Une largeur ET une hauteur sous la forme 1024x640 pour avoir un width='1024' height='640'

- Une largeur seule et une hauteur automatique sous la forme 1024x* pour avoir donc un width='1024' et un height ajusté automatiquement pour respecter les proportions initiales de l'image.

Pour faciliter l'utilisation du filtre, l'argument de taille (optionnel) arrive toujours en dernier, même si on ne precise pas de alt ou de class :

[(#FICHIER|balise_img{1024x640})] [(#FICHIER|balise_img{'un nuage',1024x640})] [(#FICHIER|balise_img{'un nuage','spip_logo',1024x640})]

Mais si jamais le alt ou la class sont ambigu et peuvent être interprétés comme une taille, il suffit d'indiquer une taille vide pour lever l'ambiguité :

[(#FICHIER|balise_img{'un nuage','x2',''})]

Le filtre peut donc ainsi facilement être utilisé pour ajuster l'affichage d'image en x2 ou x3 pour prendre en compte les écrans rétina :

[(#FICHIER|image_reduire{400,400}|balise_img{'Mon image HD',x2})]

Remarques

- L'emploi d'un paramètre x2 pour la densité de l'image force, quoiqu'il arrive, une double taille même si l'écran n'est pas HD. Ça ne remplace donc pas les plugins spécialisés (adaptive_image et image_responsive par ex), mais ça les complète pour gérer par exemple des petites images de décoration ou des pictogrammes png : il suffit de fournir le pictogramme en 64px et on l'affiche en 32px pour qu'il soit de bonne qualité partout.

- Pour les images SVG, ce filtre permet de contrôler la taille d'affichage indépendamment de la taille par défaut inscrite dans le fichier.

Voir aussi

Les balises

#CHEMIN
#CHEMIN_IMAGE

les filtres

|balise_svg
|inserer_attribut
|vider_attribut
|embarque_fichier
|embarque_src
|timestamp

{critère ?opérateur valeur}

cam.lafit, denisb — 2010-03-01T08:10:46Z

Prendre en compte le critère uniquement si pour ce critère une valeur est présente dans l'environnement.

Sommaire
Voir aussi
Le critère ne sera pris en compte par la boucle que si une variable de même nom est présente dans l'environnement.

Par exemple :

{date ?!= #ENV{date}} {email ?LIKE %(#ENV{email})%}

ou encore :

s'il existe une variable de nom titre dans l'environnement d'exécution de la boucle, alors la boucle ne sélectionnera que les données correspondantes à titre <= #ENV{titre} (les articles dont le titre est alphabétiquement placé avant le titre présent dans l'environnement)
s'il n'existe pas de titre dans l'environnement d'exécution de la boucle, le critère sera totalement ignoré (tous les articles seront sélectionnés).

- On notera que si peu importe la présence ou non d'espaces avant ou après l'opérateur ({titre ?<= #ENV{titre}} est équivalent à {titre?<=#ENV{titre}}), le ? doit être collé à l'opérateur.

Voir aussi

Autre critère conditionnel

critère ?

Opérateurs logiques

critère !opérateur valeur
!critère opérateur valeur

Opérateurs

critère LIKE valeur
critère IN valeur1, valeur2[, valeur3,..., valeurN]