SPIP - Contrib

[ar] [en] [es] [fr] [it]



Accueil du site > Rédaction > Sommaires

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

mercredi 2 mars 2005, par chtitux, mortimer. Dernier ajout dimanche 21 janvier 2007


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 :

  1. {{{* ma section <référence>}}} {{{** ma sous section}}} etc...
  2. #TABLEMATIERES
  3. <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.

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


Répondre à cet article

  • Désolé pour le flood... petit bug chez moi.

    Répondre à ce message

    Retour au début des forums

  • 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 :)

    Répondre à ce message

    Retour au début des forums

  • 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 :)

    Répondre à ce message

    Retour au début des forums

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

    1er : Probleme avec l’ordre des balises

      et
    • 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 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 :)

      Répondre à ce message

    Retour au début des forums

  • 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

    Répondre à ce message

    Retour au début des forums

  • 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

    Répondre à ce message

    Retour au début des forums

  • Mes petites modifs à cette super contrib’ !

    27 janvier 2006 22:02, par Beurt

    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’ !

    Répondre à ce message

    Retour au début des forums

  • Salut, Très bien cette contrib. La seule chose est que dans certains cas complexes (par ex une chapitre qui n’est composé que d’une liste énuméré, ou l’appel à des filtres qui changent un peu la mise en page), il y a des petits problèmes de titres de chapitres qui ne sont pas reconnus. Pour ma part, j’ai résolu ce problème en insérant les trim suivants : Je remplace la ligne :

    $count = preg_match_all("(($debut_intertitre(\\*+)(.*?)(<(.*?)>)?$fin_intertitre))",$texte,$matches);

    par

     $my_debut_intertitre=trim($debut_intertitre);
     $my_fin_intertitre=trim($fin_intertitre);
     $count = preg_match_all("(($my_debut_intertitre(\\*+)(.*?)(<(.*?)>)?$my_fin_intertitre))",$texte,$matches);

    Si ça peut en aider certains.

    F.

    Répondre à ce message

    Retour au début des forums

  • Bonjour,

    Je voudrais savoir savoir où il faut mettre le code :

    function apres_propre($texte) {
    $new_texte = table_des_matieres($texte);
    return $new_texte;
    }

    Personnellement, je l’ai mis à la fin su fichier ecrire/inc_texte.php mais j’obtiens alors un message d’erreur me disant qu’il y a un appel à une fonction non définie.

    J’ai donc du oublier quelque chose.

    Merci d’avance

    Pascal

    Répondre à ce message

    Retour au début des forums

  • Bonjour,
    personnellement, dans des articles longs, j’aime pouvoir revenir à la table des matières par un petit lien de retour vers celle-ci.

    À cette fin, j’ai donc modifier la fin de votre code de la manière suivante :

    En utilisant une nouvelle balise #RETOUR dans le texte de l’article, cette dernière est remplacée par un lien vers la table des matières. Le texte est dans une boite div avec l’attribut CSS class=’retourtable’. On peut ainsi le faire s’afficher à droite si on le désire, et le masquer dans le cas d’une impression (si on utilise une feuille de style spécifique).

    Le texte est en français. Je suppose qu’il doit être possible de l’adapter à un squelette multilingue à l’aide des balises de langues, mais je ne sais pas si SPIP procède au remplacement des balises de langues avant ou après avoir appliqué le filtre.

    D’autre part, je n’ai pas encore regardé comment intégrer cette contrib dans la génération automatique de PDF (Génération améliorée de fichiers PDF). Peut-être le plus simple consiste à écrire un second filtre qui au lieu de remplacer par des balises h3 avec des class CSS différentes, remplace par des balises h3, h4, h5... puisque FPDF ne gère que du code HTML et pas le CSS.

    Si vous avez une meilleure idée.

    Cordialement,

    Répondre à ce message

    Retour au début des forums

  • Je viens d’installer cet contri, et je n’ai rencontré aucun problème ;-) Un grand merci pour le travail !!!

    ==xtof

    Répondre à ce message

    Retour au début des forums

  • Bonjour, tout d’abord, merci pour cette contribe vraiment sympa. juste une question.

    À priori l’encapsulation de la table de matière entraine une non conformité avec les exigences w3c. (problème avec la dernière balise fermante ul et celle de fermeture du paragraphe).

    J’ai essayé plusieurs modifs sans succés, d’autant plus que je ne vois pas en quoi le code généré est non conforme.

    quelqu’un a t il rencontré des problèmes similaires.

    merci encore.

    Répondre à ce message

    Retour au début des forums

  • Le fichier plugin est utilisable sans placer de filtre dans les squelettes et marche aussi du côté admin du site.

    Répondre à ce message

    Retour au début des forums

  • Donc après la pr1, ceci ne marchera plus.

    Répondre à ce message

    Retour au début des forums



  • Suivre la vie du site RSS 2.0 | Plan du site | Espace privé | Charte et vie SPIP-Contrib | SPIP | L'autre.net