jcontent-in-content ~ pour mettre un article dans un article

C'est un problème récurrent (en tous cas pour moi !) de devoir répéter les mêmes informations dans plusieurs articles.
En dehors du côté fastidieux, cela nécessite de modifier toutes les instances à chaque changement.

L'action file-view qui permet d'afficher le contenu d'un fichier dans un article est une première approche. Si elle a tout son sens pour des fichiers distants ou immuables, cela devient vite compliqué pour un rédacteur de faire des corrections.

Cette action permet de créer une "réserve" d'articles, pourquoi pas dans une catégorie dédiée, qui seront insérés au fur et à mesure des besoins.

Ceci est mon utilisation, mais je suis sûr que vous en trouverez plein d'autres !

➠ jcontent_in_content : Affiche le contenu d'un article dans un autre

Cliquer pour lire la documentation

syntaxe 1 : {up jcontent-in-content=id_article}
syntaxe 2 : {up jcontent_in_content=145}template{/up jcontent_in_content}
Les mots-clés :
##id## ##title## ##title-link## ##subtitle## ##link##
##intro## ##intro-text## ##intro-text,100## ##content##
##image## ##image-src## ##image-alt##
##date-crea## ##date-modif## ##date-publish##
##author## ##note## ##cat## ##new## ##featured## ##hits##
author LOMART version UP-1.7 license GNU/GPLv3 tags Joomla
  • jcontent_in_content: ID de l'article
  • no-published (no_published) = 1: Liste aussi les articles non publiés
  • template = ##content##: modèle de mise en page. Si vide le modèle est le contenu. BBCode accepté
  • main-tag = div: balise pour le bloc d'un article. 0 pour aucun
  • main-style: classes et styles inline pour un article
  • main-class: classe(s) pour un article (obsoléte)
  • date-format = %e %B %Y: format pour les dates
  • date-locale: localisation pour les dates. Par défaut, celle du navigateur client.
  • css-head (base-css): code CSS dans le head

    Un exemple simple

    {up jcontent_in_content=140} Ce simple shortcode affiche l'article d'ID 140 qui contient les onglets ci-dessous.


    • ❶ Options par défaut
    • ❷ CSS et/ou JS
    • ❸ PHP
    • ❹ Adapter les noms

    Solution la plus simple, le webmaster peut indiquer ses préférences dans un fichier /custom/prefs.ini.
    Cela permet d'adapter le style au site et facilite la saisie des shortcode par les rédacteurs

    En pratique
    1. créer un fichier prefs.ini en UTF-8 no-BOM sans un sous-dossier custom du dossier de l'action
    2. dans la section options, ajouter vos valeurs par défaut sous une forme identique à celle du shortcode. Une par ligne, pas de pipe (|).

    Autres utilisations de ce fichier :
    les déclarations sont faites dans des sections spécifiques. Voir la documentation de l'action.

    • fournir des informations comme une clé de licence. exemple: google-map, osmap, ...
    • contenir des raccourcis pour des arguments d'option. exemple: hr, icon, ...
    • contenir des jeux d'options. exemple: hr, ...
    ; PREFERENCES WEBMASTER
    
    ; le principe :
    ; -------------
    ; 1/ le développeur de l'action indique des valeurs par défaut pour les paramétres
    ; 2/ le webmaster peut indiquer ci-dessous ses préférences
    ; 3/ le rédacteur peut spécifier les siennes dans le shortcode UP
    
    ; Exemple :
    ; ---------
    ; Les classes d'un bouton sont btn-class = btn btn-primary
    ; Le webmaster du site peut indiquer ci-dessous : btn-class = btn btn-success
    ; qui aura priorité sur celles de l'action
    ; l'utilisateur final pourra indiquer son choix dans le shortcode
    
    ; Cas particulier : annulation des valeurs précédentes
    ; pour une valeur texte ou numérique : laisser vide
    ; pour une valeur logique : saisir 1 ou 0
    
    ; ATTENTION : mettre entre guillemets doubles si caractères spéciaux. Doubler des doubles guillemets pour les utiliser
    
    [options]
    btn-class = btn btn-success
    btn-text="<img src="/"/images/img32/pdf.png""> Afficher le fichier : %s"
    
    ; autres valeurs définies par l'action. Consulter sa documentation
    [key]
    gmap = 123456789

    Si le fichier prefs.ini n'est pas reconnu, vérifiez la présence des guillemets

    Vous désirez uniquement modifier le ou les fichiers CSS pour avoir un rendu différent de celui proposé par défaut.
    UP propose un mécanisme très simple :

    1. créer un sous-dossier custom dans le dossier de l'action concernée
    2. dupliquer le fichier CSS, SCSS ou JS à personnaliser dans ce sous-dossier. Ne pas modifier son nom.
    3. adapter le contenu selon vos envies.

    Vous continuez à bénéficier des mises à jour de UP pour les fichiers 'non customisés'.
    Toutefois, regarder dans le changelog / historique si des modifications ont une incidence sur vos personnalisations. C'est le cas lors d'ajout de fonctionnalités.

    Prise en charge du SCSS

    Si vous préférez faire vos modifications en SCSS, il suffit de le dupliquer (ou le créer) dans le sous-dossier custom.
    Il sera automatiquement compilé lors de l'appel d'une action scss-compiler.

    Attention : si le fichier SCSS fait des importations de partiels, il peut être nécessaire d'adapter le chemin. Dans la majorité des cas, il suffit d'ajouter ../ au début du chemin

    @import "../../assets/variables"; devient @import "../../../assets/variables";

    En cas de souci, pour revenir au comportement par défaut, il suffit de modifier le nom du sous-dossier custom ou d'un fichier pour qu'il ne soit plus pris en compte.

    Vous désirez modifier le comportement d'une action en modifiant son fichier PHP ou créer une nouvelle action en utilisant une autre action comme modèle.

    L'opération nécessite 3 étapes :

    1. dupliquer le dossier de l'action originale en le renommant au nom de votre action. Exemple: mon_action
    2. renommer le fichier PHP principal. Il doit avoir le même nom que le dossier
    3. renommer la classe principale de ce fichier avec le nouveau nom de l'action

    Ensuite, c'est à vous de jouer pour créer une action toute neuve!

    N'oubliez pas de supprimer ou de mettre à jour le lien vers la page de démo.

    • vous ne prévoyez pas de page de démo : supprimer la ligne $this->set_demopage();
    • vous créez une page de démo sur votre domaine : indiquer l'url complête
      $this->set_demopage('https://monsite.fr/mademo');
    • la démo de l'action d'origine est toujours valide : ne changer rien

    N'oubliez pas de documenter votre code, pour que l'action upactionslist puisse l'afficher.

    Vous ne bénéficiez plus des mises à jour de UP.

    Traduction

    Pour traduire dans une autre langue, il suffit de dupliquer le fichier en-GB.ini du sous-dossier UP pour votre langue, puis de traduire les textes explicatifs.

    Modifier le nom de l'action ou des options

    Vous ne pouvez pas supprimer le nom de l'action ou de ses options, mais vous pouvez créer des synonymes dans le fichier up/dico.ini en les ajoutant (un par ligne) sous la forme mot-nouveau=mot-connu. Exemple : jnews=jcontent_by_categories

    Attention ces adaptations sont globales au plugin. Si vous ajouter la correspondance breite=width pour traduire largeur en allemand, ce changement sera utilisable par toutes les autres actions

    Pour regrouper ces changements, il est nécessaire de lancer l'action upactionslist avec l'option make-dico. Tous les fichiers dico.ini des actions sont regoupés en un seul fichier dico.json à la racine du plugin.

    Voir aussi Gestion des traductions


    Dans une fenêtre modale

    Il est possible d'insérer cette action dans une action "modal" a condition que l'article ne contienne que du HTML pur sans Javascript.

    Cet assemblage de shortcodes ne fonctionnera pas !

    L'entête de la page n'est pas repris, donc le javascript est inopérant.

    {up modal | label=Voir les moyens de personnaliser une action}
       {up jcontent_in_content=140}
    {/up modal}
    Voir les moyens de personnaliser une action

    Il faut préférer la forme classique, où on fournit le lien vers la page comme argument de modal.

    {up modal=index.php?option=com_content&view=article&id=140&catid=15}
      Voir les moyens de personnaliser une action
    {/up modal}
    Voir les moyens de personnaliser une action
    pour info, les sections ci-dessous "Les options" et "Les mots-clés", utilisées pour plusieurs démos, sont des articles séparés inclus par des shortcodes de ce type :
    {up jcontent_in_content=id_article}##content##{/up jcontent_in_content}

    Les options

    La table ci-dessous est un comparatif des options proposées par les différentes actions Jxxx
    A: jcontent-in-content, AL: jcontent-list, AC: jcontent-by-categorie (jnews), AT: jcontent-by-tags, CT: jcategories-by-tags
    Si vous avez appelé ce tableau à partir de la démo d'une action, la colonne la concernant est sur fond jaune.

    Option A AL AC AT CT Description
    principale ID(s) catégorie(s) séparé avec virgule, vide pour celui de l'article actuel ou 0 pour tout les IDs
    maxi nombre maxi d'articles dans la liste. non précisé (par défaut) = tous
    exclude toutes les catégories seront sélectionnées sauf celles indiquées dans l'option principale
    no-published liste aussi les articles non publiés. Vrai par défaut
    sort-by ordre de tri: title, ordering, created, modified, publish_up (par défaut), id, hits
    sort-order ordre de tri : asc, desc (par défaut)
    author filtre sur auteur: aucun (par défaut) OU id1,id2 OU article auteur de l'article en cours OU current utilisateur connecté.
    prefset jeu d'option défini par le webmaster dans custom/prefs.ini
    template modèle de mise en page. Si vide le modèle est le contenu
    main-tag balise pour le bloc englobant tous les articles. div par défaut, 0 pour aucun
    main-style classes et styles inline pour bloc principal (inactif si main-tag=0)
    main-class classe(s) pour bloc principal (obsoléte) (inactif si main-tag=0)
    item-tag balise pour le bloc d'un article. div par défaut, 0 pour aucun.
    item-style classes et styles inline pour un article (inactif si art-tag=0)
    item-class classe(s) pour un article (obsoléte) (inactif si art-tag=0)
    date-format format pour les dates. '%e %B %Y' par défaut. 1
    date-locale localisation pour les dates au format 'fr_FR'. Celui du client par défaut.
    featured-html code HTML pour article en vedette. Défaut:
    new-days 30 par défaut. nombre de jours depuis sa création pour considérer un article comme nouveau
    new-html Code HTML pour le badge NEW. nouveau par défaut
    image-src image utilisée si aucune image n'est trouvée dans l'article. Défaut: '//lorempixel.com/300/300'
    image-alt texte alternatif si aucune image n'est trouvé dans l'article
    tags-list-prefix texte avant les autres clés éventuelles si tag {tag-list}
    tags-list-style classe ou style pour les autres mots-clés
    no-content-html texte si aucun contenu
    css-head code CSS dans le head
    spécifique jcontent-list (ex article-category)
    title titre HTML si article trouvé.
    title-tag niveau du titre
    title-style classes et styles inline pour le titre
    title-class classe(s) pour le titre
    list-style classes et styles inline pour la liste
    list-class classe(s) pour la liste
    class idem main-class (conservé pour compatibilité descendante)
    style idem main-style (conservé pour compatibilité descendante)

    1 - Le format d'affichage est défini par l'option date-format. Sa valeur par défaut est : %e %B %Y qui affiche la date sous la forme 1 mai 2019.
    Il s'agit de la codification PHP pour la fonction strftime. Les codes usuels sont %y année sur 2 chiffres, %Y année sur 4 chiffres, %m mois sur 2 chiffres, %b nom mois abrégé en 3 lettres, %B nom mois complet, %e jour (1-31), %d jour sur 2 chiffres (01-31), %A nom jour complet, %a nom jour abrégé, %H heure (00-23), %M minutes (00-59)

    Les mots-clés

    La table ci-dessous est un comparatif des mots-clés utilisés par les différentes actions Jxxx
    A: jcontent-in-content, AL: jcontent-list, AC: jcontent-by-categorie (jnews), AT: jcontent-by-tags, CT: jcategories-by-tags
    Si vous avez appelé ce tableau à partir de la démo d'une action, la colonne la concernant est sur fond jaune.

    Mot-clé A AL AC AT CT Description
    ##id## ID de l'article
    ##title## titre de l'article sans lien vers l'article
    ##title-link## titre de l'article avec lien vers l'article
    ##subtitle## sous-titre (partie du titre après le tilde) 1
    ##link## a utiliser comme argument de l'attribut href d'une balise a.
    ##intro## texte d'introduction de l'article au format HTML. 2
    ##intro-text## texte d'introduction de l'article au format texte sans aucune balise HTML. 2
    ##intro-text,100## variante qui permet de limiter le nombre de caractères affichés (100 dans cet exemple). 2
    ##content## Le contenu si existant. 2
    image d'introduction de l'article ou à défaut la première image trouvée dans le texte d'introduction....
    ##image-link## image avec lien vers l'article
    variante du mot-clé précédent qui permet un plus grand contrôle sur le résultat. 3
    idem
    ##date-crea## date de création 4
    ##date-modif## date de modification 4
    ##date-publish## date de publication de l'article 4
    ##author## nom de l'auteur de l'article
    ##note## note sur l'article
    Fragments nom de la catégorie
    ##new## badge nouveau si l'article est récent. Voir les options \"new-jours\" et \"new-html\"
    si article en vedette
    ##count## nombre d'article dans la catégorie
    42
    ##tags-list## liste des mots-clés

    1 - il s'agit d'une astuce que j'utilise pour décomposer le titre d'un article en titre et sous-titre en les séparant par le caractère tilde (~). En dehors de la possibilité de styler différemment les 2 parties, un titre plus long est meilleur pour le référencement.
    Concrétement, si le tag {subtitle} est présent dans votre template et que le titre contient un tilde, il sera scindé en {titre] et {subtitle}. Dans le cas contraire, le {subtitle} sera vide et {title}: contiendra la totalité du titre de l'article.

    2 - A la différence de Joomla, si l'introtext n'existe pas, il n'est pas remplacé par le contenu. Et vice-versa. Si le besoin existe, on peut créer un mot-clé "article,X" qui insère les X premiers caractères en supprimant les shortcodes UP.

    3 - Exemple de template: <img src="/{image-src}" alt="{image-alt}" class="img-sepia left" width="100px">.
    si l'article ne contient pas d'image, le reste du code sera quand même inséré.

    4 - Le format d'affichage est défini par l'option date-format. Sa valeur par défaut est : %e %B %Y qui affiche la date sous la forme 1 mai 2019. Il s'agit de la codification PHP pour la fonction strftime. Les codes usuels sont %y année sur 2 chiffres, %Y année sur 4 chiffres, %m mois sur 2 chiffres, %b nom mois abrégé en 3 lettres, %B nom mois complet, %e jour (1-31), %d jour sur 2 chiffres (01-31), %A nom jour complet, %a nom jour abrégé, %H heure (00-23), %M minutes (00-59)

    Attention : ne pas utiliser les mots-clés dans votre contenu

    Si cela est impossible, remplacez l'accolade ouvrante par son code &#123;, soit pour id : &#123;id}.
    Une autre méthode est de mettre en gras une partie : {<b>id</b>}.

    Si vous l'utilisez avec une action csv2table, pour éviter le conflit avec le séparateur point-virgule, changer le séparateur utilisé ou mettre le contenu de la cellule entre guillemets. "&amp;#123;id}" ou {<b>id</b>}

    Idées et conseils

    Titre dans les articles

    Si vous utilisez TOC, pensez a mettre les titres de l'article inséré avec une class notoc pour éviter qu'il soit repris par le sommaire de l'article hôte.

    Liste des articles récurrents

    Pour disposer d'une liste papier des articles récurrents, il suffit d'utiliser l'action jcontent_by_categories, suivi d'un simple copier-coller

    {up csv2table | model=blue | col=c5-80-d20 | header=id;titre article;date création;auteur}
       {up jcontent-by-categories=15 | main-tag=0 | item-tag=0}##id##;##title##;##date-crea##;##author##{/up jnews}
    {/up csv2table}
    id titre article date création auteur
    205 Shortcode séparateur 16 May 2020 lomart
    204 Shortcode secondaire 16 May 2020 lomart
    194 Surcharger un fichier 21 Apr 2020 lomart
    183 changelog 20 Mar 2020 lomart
    162 Téléchargements 1 Jan 2020 lomart
    154 Options webmaster 1 Dec 2019 lomart
    181 Saisie bbcode 1 Dec 2019 lomart
    152 Utiliser les caractères Unicode 17 Dec 2019 lomart
    151 Les caractères Unicode 1 Nov 2019 lomart
    145 Jxxx options 12 Dec 2019 lomart
    148 Jxxx mots-clés 12 Dec 2019 lomart
    139 Filter ~ liste des conditions 2 Dec 2019 lomart
    140 Personnalisation d'une action 2 Dec 2019 lomart
    138 Fragments 2 Dec 2019 lomart