uZine 3

La boucle DOCUMENTS

l'équipe de SPIP — 2002-06-14T22:00:00Z

[SPIP 1.4] La boucle DOCUMENTS retourne une liste de documents multimédia associés (à un article, à une rubrique, éventuellement les images incluses dans une brève).

<BOUCLEn(DOCUMENTS){critères...}>

Cette boucle gère non seulement les documents joints non installés dans le texte d'un article, mais peut aussi accéder aux images (depuis la version 1.4, les images sont gérées, au niveau du programme, comme un genre spécifique de documents), aux vignettes de prévisualisation et aux documents déjà insérés dans le corps de l'article.

Pour mémoire, on utilisera donc le plus fréquemment (utilisation courante) la boucle DOCUMENTS avec, au minimum, les critères suivants (explications ci-après) :

<BOUCLEn(DOCUMENTS){mode=document}{doublons}>

Les critères de sélection

Une boucle DOCUMENTS s'utilise en général à l'intérieur d'un article ou d'une rubrique (éventuellement dans une brève, mais ici l'utilisation sera réservée à la récupération d'images, ce qui sera très spécifique).

{id_article} retourne les documents de l'article dont l'identifiant est id_article.

{id_rubrique} retourne les documents de la rubrique id_rubrique.

{id_breve} retourne les documents de la brève id_breve (il n'est pas possible d'associer des documents multimédia à une brève, seulement des images ; l'utilisation d'une boucle DOCUMENTS dans ce cadre sera donc très spécifique).

Notez bien : il n'est pas possible d'utiliser ici le critère {id_secteur} ; les documents sont conçus pour être intimement liés aux articles et aux rubriques, et non à être appelés seuls sans ces éléments (on parle dans SPIP de « documents joints »).

Les critères d'affichage

{mode=document} ou {mode=image} permet d'indiquer si l'on veut appeler les documents multimédia, ou les images (en effet, désormais les images associées à l'article et éventuellement insérées dans l'article sont traités comme des documents en mode=image).

N.B. Dans les sites SPIP existant avant la version 1.4, l'habitude a été prise de ne pas pouvoir afficher les images qui ne sont pas insérées à l'intérieur du texte de l'article. De fait, si vous ajoutez un boucle DOCUMENTS en mode=image sur un site déjà existant, vous risquez de voir réapparaître dans cette boucle des images qui n'étaient pas destinées à être publiées sur le site public. Donc, n'utilisez une telle boucle que sur un site créé avec la version 1.4, ou bien procédez avec beaucoup de précautions (vérifiez les anciens articles pour éviter la publication d'images parasites).

{doublons} prend ici une importance particulière : elle permet non seulement de ne pas réafficher des documents déjà affichés par une autre boucle, mais également de ne pas réafficher les documents déjà intégrés à l'intérieur d'un article. Si l'on oublie ce critère, on affichera tous les documents associés à un article, y compris ceux qui auraient déjà été affichés à l'intérieur du texte.

{extension=...} permet de sélectionner les documents selon leur terminaison (terminaison du fichier multimédia, par exemple « mov », « ra », « avi »...). Cela peut être utilisé par exemple pour réaliser un porfolio, c'est-à-dire une boucle n'affichant que les documents de type image, une seconde boucle ensuite, avec une présentation graphique différente, les autres types de documents :

<BOUCLE_portfolio(DOCUMENTS){id_article}{extension==jpg|png|gif}{mode=document}{doublons}>

Cette BOUCLE_portfolio récupère les documents joints à un article, non déjà affichés dans le texte de l'article, et donc les extensions des fichiers peuvent être « jpg », « png » ou « gif ».

Les balises

#LOGO_DOCUMENT affiche le logo (vignette de prévisualisation) associé à cet article ; si une vignette personnalisée n'a pas été installée manuellement par l'auteur de l'article, SPIP utilise une vignette standard selon le type du fichier.

#URL_DOCUMENT est l'URL du fichier multimédia. Pour afficher une vignette cliquable pointant vers le document multimédia, on utilisera donc le code suivant :

[(#LOGO_DOCUMENT|#URL_DOCUMENT)]

#TITRE affiche le titre du document.

#DESCRIPTIF affiche le descriptif du document.

#TYPE_DOCUMENT affiche le type (fichier Quicktime, fichier Real...) du document multimédia.

#TAILLE affiche la taille du fichier multimédia. Ce chiffre est fourni en octets. Pour de gros fichiers, cette valeur devient rapidement inutilisable ; on pourra donc lui appliquer le filtre taille_en_octets, qui affichera successivement en octets, en kilooctets, ou même en mégaoctets :

[(#TAILLE|taille_en_octets)]

#LARGEUR et #HAUTEUR fournissent les dimensions en pixels.

#ID_DOCUMENT affiche le numéro du document.

#EMBED_DOCUMENT est une balise à l'utilisation très spécifique : elle permet d'inclure directement les fichiers de formats autorisés (vidéo, sons) directement dans la page Web ; il faut éviter d'utiliser systématiquement cette balise, car il est déconseillé d'insérer systématiquement les documents dans les pages sans un contrôle strict (sauf à faire exploser la durée de chargement de vos pages Web...). La balise peut être complétée de paramètres propres aux formats utilisés (encore une fois : utilisation très spécifique), par exemple :

[(#EMBED_DOCUMENT|autostart=true)]

La boucle ARTICLES

l'équipe de SPIP — 2001-05-23T22:00:00Z

Une boucle d'articles se code en plaçant ARTICLES
(avec un « s ») entre parenthèses :

<BOUCLEn(ARTICLES){critères...}>

Les éléments contenus dans une telle boucle sont des articles.

Remarque. Une boucle ARTICLES ne retourne que des articles publiés. (Il n'existe aucun moyen d'afficher les articles « en cours de rédaction », « proposés à la publication » ou « refusés ».)

Les critères de sélection

On utilisera l'un ou autre des critères suivants pour indiquer comment on sélectionne les éléments.

{tout} les articles sont sélectionnés dans l'intégralité du site (dans toutes les rubriques). Utile notamment pour afficher les articles les plus récents (dans l'intégralité du site) sur la page d'accueil. [En réalité, le critère « tout » n'est pas traité de manière informatique : c'est un aide-mémoire pour le webmestre ; on obtient le même résultat en n'indiquant aucun des critères suivants.]

{id_article} retourne l'article dont l'identifiant est id_article. Comme l'identifiant de chaque article est unique, ce critère ne retourne qu'une ou zéro réponse.

{id_rubrique} retourne la liste des articles contenus dans la rubrique id_rubrique.

{id_secteur} retourne les articles dans ce secteur (un secteur est une rubrique qui ne dépend d'aucune autre rubrique, c'est-à-dire située à la racine du site).

[SPIP 1.4] {branche} : le critère {branche} retourne l'ensemble des articles de la rubrique ET de ses sous-rubriques. (C'est une sorte d'extension du critère {id_secteur}. Toutefois, à l'inverse de {id_secteur=2}, il n'est pas possible d'appeler directement une branche en faisant par exemple {branche=2} : techniquement parlant, il faut que la rubrique en question figure dans le contexte courant. Ce critère est à utiliser avec parcimonie : si votre site est bien structuré, vous ne devriez pas en avoir besoin, sauf dans des cas très particuliers.)

{id_auteur} retourne les articles correspondant à cet identifiant d'auteur (utile pour indiquer la liste des articles écrits par un auteur).

{id_mot} retourne les articles correspondant à cet identifiant de mot-clé (utile pour indiquer la liste des articles traitant d'un sujet donné).

[SPIP 1.3] {titre_mot=xxxx}, ou {type_mot=yyyy} retourne les articles liés au mot-clé dont le nom est « xxxx », ou liés à des mots-clés du groupe de mots-clés « yyyy ». Attention, on ne peut pas utiliser plusieurs critères {titre_mot=xxxx} ou {type_mot=yyyy} dans une même boucle.

[SPIP 1.4] {id_groupe=zzzz} permet de sélectionner les articles liés à un groupe de mots-clés ; principe identique au {type_mot} précédent, mais puisque l'on travaille avec un identifiant (numéro du groupe), la syntaxe sera plus « propre ». [Nota : Ce critère n'est pas (en l'état actuel du développement de SPIP) cumulable avec le précédent {type_mot=yyyy}]

{recherche} retourne les articles correspondant aux mots indiqués dans l'interface de recherche (moteur de recherche incorporé à SPIP). Voir la page consacrée au moteur de recherche.

Les critères d'affichage

Une fois fixé l'un des critères ci-dessus, on pourra ajouter les critères suivants pour restreindre le nombre d'éléments affichés.

Les critères communs à toutes les boucles s'appliquent évidemment.

{exclus} permet d'exclure du résultat l'article dans lequel on se trouve déjà (par exemple, lorsque l'on affiche les articles contenus dans la même rubrique, on ne veut pas afficher un lien vers l'article dans lequel on se trouver déjà).

{doublons} ou {unique} (ces deux critères sont rigoureusement identiques) permettent d'interdire l'affichage d'articles déjà affichés dans d'autres boucles elles-mêmes marquées {doublons}.

Les balises de cette boucle

Les balises tirées de la base de données

Les balises suivantes correspondent aux éléments directement tirés de la base de données. Vous pouvez les utiliser également en tant que critère de classement (par exemple : {par date} ou {par titre}).

#ID_ARTICLE affiche l'identifiant unique de l'article. Utile pour fabriquer des liens hypertextes non prévus (par exemple vers une page « Afficher au format impression ».

#SURTITRE retourne le surtitre.

#TITRE retourne le titre de l'article.

#SOUSTITRE retourne le soustitre.

#DESCRIPTIF retourne le descriptif.

#CHAPO retourne le texte d'introduction (chapeau).

#TEXTE retourne le texte principal de l'article.

#PS retourne le post-scriptum.

Les dates : #DATE, #DATE_REDAC, #DATE_MODIF sont explicitées dans la documentation sur « La gestion des dates ».

#ID_RUBRIQUE est l'identifiant de la rubrique dont dépend l'article.

#ID_SECTEUR est l'identifiant du secteur dont dépend l'article (le secteur étant la rubrique située à la racine du site).

#VISITES est le nombre de visites sur cet article.

#POPULARITE donne le pourcentage de popularité de cet article, voir la documentation La « popularité » des articles.

Les balises calculées par SPIP

Les éléments suivants sont calculés par SPIP. (Ils ne peuvent pas être utilisés comme critère de classement.)

#NOTES les notes de bas de page (calculées à partir de l'analyse du texte).

#INTRODUCTION : [SPIP 1.4] si l'article contient un descriptif, c'est celui-ci qui est utilisé ici ; sinon, SPIP affiche les 600 premiers caractères du début de l'article (chapeau puis texte). [SPIP 1.3] Dans les versions précédentes de SPIP, ce sont systématiquement les premiers caractères de l'article (chapeau puis texte) qui sont pris en compte (le descriptif n'est pas utilisé).

#LESAUTEURS les auteurs de cet article. Cela permet d'éviter de créer une boucle AUTEURS pour obtenir le même résultat.

#URL_ARTICLE est l'URL de la page de l'article.

#FORMULAIRE_FORUM fabrique l'interface permettant de poster un message répondant à cet article.

#FORMULAIRE_SIGNATURE fabrique l'interface permettant de signer la pétition associée à cet article.

#PARAMETRES_FORUM fabrique la liste des variables exploitées par l'interface du formulaire permettant de répondre à cet article. Par exemple :
[Répondre à cet article]

Les logos

#LOGO_ARTICLE le logo de l'article, éventuellement avec la gestion du survol.

#LOGO_ARTICLE_RUBRIQUE le logo de l'article, éventuellement remplacé par le logo de la rubrique s'il n'existe pas de logo spécifique à l'article.

#LOGO_RUBRIQUE le logo de la rubrique de l'article.

Les logos s'installent de la manière suivante :

[(#LOGO_ARTICLE|alignement|adresse)]

L'alignement peut être left ou right. L'adresse est l'URL de destination du lien de ce logo (par exemple #URL_ARTICLE). Si l'on n'indique pas d'adresse, le bouton n'est pas cliquable.

Si l'on veut récupérer directement le nom du fichier du logo (alors que les balises précédentes fabriquent le code HTML complet pour insérer l'image dans la page), par exemple pour afficher une image en fond de tableau, on utilisera le filtre |fichier comme suit : [(#LOGO_ARTICLE|fichier)]

Par ailleurs deux balises permettent de récupérer un seul des deux logos :
#LOGO_ARTICLE_NORMAL est le logo sans survol ;
#LOGO_ARTICLE_SURVOL est le logo de survol.

La boucle RUBRIQUES

l'équipe de SPIP — 2001-05-21T22:00:00Z

La boucle RUBRIQUES retourne une liste de... rubriques (étonnant, non ?)

Remarque. Une boucle RUBRIQUES n'affiche que des rubriques « actives », c'est-à-dire contenant des articles publiés, des documents joints (à partir de [SPIP 1.4]), des sites publiés - ou des sous-rubriques elles-mêmes actives. De cette façon, on évite de se trouver dans des rubriques « culs de sac » n'offrant aucun élément de navigation.

Les critères de sélection

On utilisera l'un ou autre des critères suivants pour indiquer comment on sélectionne les éléments.

{tout} les rubriques sont sélectionnées dans l'intégralité du site.

{id_rubrique} retourne la rubrique dont l'identifiant est id_rubrique. Comme l'identifiant de chaque rubrique est unique, ce critère retourne une ou zéro réponse.

{id_secteur} retourne les rubriques de ce secteur. (On peut également, par extension, utiliser le critère {branche} décrit dans La boucle ARTICLES).

{id_parent} retourne la liste des rubriques contenues dans une rubrique.

{racine} retourne la liste des secteurs (rigoureusement identique à {id_parent=0}).

{id_enfant} retourne la rubrique qui contient la rubrique (une seule réponse ; ou zéro réponse si la présente rubrique est située à la racine du site).

{meme_parent} retourne la liste des rubriques dépendant de la même rubrique que la rubrique en cours. Permet d'afficher les rubriques « s ?urs » qui se trouvent au même niveau dans la hiérarchie.

{recherche} retourne les rubriques correspondant aux mots indiqués dans l'interface de recherche (moteur de recherche incorporé à SPIP). Voir la page consacrée au moteur de recherche.

À partir de la version SPIP 1.4, les rubriques peuvent être liées à des mots-clés. Les critères de mots-clés peuvent donc être désormais utilisés dans les boucles (RUBRIQUES) :

{id_mot}, {titre_mot=xxx} récupèrent les rubriques liées au mot dont le numéro est id_mot ou dont le titre est titre_mot ;
{id_groupe}, {type_mot=yyyy} récupèrent les rubriques liées à des mots du groupe id_groupe, ou du groupe dont le titre est type_mot.

Les critères d'affichage

Une fois fixé l'un des critères ci-dessus, on pourra ajouter les critères suivants pour restreindre le nombre d'éléments affichés.

Les critères communs à toutes les boucles s'appliquent évidemment.

{exclus} permet d'exclure du résultat la rubrique dans lequel on se trouve déjà (utile avec meme_parent).

{doublons} ou {unique} (ces deux critères sont rigoureusement identiques) permettent d'interdire l'affichage de rubriques déjà affichées dans d'autres boucles.

Les balises de cette boucle

Les balises tirées de la base de données

Les balises suivantes correspondent aux éléments directement tirés de la base de données. Vous pouvez les utiliser également en tant que critère de classement (généralement : {par titre}).

#ID_RUBRIQUE affiche l'identifiant unique de la rubrique.

#TITRE retourne le titre de la rubrique.

#DESCRIPTIF retourne le descriptif.

#TEXTE retourne le texte principal de la rubrique.

#ID_SECTEUR est l'identifiant du secteur dont dépend la rubrique (le secteur étant la rubrique située à la racine du site).

Les balises calculées par SPIP

Les éléments suivants sont calculés par SPIP. (Ils ne peuvent pas être utilisés comme critère de classement.)

#NOTES les notes de bas de page (calculées à partir de l'analyse du texte).

#INTRODUCTION les 600 premiers caractères du texte, les enrichissements typographiques (gras, italique) sont supprimés.

#URL_RUBRIQUE est l'URL de la page de la rubrique.

[SPIP 1.4] #DATE affiche la date de la dernière publication effectuée dans la rubrique et/ou ses sous-rubriques (articles, brèves...).

#FORMULAIRE_FORUM fabrique l'interface permettant de poster un message répondant à cette rubrique.

#PARAMETRES_FORUM fabrique la liste des variables exploitées par l'interface du formulaire permettant de répondre à cette rubrique. Par exemple :
[Répondre à cette rubrique]

#FORMULAIRE_SITE
[SPIP 1.4] Le #FORMULAIRE_SITE affiche une interface permettant aux visiteurs du site de proposer des référencements de sites. Ces sites apparaîtront comme « proposés » dans l'espace privé, en attendant une validation par les administrateurs.

Ce formulaire ne s'affiche que si vous avez activé l'option « Gérer un annuaire de sites » dans la Configuration sur site dans l'espace privé, et si vous avez réglé « Qui peut proposer des sites référencés » sur « les visiteurs du site public ».

Le logo

#LOGO_RUBRIQUE le logo de la rubrique, éventuellement avec la gestion du survol. S'il n'y a pas de logo pour cette rubrique, SPIP va automatiquement chercher s'il existe un logo pour la rubrique dont elle dépend, et ainsi de suite de manière récursive.

Le logo s'installe de la manière suivante :

[(#LOGO_RUBRIQUE|alignement|adresse)]

[SPIP 1.4] #LOGO_RUBRIQUE_NORMAL affiche le logo « sans survol » ; #LOGO_RUBRIQUE_SURVOL affiche le logo de survol : ces deux balises permettent par exemple, quand on est dans une rubrique, de gérer un logo « avec survol » pour les liens vers les autres rubriques, et de laisser le logo de survol seul dans la rubrique active.

La boucle SITES (ou SYNDICATION)

l'équipe de SPIP — 2001-05-11T22:00:00Z

La boucle SITES (SPIP 1.3) retourne une liste de sites référencés. (Si l'on a syndiqué des sites référencés, cette boucle s'utilise, naturellemet, associée à une boucle SYNDIC_ARTICLES qui permet de récupérer la liste des article de ces sites.)

<BOUCLEn(SITES){critères...}>

Avant la version 1.3 de SPIP, cette boucle était nommée SYNDICATION, car seuls des sites syndiqués pouvaient être référencés. Les deux dénominations sont rigoureusement équivalentes (mais « SITES » correspond mieux au fait que, depuis la version 1.3, il s'agit d'un système de référencement de sites, la syndication étant une option).

<BOUCLEn(SYNDICATION){critères...}>

Les critères de sélection

On utilisera l'un ou autre des critères suivants pour indiquer comment on sélectionne les éléments.

{tout}, tous les sites référencés.

{id_syndic} retourne le site référencés dont l'identifiant est id_syndic.

{id_rubrique} retourne les sites référencés dans cette rubrique.

{id_secteur} retourne les sites référencés dans ce secteur.

[SPIP 1.3] {id_mot} retourne toutes les sites liés au mot-clé en cours (à l'intérieur d'une boucle de type (MOTS).

[SPIP 1.3] {titre_mot=xxxx}, ou {type_mot=yyyy} retourne les sites
liés au mot-clé dont le nom est « xxxx », ou liés à des mots-clés du groupe de mots-clés « yyyy ». Attention, on ne peut pas utiliser plusieurs critères {titre_mot=xxxx} ou {type_mot=yyyy} dans une même boucle.

[SPIP 1.4]{id_groupe=zzzz} permet de sélectionner les sites liés à un groupe de mots-clés ; principe identique au {type_mot} précédent, mais puisque l'on travaille avec un identifiant (numéro du groupe), la syntaxe sera plus « propre ».

Les critères d'affichage

Les critères communs à toutes les boucles s'appliquent.

{moderation=oui} [SPIP 1.4] affiche les sites syndiqués dont les liens sont bloqués a priori (« modérés ») ; l'inverse de ce critère est {moderation!=oui}.

(SPIP 1.3) {syndication=oui}, {syndication=non} permet de n'afficher que les sites référencés faisant l'objet d'une syndication, ou les sites non syndiqués.

(SPIP 1.2) {doublons} ou {unique} (ces deux critères sont rigoureusement identiques) permettent d'interdire l'affichage de sites référencés déjà affichés dans d'autres boucles.

Les balises de cette boucle

Les balises tirées de la base de données

Les balises suivantes correspondent aux éléments directement tirés de la base de données. Vous pouvez les utiliser également en tant que critère de classement (généralement : {par titre}).

#ID_SYNDIC affiche l'identifiant unique du site syndiqué.

#NOM_SITE est le nom du site syndiqué.

#URL_SITE est l'adresse (URL) du site syndiqué.

#DESCRIPTIF est le descriptif du site syndiqué.

#ID_RUBRIQUE est le numéro de la rubrique contenant cette syndication.

#ID_SECTEUR est le numéro de la rubrique-secteur (à la racine du site) contenant cette syndication.

Autres balises

#LOGO_SITE affiche le logo attribué au site.

#URL_SYNDIC affiche l'adresse (URL) du fichier de syndication de ce site.