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 BREVES

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

La boucle BREVES, comme son nom l'indique, retourne une liste de brèves.

<BOUCLEn(BREVES){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} les brèves sont sélectionnées dans l'intégralité du site.

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

{id_rubrique} retourne toutes les brèves contenues dans la rubrique en cours.

[SPIP 1.2] {id_mot} retourne toutes les brèves liées 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 brèves
liées au mot-clé dont le nom est « xxxx », ou liées à 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 brèves liées à 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 ».

{recherche} retourne les brèves 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

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

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_BREVE affiche l'identifiant unique de la brève.

#TITRE retourne le titre de la brève.

#DATE retourne la date de publication de la brève.

#TEXTE retourne le texte de la brève.

#NOM_SITE le nom du site indiqué en références.

#URL_SITE l'adresse (URL) du site indiqué en références.

#ID_RUBRIQUE l'identifiant de la rubrique dont dépend cette brève.

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_BREVE est l'URL de la page de la brève.

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

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

Le logo

#LOGO_BREVE le logo de la brève, éventuellement avec la gestion du survol.

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

LOGO_BREVE|alignement|adresse)]

#LOGO_BREVE_RUBRIQUE affiche, si il existe, le logo de la brève ; si ce logo n'a pas été attribué, SPIP affiche le logo de la rubrique [SPIP 1.4].

La boucle FORUMS

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

La boucle FORUMS retourne une liste de messages de forums.

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.

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

{id_article} retourne les messages correspondant à cet article.

{id_rubrique} retourne les messages correspondant à cette rubrique.

{id_breve} retourne les messages correspondant à cette brève.

{id_parent} retourne les messages dépendant d'un autre message. Indispensable pour gérer des threads dans les forums.

{id_enfant} retourne le message dont dépend le message actuel (permet de « remonter » dans la hiérachie des threads). (SPIP 1.3)

{meme_parent} retourne les autres messages répondant à un même message. (SPIP 1.3)

{plat} : par défaut, seuls les messages n'ayant pas de parent (i.e. à la racine d'un thread) sont affichés.
En ajoutant ce critère, vous pouvez sélectionner tous les messages quelle que soit leur position dans un thread (dans la limite
des autres critères, bien sûr). Cela permet d'afficher les messages par ordre strictement chronologique par exemple, ou de compter
le nombre total de contributions dans un forum.

{id_secteur} retourne les messages correspondant au secteur. A priori, peu utile ; mais cela permet par exemple de faire un grand forum thématique regroupant tous les messages d'un secteur, quel que soit l'endroit où l'on se trouve.

À partir de la version SPIP 1.4, les messages des forums 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 (FORUMS) :

{id_mot}, {titre_mot=xxx} récupèrent les messages liés 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 messages liés à des mots du groupe id_groupe, ou du groupe dont le titre est type_mot.

Les critères d'affichage

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

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_FORUM affiche l'identifiant unique du message.

#ID_BREVE affiche l'identifiant de la brève à laquelle ce message est attaché. Attention, cela n'est pas récursif : un message qui répond à un message attaché à une brève ne contient pas lui-même le numéro de la brève.

#ID_ARTICLE est l'identifiant de l'article à laquelle le message répond.

#ID_RUBRIQUE l'identifiant de la rubrique à laquelle le message répond.

#DATE est la date de publication.

#TITRE est le titre.

#TEXTE est le texte du message.

#NOM_SITE le nom du site Web indiqué par l'auteur.

#URL_SITE l'adresse (URL) de ce site Web.

#NOM est le nom de l'auteur du message.

#EMAIL est l'adresse email de l'auteur.

#IP est l'adresse IP de l'auteur du message au moment de l'envoi de sa contribution.

Les balises calculées par SPIP

#FORMULAIRE_FORUM fabrique l'interface permettant de poster un message de réponse.

#PARAMETRES_FORUM fabrique la liste des variables exploitées par l'interface du formulaire permettant de répondre à ce message. Par exemple :

[<a href="forum.php3?(#PARAMETRES_FORUM)">Répondre à ce message</a>]

La boucle MOTS

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

La boucle MOTS retourne une liste de mots-clé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 mots sont sélectionnés dans l'intégralité du site.

{id_mot} retourne le mot-clé dont l'identifiant est id_mot.

{id_groupe} retourne les mots-clés associés au groupe de mots dont le numéro est id_groupe [SPIP 1.4].

{id_article} retourne les mots-clés associés à cet article (c'est l'utilisation la plus courante de cette boucle).

{id_rubrique} retourne les mots-clés associés à une rubrique [SPIP 1.4].

{id_breve} retourne les mots associés à une brève [SPIP 1.4].

{id_syndic} retourne les mots associés à un site référencé [SPIP 1.4].

{id_forum} retourne les mots associés à un message de forum [SPIP 1.4] (attention, utilisation très spécifique).

{titre=france} retourne le mot-clé intitulé france (par exemple).

{type=pays} retourne les mots-clés du groupe de mots-clés intitulé pays (par exemple).

Les critères d'affichage

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

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_MOT affiche l'identifiant unique du mot.

#TITRE est le titre (le mot-clé lui-même).

#DESCRIPTIF est le descriptif du mot.

#TEXTE est le texte associé au mot.

#TYPE est la catégorie dans laquelle est installé ce mot-clé (par exemple, le mot-clé « France » pourrait être associé à la catégorie « Pays »).

#LOGO_MOT [SPIP 1.4] affiche le logo associé au mot-clé.

#URL_MOT donne l'adresse de ce mot

La boucle (GROUPES_MOTS)

D'une utilisation marginale, la boucle GROUPES_MOTS [SPIP 1.5]
mérite d'être citée ici : elle permet, si vous avez plusieurs groupes de mots-clés, de sélectionner ces groupes, et d'organiser par exemple une page récapitulative de tous les mots-clés classés par groupe, puis par ordre alphabétique à l'intérieur de chaque groupe, par exemple via le code suivant :

<BOUCLE_groupes(GROUPES_MOTS){par titre}> <h1>#TITRE</H1> <BOUCLE_mots(MOTS){id_groupe}{par titre}{" - "}> #TITRE </BOUCLE_mots> </BOUCLE_groupes>

Les balises et critères associés à cette boucle sont :
#ID_GROUPE, l'identifiant du groupe de mots [également disponible dans la boucle(MOTS)] ;
#TITRE, le titre du groupe [à l'intérieur de la boucle(MOTS), vous pouvez utiliser #TYPE pour afficher cette valeur].