Accueil du site > Rédaction > Sommaires > Génération automatique de numérotation, table des matières et références

Génération automatique de numérotation, table des matières et références

2 mars 2005 – par chtitux, mortimer – 24

1 vote

Voici un ensemble de nouveaux raccourcis typographiques pour gérer les titres de sections de façon plus évoluée. On obtient ainsi des titres à plusieurs niveaux, automatiquement numérotés et recensés avec une table des matières.

Nouveaux Raccourcis

Avec Tex (par exemple), on peut définir un certain nombre de titre de section et sous section. Ils seront ensuite numérotés automatiquement et si c’est nécessaire, une table des matières sera construite.

Par contre, dans SPIP, on ne peut définir qu’un niveau de section avec le raccourcis : {{{ma section}}}. Cette contrib utilise les points d’entrée dans inc_texte.php3 pour ajouter trois nouveaux raccourcis :

{{{* ma section <référence>}}} {{{** ma sous section}}} etc...
#TABLEMATIERES
<référence>

Le premier jeux de raccourcis permet de faire une hiérarchisation des sections dans l’article. On pourra ainsi tapper :

et l’on obtiendra :

1 Section de haut niveau

du texte plein ...

1.1 Section de 2e niveau

du texte plein ...

1.1.1 Section de 3e niveau

du texte plein ...

1.1.2 autre Section de 3e niveau

du texte plein ...

2 une autre Section de haut niveau

du texte plein ...

La balise #TABLEMATIERES placée dans un article sera, quant à elle remplacée, par une liste des sections, avec des liens vers l’emplacement des sections dans la page [1]. Par exemple :

1 Section de haut niveau
- 1.1 Section de 2e niveau
  - 1.1.1 Section de 3e niveau
  - 1.1.2 autre Section de 3e niveau
2 une autre Section de haut niveau

La dernière balise permet de référencer un numéro de section. Comme en Tex, on peut associer un raccourci à chaque section, grâce à : {{{** ma section <raccourci>}}}. On peut ensuite mettre dans le texte une référence qui sera plus tard remplacée par le numéro de la section et un lien dans le document.

on peut trouver un exemple ici.

Limitations

Deux sections ne peuvent pas avoir exactement le même titre (en comptant les espaces). On peut contourner cette limitation en mettant des espaces de plus à la fin de chaque titre.

On ne peut pas utiliser de < dans les titres de section. De même, pas de raccourcis docXXX, embXXX ou imgXXX.

Si vous voulez m’aider à réécrire cette expression régulière :

(($debut_intertitre(\\*+)([^<]*)(<([^>]*)>)?$fin_intertitre))

ça pourrait aider.

Code

Ce code s’insère dans mes_options.php3.

/*
 *   +----------------------------------+
 *    Nom :   Table des matieres                                               
 *   +----------------------------------+
 *    Date : aout 2004
 *    Auteur :  Mortimer Porte mortimer.pa@free.fr                                     
 *   +-------------------------------------+
 *    Fonctions de ce filtre :
 *     affiche une table des matières et génère automatiquement la numérotation des titres.
 *   +-------------------------------------+ 
 *  
 * Pour toute suggestion, remarque, proposition d'ajout
 * reportez-vous au forum de l'article :
 * http://www.spip-contrib.net/article.php3?id_article=627
*/
function table_des_matieres($texte) {
  global $debut_intertitre, $fin_intertitre;

   // définition de la balise pour les titres des sections %num% sera remplacé 
  // par la profondeur de la section
  $css_debut_intertitre = "\n<h3 class=\"spiphead%num%\">";
  $css_fin_intertitre = "</h3>\n";

  // on cherche les noms de section commençant par des *  
  $count = preg_match_all("(($debut_intertitre(\\*+)(.*?)(<(.*?)>)?$fin_intertitre))",$texte,$matches);
  $table = '';
  //initialisation du compteur
  $cnt[0] = 0;
  //initialisation du code de la table des matières
  $table = "\n<ins><div id=\"tablematiere\">\n";
  $lastlevel = 1;
  $cite[''] = '';

  //pour chaque titre trouvé
  for ($j=0; $j< $count; $j++) {
	$level = $matches[2][$j];
	$titre = $matches[3][$j];
	$ref = $matches[5][$j];
	if(strlen($level) == 1) {
           //on est au niveau de base
          //on réinitialise les compteurs
	  for ($i=1; $i < count($cnt); $i++) {
		$cnt[$i] = 0;
	  } 
          //on génère le titre et le numéros
	  $numeros = ++$cnt[0];
	  $titre = $numeros.' '.$titre;
	} else {
           //on est à un niveau plus profond
          // on construit le numéros
	  $numeros = $cnt[0].'.';
	  for ($i=1; $i < strlen($level)-1; $i++) {
		$numeros .= $cnt[$i].".";
	  }
	  $numeros = $numeros.(++$cnt[$i]);
          //on génère le titre
	  $titre = $numeros.' '.$titre;
	}

        //gestion de la liste dans la table
	if($lastlevel < strlen($level)) {
          //on ouvre une sous liste
	  $table .= "<ul>\n";
	}
	if($lastlevel > strlen($level)) {
          //on doit fermer les derniers niveaux
	  for ($i=0; $i < ($lastlevel - strlen($level)); $i++) {
             if($i+1==$lastlevel) {
               $table .= "\n</div></ins>";	// derniere fermeture
             } else {
               $table .= "</li>\n</ul>"; 
             }	
	  }
	}
	if($lastlevel >= strlen($level)) {
          //on doit fermer l'item précédent
	  if($cnt[0] > 1 || strlen($level) > 1) {
		$table .= "</li>\n";
	  }
	} 
       //on se rappelle du raccourcis
	$cite[$ref] = $numeros;
	$table .= "<li><a href=\"#$numeros\">$titre</a>";

       //on mémorise le niveau de ce titre
	$lastlevel = strlen($level);

        //on génère la balise avec le bon style pour le niveau
	$mdebut_intertitre = str_replace('%num%',$lastlevel,$css_debut_intertitre);
	$mfin_intertitre = str_replace('%num%',$lastlevel,$css_fin_intertitre);
        //on remplace le titre dans le texte
	$texte = str_replace($matches[0][$j],"$mdebut_intertitre<a name='$numeros'></a>$titre$mfin_intertitre",$texte);
  }
  //on fini la table
  for ($i=0; $i < $lastlevel; $i++) {
	$table .= "</li>\n</ul>";		
  }
  //on remplace les raccourcis par les numéros des sections.
  foreach ($cite as $ref => $num) {
	$texte = str_replace("<$ref>","<a href=\"#$num\">$num</a>",$texte);	
  }
  //on place la table des matières dans le texte
  $texte = str_replace('#TABLEMATIERES',$table,$texte);
  return $texte;
}

Il faut ensuite l’appeler depuis apres_propre, par exemple :

function apres_propre($texte) {

  $new_texte = table_des_matieres($texte);

  return $new_texte;

}

Style

le style de la table des matières ainsi que des différents niveaux sont gérés par du css. Il faut donc ajouter à vos fichier css, les classes spiphead1, spiphead2, ... (autant que de niveaux utilisés) ainsi que l’id #tablematiere

Notes

[1] en utilisant des ancres html

24 Messages de forum

Voir toute la discussion

Pages 1 | 2 | 3

26 mai 2006 18:58, par AveCox

Génération automatique de numérotation, table des matières et références

Désolé pour le flood... petit bug chez moi.
26 mai 2006 18:45, par AveCox

Génération automatique de numérotation, table des matières et références

Ca marche plutot pas mal, si ce n’est quelques petits bugs.

1er : Probleme avec l’ordre des balises ul et li qui se chevauchent et qui font donc un code non standard et parfois maltraitent un peu le design de la page web.

Faudrait modifier un peu le code mais je n’ai pas le temps pour l’instant...

2e : C’est pas vraiment un bug mais il y a une balise ins dont je ne vois pas l’utilité ?

3e : Pas non plus un bug dû à ce code mais il y a toujours un problème dû au code qui s’inclus dans un paragraphe généré par spip (p class="spip")

4e : Intertitres de niveaux différents, c’est bien mais du point de vue de l’accessibilité ça reste tous des titres de niveau h3 alors que ça devrait etre h3 puis h4 puis h5 puis h6.

Voilà, quelques conseils pour améliorer ce code :)
26 mai 2006 18:44, par AveCox

Génération automatique de numérotation, table des matières et références

Ca marche plutot pas mal, si ce n’est quelques petits bugs.

1er : Probleme avec l’ordre des balises ul et li qui se chevauchent et qui font donc un code non standard et parfois maltraitent un peu le design de la page web.

Faudrait modifier un peu le code mais je n’ai pas le temps pour l’instant...

2e : C’est pas vraiment un bug mais il y a une balise ins dont je ne vois pas l’utilité ?

3e : Pas non plus un bug dû à ce code mais il y a toujours un problème dû au code qui s’inclus dans un paragraphe généré par spip (p class="spip")

4e : Intertitres de niveaux différents, c’est bien mais du point de vue de l’accessibilité ça reste tous des titres de niveau h3 alors que ça devrait etre h3 puis h4 puis h5 puis h6.

Voilà, quelques conseils pour améliorer ce code :)
26 mai 2006 18:43, par AveCox

Génération automatique de numérotation, table des matières et références
Ca marche plutot pas mal, si ce n’est quelques petits bugs.

1er : Probleme avec l’ordre des balises
et

Faudrait modifier un peu le code mais je n’ai pas le temps pour l’instant...

2e : C’est pas vraiment un bug mais il y a une balise dont je ne vois pas l’utilité ?

3e : Pas non plus un bug dû à ce code mais il y a toujours un problème dû au code qui s’inclus dans un paragraphe généré par spip

4e : Intertitres de niveaux différents, c’est bien mais du point de vue de l’accessibilité ça reste tous des titres de niveau h3 alors que ça devrait etre h3 puis h4 puis h5 puis h6.

Voilà, quelques conseils pour améliorer ce code :)

20 avril 2006 16:22, par orcieres

Génération automatique de numérotation, table des matières et références

Bonjour

très bonne contrib, mais quand je place la "balise" #TABLEMATIERES au début de l’article (champ texte) tout le texte de l’article apparait souligné !!

ceci disparaît quand je place la "balise" à la fin du texte ????

mystère, qui peut m’aider merci

Jean

28 janvier 2006 15:01, par JFD

Génération automatique de numérotation, table des matières et références

Ca marche ! Et merci pour la rapidité de votre réponse.
Il me reste juste un problème (je ne suis pas un champion des css) : tout le texte qui suit la balise #TABLEMATIERES se retrouve en souligné. Si vous pouvez encore m’aider ...
JFD

27 janvier 2006 22:02, par Beurt

Mes petites modifs à cette super contrib’ !

Bravo pour cette contrib’ très utile (à condition d’utiliser l’astuce des « trim », voir le message 6)...

Pour ma part je viens de la mettre en « production » avec une petite modification. D’abord, il me paraissait plus logique que le raccourci pour un titre numéroté soit {{{# plutôt que {{{*, c’est plus compatible avec le système de puces hiérarchisées (-* pour les puces non numérotées et -# pour les puces numérotées). D’autre part, je voulais permettre à mes rédacteurs d’intégrer des titres numérotés (avec des #) et des titres non numérotés ou avec des numérotations personnelles genre a, b, c... (avec des *).

Je suis ultra-débutant en php (et en programmation en général) ce qui m’a amené à faire les modifs suivantes :

// on cherche les noms de section commençant par des * et #

  //j'ai rajouté le # dans l'expression régulière [\\*#]+ à la place de \\*+

  $my_debut_intertitre=trim($debut_intertitre); //merci à fleg ! :o)

  $my_fin_intertitre=trim($fin_intertitre);

  $count = preg_match_all("(($my_debut_intertitre([\\*#]+)(.*?)(<(.*?)>)?$my_fin_intertitre))",$texte,$matches);

et plus bas :

//on génère le titre et le numéros

          $numeros = ++$cnt[0];

        //on teste si le(s) caractère(s) matché est # pour savoir si l'on affiche les

        //numéros avec le titre ou non (#->numéros affichés)

          if(preg_match("/#+/",$matches[2][$j])) {$titre = $numeros.' '.$titre;}

et encore plus bas :

          $numeros = $numeros.(++$cnt[$i]);

          //on génère le titre

        //on teste si le(s) caractère(s) matché est # pour savoir si l'on affiche les

        //numéros avec le titre ou non (#->numéros affichés)



          if(preg_match("/#+/",$matches[2][$j])) {$titre = $numeros.' '.$titre;}

La première modif permet de détecter les # comme les * ; les deux modifs suivantes permettent de ne mettre la numérotation que si le raccourci contient #

Compte tenu de l’intégration très sale de ma modif, il n’est pas conseillé —du tout— d’utiliser des # et des * dans le même article, car des numérotations étranges seraient à prévoir (des fois ça donne des trucs vraiment très drôles ! :o))

Pour finir je trouvais plus propre que les titres soient de la forme <hx class="spip"> avec x>2 (comme l’écrit Triangle dans le message 5) donc voici ce que j’ai changé :

  //pour que les raccourcis soient remplacés par des headlines (<hx>)

  $css_debut_intertitre = "\n<h%num% class=\"spip\">";

  $css_fin_intertitre = "</h%num%>\n";

et plus bas :

        //on ajoute 2 à $lastlevel pour avoir des <hx> qui commencent à <h3> et plus

        $mdebut_intertitre = str_replace('%num%',$lastlevel+2,$css_debut_intertitre);

        $mfin_intertitre = str_replace('%num%',$lastlevel+2,$css_fin_intertitre);

Merci encore pour cette belle contrib’ !

27 janvier 2006 21:39, par Beurt

> Génération automatique de numérotation, table des matières et références

Très bonne idée ces trim, celà s’avère assez vite indispensable !

Merci !

27 janvier 2006 18:51, par mortimer

Génération automatique de numérotation, table des matières et références

Non, avec le code fournit ici, la balise pour générer la table des matières doit être placée quelque part dans le texte de l’article et pas dans le squelette.

James à produit un code différent qui permet de placer la balise n’importe où dans le squelette. Il y a une version là mais je crois qu’elle ne marche qu’avec la version de dévelopement.

27 janvier 2006 15:33, par JFD

Génération automatique de numérotation, table des matières et références

Bonjour,
Cette contribution m’interresse bien, mais je n’arrive pas à l’installer correctement (j’utilise Windows XP et Spip V 1.8.2 e avec le squelette Epona).
Dans mes articles, J’obtiens bien les différents niveaux de titres numérotés, mais je n’ai pas la table des matières (j’ai pourtant installé la balise #TABLEMATIERES dans mon squelette, et l’id tablematiere dans ma feuille de style).
Quelqu’un pourrait-il m’aider ? D’avance merci. JFD

Pages 1 | 2 | 3

SPIP-Contrib

Génération automatique de numérotation, table des matières et références

Nouveaux Raccourcis

Limitations

Code

Style

Notes

24 Messages de forum

Rubriques

Derniers commentaires

Compatibilité

Ça discute par ici

Les thèmes de Sarka-SPIP 3

Formulaire de participation à un événement

Le Squelette Zpip

Plugin Pages uniques

Le Couteau Suisse

Ça spipe par là

SPIP Blog

SPIP Party

SPIP Forums

SPIP-Zone

SPIP Svn