Des intertitres hiérarchisés et des outils pour les manipuler

Des intertitres auxquels on peut faire appel...

Cet article décrit les fonctions du plugin Intertitres hiérarchisés et table des matières qui donne accès à des intertitres de niveaux différents ainsi qu’à des modèles permettant de faire une table des matières, des renvois et d’avoir accès à des extraits d’articles. Ces modèles peuvent s’insérer dans les squelettes ou à l’intérieur des articles.

Cette contrib’ est dérivée de Génération automatique de numérotation, table des matières et références écrit par mortimer et chtitux.

Je l’ai mise sous forme de plugin, adaptée à SPIP>1.9 et fait quelques modifications [1].

Elle permet :

-  d’utiliser des intertitres hiérarchisés (plusieurs niveaux de titres) dans vos articles grâce à de nouveaux raccourcis typographiques,
-  d’afficher grâce à un modèle une table des matières dans vos articles et/ou vos squelettes,
-  d’afficher des renvois vers certaines parties d’un article dans vos articles,
-  d’afficher des extraits plus ou moins longs et plus ou moins ciblés d’un article
-  d’extraire des éléments signifiants d’un article.

Actuellement ce plugin est en développement. Cependant il est assez stable pour être utilisé. Il est par exemple utilisé par un site institutionnel : http://svt.ac-creteil.fr.

Des intertitres hiérarchisés

Ce plugin rajoute des raccourcis typographiques pour gérer des niveaux d’intertitres. Ces raccourcis, imaginés par mortimer, s’inspirent des listes et des énumérations de SPIP. C’est à dire que les intertitres utilisent désormais des * ou des # pour que soit déterminé leur niveau :

-  {{{*exemple de premier niveau}}} est un titre de premier niveau (équivalent à {{{exemple de premier niveau}}}),
-  {{{**exemple de titre de second niveau}}} est un titre de second niveau.

Ainsi ce type de contenu dans un article :

{{{*Les outils}}}
{{{**Les trucs qui vissent}}}
Il y en a plein !
{{{***À la main}}}
{{{****Tourne-vis}}}
- cruciforme
- plat
- etc.
{{{***Assisté}}}
{{{****Visseuse}}}
- à fil
- sans fil
{{{**Les trucs qui coupent}}}
snip...
{{{***Ciseaux}}}
{{{****À bois}}}
c'est dangereux ça !
{{{**Les trucs qui frappent (aïe)}}}
{{{***Marteau}}}
trop dangereux pour moi...

Va donner :

Les outils

Les trucs qui vissent

Il y en a plein !

À la main
Tourne-vis

 cruciforme
 plat
 etc.

Assisté
Visseuse

 à fil
 sans fil

Les trucs qui coupent

snip...

Ciseaux
À bois

c’est dangereux ça !

Les trucs qui frappent (aïe)

Marteau

trop dangereux pour moi...

Si à la place des *, vous utilisez des #, les intertitres seront numérotés en utilisant une numérotation scientifique du genre x.y.z.... Ex. :

{{{#Avec des numéros}}}
{{{##de plusieurs niveaux}}}
{{{##C'est une notation scientifique...}}}
{{{#Qui s'incrémentent automatiquement}}}

donne :

1- Avec des numéros

1.1- de plusieurs niveaux

1.2- C’est une notation scientifique...

2- Qui s’incrémentent automatiquement

Donc, l’utilisation des * et/ou des # après le raccourci classique pour les intertitres {{{ permet de hiérarchiser.

Coté HTML, les intertitres hiérarchisés sont transformés en headlines de type <hx class="spip">x est un chiffre allant de 3 à 6 [2]. De plus, chaque intertitre (numéroté ou non) contient une ancre <a name='x.y.z...'></a>x.y.z... est le numéro de l’intertitre. Cette ancre est utilisée par les modèles qui accompagnent ce plugin.

Un fichier CSS installé avec le plugin permet de gérer l’aspect des intertitres dans la partie privée de SPIP. Pour la partie publique, il vous suffit de définir hx.spip {} dans vos propres fichiers CSS pour déterminer comment ces intertitres s’affichent.

Notez que les intertitres des enluminures typographiques sont compatibles avec ce plugin.

Une table des matières

Ce plugin fournit un modèle <table_des_matieres> que l’on peut utiliser dans les articles ou dans les squelettes pour afficher une table des matières qui renvoie vers les intertitres. Elle se présente sous la forme d’une liste de puces (hiérarchisées) avec les intertitres sous forme de liens. Cette table des matières est précédée d’une ancre nommée « table_des_matieres » (<a name="table_des_matieres"></a>), elle est dans un bloc ayant pour identifiant « tablematiere » (<div id="tablematieres">blabla</div>).

Dans les articles, le modèle s’utilise ainsi :

<table_des_matieresXXX>XXX est le numéro de l’article dont vous souhaitez afficher la table des matières.

Dans les squelettes, vous pouvez utiliser :

[(#MODELE{table_des_matieres}{id=XXX})]XXX est le numéro de l’article dont vous souhaitez afficher la table des matières. Notez que XXX peut aussi être une balise comme #ID_ARTICLE.

Comme indiqué précédemment, notez que les intertitres des enluminures typographiques sont compatibles avec ce modèle.

Des renvois vers un intertitre (ou autre)

Ce plugin fournit un autre modèle <renvoi>. Il permet d’afficher l’intertitre d’une sous-partie précise d’un article avec un lien vers elle.

Dans les articles il s’utilise ainsi :

<renvoiXXX|partie=YYY>XXX est le numéro de l’article et YYY est le numéro de la sous-partie. Que l’intertitre soit numéroté ou non, le numéro de la sous-partie est de la forme x.y.z... [3].

À partir de L’exemple des outils qui est présenté au début de cet article : <renvoi2567|partie=1.2.3.3> donnera :

À bois

(2567 est le numéro de cet article et 1.2.3.3 correspond à la sous-partie sur le ciseau à bois... Si si ! comptez...)

Donc, écrire <renvoiXXX|partie=YYY> équivaut à écrire [intertitre de la sous-partie YYY|un extrait avec les 20 premiers mots de la sous-partie (...)->XXX#YYY] sauf que l’intertitre et l’extrait sont déterminés automatiquement par le modèle (et modifiés automatiquement si quelqu’un modifie l’article auquel on renvoie).

Dans les squelettes, le principe est le même, et la syntaxe est :

[(#MODELE{renvoi}{id=XXX}{partie=YYY})]

Comme indiqué précédemment, notez que les intertitres des enluminures typographiques sont compatibles avec ce modèle.

Des extraits d’articles ou de sous-parties d’articles

Voici deux modèles <extrait> et <extrait|partie> qui permettent d’afficher des morceaux d’articles ou de sous-parties d’articles.

Pour afficher un extrait d’article dans un autre article, il faut utiliser le modèle <extraitXXX|debut=YY|taille=ZZ>XXX est le numéro de l’article. debut et taille sont optionnels [4]. taille permet de fixer le nombre de mots à afficher dans l’extrait. debut permet de déterminer à partir de quel mot commencer l’extrait (debut est le n° de ce mot, la numérotation commence à 0).

Ex. : <extrait2567|debut=55|taille=38> permet d’afficher un extrait de 38 mots de l’article n°2567 (c’est celui-ci) à partir du 55e mot.

Notez pour la présentation et l’aspect sémantique que les extraits sont affichés entre balises <quote>extrait de l'article</quote>. Ils sont précédés de « (...) » si l’extrait ne commence pas au mot 0, et toujours terminés par « (...) ».

Les raccourcis typographiques qui étaient présents dans les extraits sont retirés automatiquement (le texte passe dans le filtre textebrut).

Il est aussi possible de faire des extraits d’une sous-partie du texte d’un article. Une sous-partie est un morceau du texte délimité par des intertitres de même niveau.

Le principe à peu près le même que pour le modèle précédent.

Pour afficher un extrait d’une sous-partie dans un autre article, il faut utiliser <extraitXXX|partie|partie=x.y.z|debut=YY|taille=ZZZ> qui fonctionne comme précédemment sauf que partie=x.y.z correspond au numéro de l’intertitre de la sous-partie dont on souhaite afficher l’extrait. Voir la documentation des renvois ci-dessus.

Ex. : <extrait2567|partie|partie=1.2.3.3|debut=4|taille=5> permet d’afficher un extrait de 5 mots de la partie sur le ciseau à bois (n°1.2.3.3) de l’article n°2567 (c’est celui-ci) à partir du 4e mot.

Comme précédemment la citation est dépourvue de raccourci typographique. Sauf l’intertitre qui est rajouté au début de la citation.

Bien sûr, ces deux modèles peuvent être utilisés dans les squelettes :

-  [(#MODELE{extrait}{id=XXX}{debut=YY}{taille=ZZZ})]
-  [(#MODELE{extrait_partie}{id=XXX}{partie=x.y.z}{debut=YY}{taille=ZZZ})]

Comme indiqué précédemment, notez que les intertitres des enluminures typographiques sont compatibles avec ce modèle.

Quelques filtres pour afficher des morceaux signifiants d’un article

Ces filtres sont tirés de la contrib’ Résumé d’article automatique.

Compatibilité

Les intertitres fournis par le plugin Plugin Enluminures typographiques pour SPIP 1.9.2 de RealET qui s’écrivent {2{, {3{, {4{, etc. sont pris en compte par ce plugin avec les équivalences : {1{={{{*={{{, {2{={{{**, etc.

Le plugin les transforme à la volée, si bien qu’ils fonctionnent pour tous les modèles, comme si ils étaient écrits avec des {{{*(...)*.

Les utilisateurs de la contrib’ de mortimer et chtitux dont est tiré ce plugin (Génération automatique de numérotation, table des matières et références) auront peu de changements à faire car il y a une certaine compatibilité ascendante.

Il faut noter cependant que :

-  dans la contrib’ originelle, les intertitres étoilés ({{{*(...)*) généraient une numérotation automatique des titres. Désormais, cette numérotation est réservée aux intertitres avec des #. Donc, si vous souhaitez conserver la numérotation, il faudra transformer les * en # dans les articles.
-  La balise #TABLEMATIERES qui placée dans les articles, affichait la table des matières est remplacée par le modèle <table_des_matières> (ce qui permet de choisir entre mettre une table des matières dans les articles ou dans les squelettes). Dans ce plugin #TABLEMATIERES affiche un lien vers la table des matières présente dans la page (lien vers l’ancre « table_des_matieres ») et non la table des matières elle-même.
-  Dans la contrib’ originelle, les raccourcis des intertitres étaient remplacés par des <h3 class="spipheadx">

x est le niveau de titre. Ce plugin les remplace par des <hx class="spip"> ce qui est plus correct du point de vue sémantique/accessibilité.
-  La contrib’ permettait de personnaliser les ancres présentes dans les intertitres (ex. : {{{**mon titre <mon_ancre_à_moi>}}}). Cela reste fonctionnel dans ce plugin et fonctionne avec les modèles.

Changements depuis la toute première version :

  • Version 0.9.4 du 31/07/2012
    Compatibilité SPIP 3.0.
  • Version 0.6 du 08/02/09 :
    correction du bug signalé par gilcot dans le forum corrigé.
  • Version 0.5 du 24/01/09 :
    • L’ancre table_des_matieres est désormais sans accent... C’est plus pratique !
    • Les ancres sont protégées dans le filtre extrait_lien (avant les ancres étaient listées comme des liens)
    • Les caractères accentués sont remplacés par des entités dans le code généré par le plugin
    • des css pour les intertitres du site public (idéal pour ceux qui restent avec la dist. Les autres devront créer les leurs)
    • Compatible Spip 2 grâce au passage aux pipelines (plutôt que les options)
    • renommage de fichiers et de fonctions (attention à ceux qui surchargent)
  • Version 0.4 du 19/12/08 :
    • Amélioration de Stéphane Deschamps : désormais les variables $GLOBALS['debut_intertitre'] et $GLOBALS['fin_intertitre'] sont prises en compte dans la numérotation des headlines des intertitres, quand elles sont définies par le webmestre.
    • Les balises <code> sont protégées dans les extraits
    • Les modèles prennent désormais en compte tous les articles (quel que soit leur statut).
    • Le bug des tables des matières externes est corrigé. Vous pouvez par exemple mettre un <table_des_matieres122> dans l’article 245 sans souci.
  • Version 0.3 du 04/10/08 :
    • Correction d’un bug qui dupliquait les notes de bas de page.
  • Version 0.2 du 21/09/08 :
    • Correction d’un gros bug qui empêchait le plugin de fonctionner correctement (disparition des images ou des autres modèles après un renvoi dans un article).
    • Toutes petites améliorations typographiques.

Développements futurs

-  intégration dans la barre typo V2 (voir travaux de gilcot dans le forum)
-  faire des modèles supplémentaires (notamment pour exploiter les filtres de Résumé d’article automatique), et documenter tout ça ici même.
-  faire en sorte que les intertitres hiérarchisés soient pris en compte par les contribs/plugin qui produisent autre chose que du HTML (du PDF par exemple).

Ce plugin sous licence GPL est développé sur la forge git

Notes

[1Les modifications principales sont :

-  mise en plugin
-  des * pour les titres non numérotés
-  des # pour les titres numérotés
-  #TABLEMATIERES renvoie désormais vers une table des matières située ailleurs grâce au modèle <table_des_matieres>
-  etc.

[2Si vous avez fixé une valeur de $GLOBALS['debut_intertitre'] et $GLOBALS['fin_intertitre'], elle est prise en compte grâce à une modification de Stéphane Deschamps : les intertitres sont numérotés à partir de cette valeur. Voir aussi le message de Stéphane.

[3Notez que ce modèle utilise les ancres, il est donc possible de mettre n’importe quelle ancre de l’article à la place de YYY, s’il n’y a pas d’intertitre associé à l’ancre choisie, le modèle renvoie à la place le titre de l’article

[4si debut et taille ne sont pas indiqués, ce sont leurs valeurs par défaut qui sont utilisées, c’est-à-dire 0 pour debut et 20 pour taille

En attendant la réalisation d’un logo spécifique, le logo de cet article est une photo de timetrax23 sous licence Creative Commons « Paternité-Partage des Conditions Initiales à l’Identique 2.0 Générique » que vous retrouverez .

Discussion

33 discussions

  • 3

    Bravo pour ce travail, c’est simple et puissant, et c’est ce que je cherchait pour mettre en page de longs textes, et pouvoir présenter un sommaire dans une boucle article par exemple..
    J’ai juste un gout de trop peu (je sais j’abuse), car il est difficilement intégrable avec le découpage en pages ou onglet du couteau suisse.
    Mais bien-sur ce plugin est encore en développement donc respect pour le travail accomplit et je serais patient !
    Merci encore

    • Merci pour les compliments.

      Le statut en cours de développement de cette contrib’ n’est pas un bon reflet de sa stabilité : ce plugin est stable (car basé sur une contrib’ qui l’était), mais des il garde le statut en cours de développement car des fonctions sont à venir (comme l’intégration dans la barre typo).

      Peut-tu me préciser les problèmes rencontrés avec le découpage en pages/onglets du CS ? Voire une donner une URL où je puisse le constater ?

    • Merci de ta réponse rapide !
      Comme tu dois le savoir dans le CS, les deux fonctions (sommaire et découpage) marchent ensemble et le numéro de la page s’affiche après chaque ligne de sommaire
      Dans le cas présent, je ne m’attendais pas à cet affichage, bien-sûr, néanmoins j’espérais que tout le sommaire soit extrait grâce à la balise (je ne l’ai pour le moment testée qu’en intra-texte, pas encore dans le squelette « article », ce qui ne saurai tarder) or, ne sont extrait du texte que les titres de la première page, et uniquement sur la première page.
      comme ça faisait moche, j’ai viré les ++++, et me contente de longues, longues pages...
      Voilà, avec deux exemples :

      http://www.jean-beaujouan.fr/spip.php?article9
      Dans ce cas, pas de ++++, donc un seul bloc, et ça marche nickel (- :

      http://www.jean-beaujouan.fr/spip.php?article7
      Dans ce cas en revanche, comme c’est découpé, le sommaire se contente de retourner les titres présents dans la première page..

      Merci.
      Corentin.

    • Je vois le problème. Il faudrait que j’étudie un peu le fonctionnement de cette lame du CS... Hélas cela ne va pas se faire très vite (j’en suis désolé) car d’autres chantiers prioritaires m’attendent !

      Je te tiens au courant ici-même.

    Répondre à ce message

  • 2

    Bonjour
    j’ai installé le plugin, mais il m’indique qu’il manque un fichier une fois le plugin activé :
    ./plugins/intertitres_hierarchises/intertitres_tdm_fonctions_header_prive.php

     ???

    En tout cas ce plugin parait bien utile !

    • Le Fichier intertitres_tdm_fonctions_header_prive.php est-il présent dans le répertoire du plugin (« intertitres_hierarchises ») ?

      Je viens de vérifier il est présent dans l’archive qui est sur la zone (paquet qui est dans cet article). Donc si ce fichier est absent de ton répertoire plugins :

      -  désactive le plugin
      -  efface le répertoire « intertitres_hierarchises »
      -  re-télécharge le paquet zip
      -  mets le dossier « intertitres_hierarchises » dans le répertoire plugins de ton site
      -  efface le cache
      -  active le plugin
      -  teste...

      Si ça ne fonctionne toujours pas, ou si le fichier est bien présent dans le répertoire, peux-tu me préciser dans quel contexte exact ce message apparaît ? (voire si c’est du coté site public me donner une URL).

    • Merci ! maintenant ça marche ! :-)

    Répondre à ce message

  • 1
    saintvinasse2

    Salut, jolie contrib. Je vais tester ça dans pas longtemps :)

    Si tu as besoin d’un logo pour le plugin, je veux bien bosser la dessus.

    Et pour le nom, ma suggestion serait Hintertitre. Avec double jeu de mot en prime : H pour hierarchie, Hint, pour « astuce » ou « truc » dépendament du contexte.

     ;)

    • Merci pour les compliments, je les accepte en tant que celui qui a mis la contrib’ en plugin. Les vrais compliments vont aux auteurs de la contrib’ originelle.

      N’hésite à faire des retours sur tes tests. Notes d’ailleurs, qu’il y a eu une correction de bug importante faite dans la nuit.

      J’avais quelques idées pour le logo, mais pas assez de temps pour les mettre en pratique (un logo qui serait homogène avec les icônes rajoutées sur la BTv2). Mais je serais très heureux de voir ce à quoi tu penses.

      Pas contre, pour le changement de nom du plugin, au début je trouvais ça trop long et puis finalement, je trouve ça pas mal. D’une part ça reprend en quelque sorte le nom de la contrib’ originelle, d’autre part ça explique bien de quoi il s’agit. Et puis je n’aime pas trop ces titres en anglais !

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom