SPIP

|lignes_longues

denisb, Teddy — 2022-09-23T04:42:06Z

Avertissement : ce filtre historique est déprécié et il sera supprimé en SPIP 5. On pourra le remplacer avantageusement par une instruction CSS de type word-wrap:break-word;

Le filtre |lignes_longues, introduit des césures dans les mots « trops longs » en y insérant des espaces sécables qui permettent alors le passage à la ligne (utile, par exemple, pour afficher des urls dans une colonne étroite).

Ainsi, si le #TEXTE d'un article contient un lien comme :

http://www.spip.net/spip.php?page=recherche&recherche=lignes_longues

alors

 [(#TEXTE|lignes_longues{20})]

affichera

http://www.spip.net /spip. php?page=recherche& recherche=lignes_longues

Noter que la césure conserve les tag html ; dans l'exemple ci-dessus, tout le lien est cliquable comme on peut le voir dans le source html.

Ce filtre coupe par défaut à 70 caractères, mais on peut spécifier une autre longueur en passant un paramètre au filtre, par exemple :
[(#TEXTE|lignes_longues{40})]

_TAGS_NOM_AUTEUR

denisb — 2013-12-04T00:48:49Z

La constante _TAGS_NOM_AUTEUR liste les « tags html » autorisés dans l'intitulé du nom (signature) d'un auteur. Mise en œuvre depuis SPIP 3.0.14, SPIP 2.1.25 et SPIP 2.0.24, sa valeur par défaut est : « '' » (aucun tag n'est autorisé).

La constante _TAGS_NOM_AUTEUR répond au problème créé par la possibilité laissée aux auteurs d'insérer dans l'intitulé de leur nom (signature) des tags html. Cela laisse la porte ouverte à des «

`Lulu`

», « Toto » et autres «

R


O


R


O

» (ou encore d'autres tags aux conséquences plus néfastes).

Aussi, pour une meilleure sécurité, SPIP a-t-il décidé d'interdire strictement par défaut l'utilisation de tout « tag html » sauf le tag qui permet à un auteur de renseigner son nom/signature dans plusieurs langues/graphies (par exemple : [fr]Samira [ar] سميرة[he] סמירה).

Il est toutefois possible de personnaliser la valeur de la constante _TAGS_NOM_AUTEUR dans votre fichier config/mes_options.php (voir l'article qui lui est consacré).

Exemple :

// autoriser les tag , , ,  et 
 // dans le nom/signature d'un auteur. // par défaut,  est toujours autorisé. define('_TAGS_NOM_AUTEUR', 'b, i, em, sc, br');

_HTML_BG_CRON_FORCE

denisb — 2013-11-30T19:02:26Z

La constante _HTML_BG_CRON_FORCE inhibe le lancement du cron par fsockopen/cURL.

La constante _HTML_BG_CRON_FORCE répond au problème relevé sur certains serveurs dont le firewall est réglé pour DROP silencieusement toute requête http sortante : fsockopen attend alors 30s pour lancer la requête à chaque hit avant de rendre la main. cURL lui n'attend pas mais ne sait pas que sa requête échoue. Résultat le CRON ne tourne jamais et le site a un temps de réponse catastrophique…

Si vous savez que vous êtes sur une telle configuration (et que vous ne pouvez pas la changer) il est possible de définir la valeur de la constante _HTML_BG_CRON_FORCE dans votre fichier config/mes_options.php (voir l'article qui lui est consacré).

Exemple :

// pour réduire fortement les temps de réponse du site, // ne pas lancer le cron par fsockopen/cURL // car la configuration du serveur ne le permet pas. define('_HTML_BG_CRON_FORCE', TRUE);

Ce réglage permet aussi de rétablir le fonctionnement des tâches CRON dans le cas où votre site est protégé par un couple de fichiers .htaccess / .htpasswd (voir la constante _DIRECT_CRON_FORCE).

D'un point de vue technique, la définition de cette constante se traduit par l'ajout à la fin de chaque page publique d'un script javascript qui lance une requête asynchrone sur l'action qui traite les tâches CRON. L'utilisation de javascript fait que cela sera efficace même sur un site derrière un cache du type Varnish. Et le fonctionnement asynchrone permet de servir la page sans ralentissement. Si toutefois javascript n'est pas activé sur le navigateur, c'est l'insertion une image qui appelle le CRON et dans ce cas, l'internaute doit attendre.

Voir aussi : la constante _HTML_BG_CRON_INHIB.

|wrap

denisb — 2013-09-28T15:56:20Z

Le filtre |wrap{} permet d'entourer la balise sur laquelle il s'applique avec le tag html précisé en paramètre.

Exemples simples

[(#BALISE|wrap{})]

affichera comme source html :
bla bla

[(#TITRE|wrap{#TOTAL_BOUCLE|=={1}|?{,
}})]

affichera comme source html si la boucle ne retourne qu'un seul résultat :

Le titre

mais affichera :
Le titre Autre titre
si la boucle en retourne plusieurs.

Suites de balises html

Il est aussi possible de passer une série de balises en argument. Les balises finales seront calculées de manière à produire un emboîtement correct. Les balises indiquées en argument du filtre peuvent comporter des attributs.

Exemple :

[(#BALISE|wrap{
})]

affichera comme source html :

bla bla

Participer à la documentation de SPIP

denisb — 2013-06-09T18:34:23Z

Sommaire
Titrer l'article
Résumer l'élément documenté
Décrire le concept
Utiliser les mots clefs
faire au mieux…:-)
Participer à la documentation des balises, critères, filtres de SPIP

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

avoir un compte sur spip.net : https://www.spip.net/spip.php?page=identifiants
connaître une balise, un critère, ... non documenté et connaître un cas d'utilisation associé.
avoir lu cet article pour comprendre les quelques spécificités liées à la documentation
Titrer l'article
pour un filtre : |nom_du_filtre
pour une balise : #NOM_DE_LA_BALISE
pour 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.
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 des backticks 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 »)
hiérarchiser son texte (intertitres, paragraphes) ;
utiliser la notation [{}->N] gérant automatiquement le multilinguisme de la documentation pour référencer l'article numéro N (voir Les auto-références multilingues de la documentation).

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, les exemples trop spécifiques…)
vérifier « a minima » (en lisant le code : http://core.spip.org/projects/spip/repository/show/branches/spip-3.2) les informations fournies
Utiliser les mots clefs
Indiquer la version de spip ayant introduit l'élément documenté. Pour cela utiliser un des mots clés disponibles dans le groupe "Version SPIP (depuis)"
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…:-)

_DEBUG_SLOW_QUERIES

denisb — 2013-05-27T09:16:19Z

Cette constante permet de tracer les requêtes trop lentes.

Pour tracer les requêtes trop lentes dans le fichier système de log des « slow-queries » (MySQL uniquement), vous pouvez définir la constante _DEBUG_SLOW_QUERIES dans votre fichier config/mes_options.php (voir l'article qui lui est consacré).

Exemple :

// ajouter les informations de trace dans les log "slow queries" de mysql define('_DEBUG_SLOW_QUERIES', true);

Voir aussi _BOUCLE_PROFILER.

_STATUS_REDIRECTION_VIRTUEL

denisb — 2013-05-27T08:54:02Z

Cette constante permet de personnaliser le statut de réponse HTTP dans le cas d'une redirection effectuée via la fonction redirige_par_entete().

Par défaut, le statut de réponse HTTP envoyé au serveur est 302 (redirection temporaire), mais il est possible de le modifier en définissant la constante _STATUS_REDIRECTION_VIRTUEL dans votre fichier config/mes_options.php (voir l'article qui lui est consacré)

exemple :

// envoyer un statut 301 (redirection permanente) pour toutes // les redirections de redirige_par_entete define('_STATUS_REDIRECTION_VIRTUEL', 301);

_BOUCLE_PROFILER

denisb — 2013-05-27T08:48:51Z

Cette constante précise la durée (en millisecondes) au-dela de laquelle le calcul d'une boucle sera tracé.

Cette constante permet d'ajouter un fichier de log SPIP (tmp/log/profiler.log) traçant le nom des boucles (et des squelettes appelant) dont le calcul dépasse un seuil défini en millisecondes.
Pour tracer les boucles trop longues, il faut définir la constante _BOUCLE_PROFILER dans votre fichier config/mes_options.php (voir l'article qui lui est consacré)

Exemple :

// tracer les boucles mettant plus de 5 secondes à être calculées define('_BOUCLE_PROFILER', 5000);

Voir aussi : _DEBUG_SLOW_QUERIES.

|extraire_balises

denisb — 2013-05-26T15:27:07Z

Le filtre |extraire_balises{nom_tag} permet de récupérer dans un tableau (array PHP) l'ensemble des tag html de nom « nom_tag » rencontrés dans le source html généré par la balise à laquelle il est appliqué.

Exemple :
[(#TEXTE|extraire_balises{h3}|implode)] récupèrera l'ensemble des intertitres de #TEXTE (ceux qui ont été codés/rédigés avec {{{intertitre}}} dans l'espace privé) et affichera :

premier intertitre intertitre suivant autre intertitre dernier intertitre

Attention toutefois :
|extraire_balises présentera un résultat totalement incohérent (et aléatoire) en cas de recherche d'un « tag html » auto imbriqué, par exemple un
contenant un autre
(ou un
contenant un
…)

Voir aussi |extraire_balise

_AUTOBR

denisb — 2013-05-26T15:26:16Z

Les « retour chariot » dans un paragraphe de texte (en mode édition) sont pris en compte et provoquent un « BR » (plus précisément : \n) [1].

Ainsi, une saisie sur 3 lignes comme ci-dessous

~~~~Jean Valjean ~~~~3, chemin du Poitou ~~~~49780 Doubilloux

sera affichée sur trois lignes de texte, et non plus sur une seule ligne.
Dans l'espace privé, ce nouveau comportement est signalé par l'apposition d'un symbole à chaque saut de ligne.

Pour revenir au fonctionnement avant SPIP 3.0, il suffit de définir la constante _AUTOBR à vide dans votre fichier config/mes_options.php (voir l'article qui lui est consacré).

exemple :

// revenir à l'ancienne gestion des "retour chariot" en mode édition define('_AUTOBR', '');

[1] Cependant le raccourci « _ » (underscore + espace) peut toujours être utilisé ; il est signalé dans l'espace privé par un symbole

SPIP

|lignes_longues

_TAGS_NOM_AUTEUR

`Lulu`

_HTML_BG_CRON_FORCE

|wrap

,

`}})]`

`Le titre`

Le titre

Autre titre

Participer à la documentation de SPIP

Sommaire

Titrer l'article

Résumer l'élément documenté

Décrire le concept

Utiliser les mots clefs

faire au mieux…`:-)`

_DEBUG_SLOW_QUERIES

_STATUS_REDIRECTION_VIRTUEL

_BOUCLE_PROFILER

|extraire_balises

premier intertitre

intertitre suivant

autre intertitre

dernier intertitre

_AUTOBR

SPIP

|lignes_longues

_TAGS_NOM_AUTEUR

Lulu

_HTML_BG_CRON_FORCE

|wrap

,

}})]

Le titre

Le titre

Autre titre

Participer à la documentation de SPIP

Sommaire

Titrer l'article

Résumer l'élément documenté

Décrire le concept

Utiliser les mots clefs

faire au mieux…:-)

_DEBUG_SLOW_QUERIES

_STATUS_REDIRECTION_VIRTUEL

_BOUCLE_PROFILER

|extraire_balises

premier intertitre

intertitre suivant

autre intertitre

dernier intertitre

_AUTOBR

`Lulu`

`}})]`

`Le titre`

faire au mieux…`:-)`