Correction des liens internes

Published : 27 October 2013 – updated on 12 June 2020 – by Maïeul, nicod_ – 29 commentaires

1
2
3
4
5
22 Votes

SPIP possède des raccourcis spécifiques pour faire des liens internes au site. Par exemple pour pointer vers l’article 25, on utilise le raccourci [texte->25].

Il peut arriver que les rédacteurs et rédactices du site utilisent directement l’URL de la page publique lorsqu’ils créent des liens dans leurs articles.

Le plugin “correction des liens internes” permet de corriger automatiquement ces liens au moment de la rédaction du contenu.

Pourquoi utiliser les raccourcis de SPIP pour formater les liens internes ?

L’usage des raccourcis SPIP pour formater les liens internes permet :
-  de styler différemment les liens internes des liens externes.
-  de ne pas dépendre de l’URL du site.
-  de ne pas dépendre de l’URL des objets.
-  de permettre d’exporter facilement vers d’autres support que du Web [1].

Comment fonctionne le plugin

Le plugin s’installe comme n’importe quel plugin.

Lors de la validation d’un formulaire de rédaction d’un objet (article, rubrique etc.), le plugin vérifie les liens internes. Tout lien commençant par l’URL du site (par exemple http://www.example.com) sera analysé pour vérifier qu’il ne s’agit pas d’un objet SPIP. L’analyse se base sur la configuration du type d’URL. Autrement dit si un rédacteur copie-colle l’URL de la page publique d’un article, le plugin va le repérer.

Il va alors transformer automatiquement le lien, en mettant le raccourci SPIP correspondant :
-  [texte->xxx] s’il s’agit de l’article xxx.
-  [texte->autxxx] s’il s’agit de l’auteur xxx.
-  [texte->rubxxx] s’il s’agit de la rubrique xxx.
-  [texte->objetxxx] s’il s’agit de l’objet xxx.

Le plugin a été testé avec tous les types d’URL de SPIP, y compris les URLS arborescentes. N’hésitez pas cependant à faire part de tous cas problématiques.

Prise en compte d’autres domaines

Par défaut, le plugin reconnait toutes les urls sur le domaine où est installé le site [2].

Si votre site est accessible avec et sans www, en http et en https, si vous avez des alias (noms de domaines équivalents) [3], ces variantes d’urls ne seront pas reconnues.

Dans ce cas, vous pouvez définir avec une constante une liste de domaines supplémentaires considérés comme locaux.
Par exemple, dans config/mes_options.php :

define('CORRECTION_LIENS_INTERNES_AUTRES_DOMAINES', 'http://domaine.tld, 
https://www.domaine.tld, http://www.domaine2.tld/');

Multi-domaines

Si le plugin multi-domaines est activé, le plugin le reconnait automatiquement et tous les domaines déclarés dans la configuration multi-domaines sont considérés comme des domaines locaux, les liens absolus comprenant ces domaines sont transformés en raccourcis SPIP.

Footnotes

[1] Par exemple du LaTeX pour produire un livre.

[2] détection basée sur la fonction url_de_base()

[3] en général, ce n’est pas une bonne idée, les variantes devraient être redirigées sur le domaine principal

Le logo est de Dmitry Mirolyubov sous Licence Creative Commons, Paternité

Discussion

5 years 1 year 3 months Without limit
par date
Filter

6 discussions

  • 5
    Steph

    Ce plugin est parfait :)
    Merci.

    Serait-il possible de prendre en compte le traitement sur le champ “redirection” ?

    Reply to this message

  • 8
    RealET

    Bonjour,

    Superbe plugin que je ne teste qu’aujourd’hui.
    Impressionné qu’il gère aussi les &var_mode=calcul ou recalcul pour les ignorer !

    Par contre, il y a un type de lien dont il change la nature : ceux vers un site référencé.
    Il y a une url publique sur le site qui permet de voir le site.
    Si je la copie/colle, ça produit à l’enregistrement texte du lien qui est un lien direct vers le site au lieu d’être un lien vers la page dans notre site qui fait le lien vers le site (et affiche le flux RSS de ce dernier le cas échéant).

    Il me semble que c’est un manque des raccourcis typo de SPIP, manque que j’avais adressé avec l’aide d’ESJ de cette manière dans SoyezCréateurs :

    /* Permet dans un texte de faire [->refsite12] qui fera un lien vers la page du site en cours décrivant ce site (et non pas un lien direct vers le site de destination) */
function generer_url_refsite($id, $args, $ancre) {
  return array('site', $id);
}
    • Maïeul

      J’ai eu du mal à comprendre le problème.

      Je serais hésitant à mettre cela dans le plugin, car ce comportement n’est pas forcément celui qu’on souhaite. Personnelement je peux avoir un catalogue de site ET vouloir mettre, pour une raison x ou y, un lien direct dans un article.

    • Maïeul

      En tout cas, si on le met cela doit être une option, désactivée par défaut.

    • RealET

      J’ai fait un ticket pour proposer d’améliorer ça dans le plugins sites.
      Mais ça reste un code dérogatoire avec une très forte dette technique :(

      Entre autre, aucun moyen pour ton plugin de savoir qu’il faudrait utiliser refsite et pas site (sauf à coder toi aussi un comportement dérogatoire exceptionnel).

      ==> https://core.spip.net/issues/4283

    • RealET

      Je vais essayer d’être plus clair pour reproduire le problème :

      1. créer un site référencé et le publier
      2. cliquer sur [Voir en ligne] et copier l’url obtenue (qui est donc bien une url d’une page sur mon site ; exemple : https://www.pyrat.net/@Plugins-SPIP-196@.html)
      3. créer un article et y faire un lien en y collant l’url précédemment mise dans le presse-papier

      Résultat :

      • sans ton plugin, le lien amène sur une page de mon site
      • avec le plugin, le lien amène directement sur le site référencé, sans afficher la page de mon site

      On a donc — à cause du comportement dérogatoire de

      1. [->site12]

      qui pointe sur l’url extérieure du site référencé et non sur le squelette SPIP affichant le site en question — un changement de résultat avec la transformation automatique du lien en raccourcis SPIP parce qu’il n’y a pas de raccourcis SPIP pointant vers la page de mon site décrivant le site référencé :(

      C’est plus clair ?

    • Maïeul

      oui c’est plus clair, effectivement. Merci.

      Je sais pas trop comment on pourrait s’en sortir tant que c’est pas réglé dans SPIP....

    • RealET

      Comme j’en aurais le besoin, je veux bien essayer de coder la chose suivante :

      • mettre un define par défaut à “site” pour le type sites
      • utiliser ce define de manière dérogatoire dans les traitements si le type d’objet est site
      • et dans mon mes_options mettre ce define à “refsite”

      Pour le nom du define : _CORRECTION_LIENS_INTERNES_LIEN_SITES

    • Maïeul

      Oui, ca m’a l’air bien. Gogogo

    Reply to this message

  • 1
    Pat

    Bonjour,
    Merci pour ces travaux bien utiles et de bien vouloir tester la version 1.2 de ce plugin.
    Les corrections de liens internes ne fonctionnaient pas bien de mon côté, j’ai tenté de les améliorer :
    -  Gestion des ancres
    -  Meilleure compatibilité PHP 5 et SPIP 3
    -  Élargissement sur la reconnaissance des URLs (même anciennes si possible)
    -  Mise en log des URLs corrigées
    -  Prise en compte du raccourci historique des brèves
    -  Optimisation en cas d’absence de liens
    -  Simplification de la RegExp

    Reply to this message

  • Loiseau2nuit

    Oh p*t**n ! oO

    Les gars, je vous aime ! Merci ! :-)

    Reply to this message

  • 4
    François Daniel Giezendanner

    Bonjour,

    voilà un plugin fort utile pour ne pas dire indispensable aux rédacteurs.

    bravo et merci

    Fdg

    • Maïeul

      attention dans les premier tmps d’install a bien vérifié que tout marche. Je n’ai fait un test qu’en local avec une dizaine d’article et une url de base du site unique. Je ne sais pas ce que cela donne si on combine avec une url de base qui varie (cas de site a plusieurs noms de domaine)

    • gilcot

      plungin fort utile !
      serait bien utile sur contrib...
      (si ça marche pour le forum aussi)

    • Maïeul

      oui, ca marche pour tout édition d’objet. Mais je n’ai pas la main sur les plugins de contrib ...

    • gilcot

      si un des admins complets nous lit... (ce plugin fait partir de ceux que j’ai repéré comme pouvant être utile ici)

    Reply to this message

  • 5
    nicod_

    Bonjour,
    très bonne et salutaire idée.
    Je suis très attaché à la portabilité de SPIP, grâce à ses liens relatifs, et je suis toujours désolé de voir les rédacteurs copier coller leurs liens depuis le front.
    J’ai testé sur un site un peu volumineux, ça fonctionne très bien, même à travers les crayons.

    Mais sur ce site, j’ai une configuration en multidomaines, et le plugin ne reconnait pas du tout et donc ne corrige pas les liens vers d’autres domaines que celui en cours de consultation.
    Dans un article qui répond sur domaine1.tld, les rédacteurs peuvent coller des liens vers des articles de domaine2.tld

    Serait il possible de traiter une liste de domaines plutôt qu’un seul ?
    Un test rapide avec ce patch en tout début de la fonction fonctionne :

    function correction_liens_internes_correction($texte){
  $urls_sites = array(url_de_base(), 'http://domaine2.tld/', 'http://domaine3.tld');
  array_walk($urls_sites, function(&$v) { $v = preg_quote($v); });
  $url_site = join('|',$urls_sites);
  ...

    Dans mon cas, je pourrais récupérer dynamiquement la liste des domaines déclarés dans multidomaines, mais c’est un cas très particulier.
    De manière générale, une telle liste pourrait être définie en constante (ou en config ?).

    Ensuite, une fois les liens absolus transformés en texte, c’est au squelette de savoir les générer sur le bon domaine (et c’est ce qui se passe sur mes sites).

    • Maïeul

      salut, merci pour tes remarques, et le bout de code

      Pour la question des multidomaines, je propose ceci :
      1) on récupére automatiquement dans multidomaines s’il est installé
      2) on propose une constante pour ajouter d’autres urls de base, au besoin.

      Si cela te convient, te sens tu prêt à faire le codage et à le commiter ?

    • nicod_

      Je peux faire cette modif, oui.
      Pour la déclaration d’une constante, c’est une liste qu’il faudrait, et php n’autorise pas d’array en define.
      Une simple liste de domaines séparés dans une chaine ?

    • Maïeul

      arg,

      séparé par une virgule (qui je crois ne fait pas parti des urls)

      n’hésite pas à te mettre en co-auteur dans le paquet.xml

    • nicod_

      Commit envoyé, tu me dis.
      http://zone.spip.org/trac/spip-zone/changeset/77814

      Le code prend en compte les domaines déclarés par le plugin multidomaines (s’il est installé) et ceux déclarés par une constante, exemple :
      define(’CORRECTION_LIENS_INTERNES_AUTRES_DOMAINES’,’http://domaine1.tld domaine2.tld’);
      Séparateur : espace ou virgule, domaines avec ou sans http:// (tout est nettoyé)

    • Maïeul

      hop, http://zone.spip.org/trac/spip-zone/changeset/77815. Je t’ai mis co auteur sur l’article. Tu peux compléter la doc ?

      merci encore !

    Reply to this message

Add a comment

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 / PostgreSQL
  • 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 apparait.

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.

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