Ajouter des ID aux intertitres

All contributions published for previous SPIP versions

Ce petit filtre ajoute un ID unique à chaque intertitre, pour pouvoir pointer directement vers un intertitre donné (par exemple pour faire rapidement un sommaire de la page).

Il est souvent pratique de pouvoir pointer vers une URL de type page.html#ancre. Nous allons émuler ce comportement avec un petit filtre de SPIP rapide et pas cher :)

Définir les intertitres

Nous avons décidé avant tout de redéfinir les intertitres en <h2> (titres de niveau 2). Dans mes_fonctions.php3 on a donc:

$GLOBALS['debut_intertitre'] = "\n<h2>";
$GLOBALS['fin_intertitre'] = "</h2>\n";

Méthode: parcours de la page

Nous allons maintenant parcourir le contenu du #TEXTE, et chaque fois que nous trouverons un h2, nous le compléterons par un attribut id unique.

Le code

Dans mes_fonctions.php3, voici le code complet à ajouter:

/*
 *   +----------------------------------+
 *    Nom du Filtre :    creer_ancres
 *   +----------------------------------+
 *    Date : mercredi 27 juillet 2005
 *    Auteurs :
 *		Stéphane Deschamps http://www.spip-contrib.net/auteur.php3?id_auteur=327
 *		Yann Ducrocq http://www.spip-contrib.net/auteur.php3?id_auteur=1833
 *   +-------------------------------------+
 *    Fonctions de ce filtre :
 *     Ce filtre donne un identifiant unique à chaque intertitre de la page
 *   +-------------------------------------+ 
 *  
 * Pour toute suggestion, remarque, proposition d'ajout
 * reportez-vous au forum de l'article :
 * http://www.spip_contrib.net/article.php3?id_article=1053
*/

// declaration d'un compteur global
$cId = 0;

// le filtre a appliquer sur #TEXTE
// [(#TEXTE|creer_ancres)]

function creer_ancres($str)  {
	// l'expression reguliere a tester
	$regH2 = "/<h2[^>]*>(.*?)<\/h2>/i";
	// appel de la fonction de remplacement par callback
	$str = preg_replace_callback($regH2,'replaceH2',$str);
	// on renvoie la chaine resultante
	return $str;
}

function replaceH2($matches) {
	// recuperation du compteur global
	global $cId;
	// incrementation du compteur global pour faire des identifiants uniques
	$cId++;
	// renvoi a la fonction appelante de la chaine remplacee
	return '<h2 id="ancre' . $cId . '">' . $matches[1] . '</h2>';
}

Conclusion et développements possibles

Ce filtre une fois appliqué, vous pourrez faire référence à #ancre1 pour le premier intertitre, #ancre2 pour le deuxième, etc.

Attention cependant, dans certains vieux navigateurs, internet explorer par exemple, les liens vers les id ne fonctionnent pas toujours idéalement, il conviendra le cas échéant si vous voulez à tout prix éviter un dysfonctionnement de remplacer '<h2 id="ancre' . $cId . '">' par '<h2><a name="ancre' . $cId . ' id="ancre' . $cId . '"></a>' (oui, on a fait exprès de mettre un name et un id, mais ce serait trop long à expliquer dans le cadre de cet article).

Parmi les idées de développements possibles, vous pourrez par exemple vous appuyer sur un script en Javascript qui génère automatiquement le sommaire de la page, comme le TOC script de Peter-Paul Koch.

updated on 28 January 2007

Discussion

Une discussion

  • rolex replica

    rolex replica
    Nice write your article, go to your sister!This is a very good feeling.Referral where there? You are so talented, I love you. I blanket to go. Egg pain Tucao can not sayNext to go to deal with, so.I would like to interact with you,You can click on my name or comment on the anchor text, oh.

    Reply to this message

Comment on this article

Who are you?
  • [Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom