Module de sommaire automatique

Ce module permet d'enrichir vos articles avec un sommaire généré automatiquement à partir des titres présents dans une publication ou une zone de texte.

Il fonctionne sur les articles standards JPlateform, et dispose de nombreux paramétrages permettant de l'adapter aux contenus de votre application et à une charte graphique existante.

Module Module de sommaire automatique- Illustration

Thèmes : Gestion de contenu
Version 1.0
Compatibilité : JCMS 9

Documentation

Introduction

Ce module fonctionne en standard avec JPlateform, et s'intégre sans développement à vos gabarits personnalisés.

Vous pouvez préciser :

  • La liste des types de publication sur lesquels vous souhaitez voir apparaître le sommaire
  • La zone de texte (wysiwyg) à utiliser et sur lequel le module va s'appuyer pour générer le sommaire
  • L'emplacement du sommaire dans la page

 Beaucoup d'autres options sont disponibles dans les propriétes du module, consultez la liste au chapitre Paramétrage.

 

Exemples d'apparence du sommaire :

table-of-content-screenshot

 

 

Informations techniques

Ce module est compatible sur les versions :

  • JCMS 9 SP1
  • JCMS 9 SP2 
  • JCMS 9 SP3
  • JCMS 9 SP4

 

Compatibilité JDK

Ce module est compatible avec la version 1.7 de JDK (Java Development Kit). Si vous êtes sur la version 1.6 de JDK, contactez-nous.

 

Prérequis

Pour utiliser pleinement ce module, il est conseillé d'avoir suivi les formations de :

  • Formation d’administrateur technique
  • Formation d’administrateur fonctionnel

 

Ce module ne dépend d’aucun autre module.

 

Installation du module

Ajouter ce module avec le gestionnaire de modules depuis l’administration technique et redémarrer JCMS.

 

Paramétrage

Liste des propriétés

Editez le module pour paramétrer ou modifier ses propriétés :

Propriété

Nom technique

Description

Paramètres d'initialisation

Niveaux de titres

js.TableOfContentPlugin.levels

Indiquez ici l'ensemble des niveaux de titres à prendre en compte pour générer le sommaire, en partant de H2.
Les titres doivent se suivre sans sauter de niveau, et se présenter sous la forme d'un tableau de type : ['H2','H3','H4','H5','H6']
Exemples :

  • ['H2','H3','H4']
  • ['H2','H3']

 Zone de texte

js.TableOfContentPlugin.publication.classOrId

La zone de texte possédant cette classe ou ID sera utilisée pour générer le sommaire.
Note : préfixez la valeur par . pour les classes CSS, et par # pour les ID CSS.
Cette option est réservée aux développeurs, ne modifiez cette valeur que si vous êtes certain des impacts sur votre application.

Titres à exclure

js.TableOfContentPlugin.titles.exclude.classes

Indiquez les classes CSS des titres qui ne doivent pas apparaitre dans le sommaire.

La liste de ces classes doit se présenter sous la forme d'un tableau de type : ['classe-a-exclure-1','classe-a-exclure-2']

Conteneur du sommaire

js.TableOfContentPlugin.container.classOrId

L'élement HTML possédant cette classe ou ID sera utilisé pour accueillir le sommaire.
Note : préfixez la valeur par . pour les classes CSS, et par # pour les ID CSS.
Cette option est réservée aux développeurs, ne modifiez cette valeur que si vous êtes certain des impacts sur votre application.

Options d'affichage

Bouton d'ouverture

js.TableOfContentPlugin.button.toggle

Affiche un bouton indiquant la possibilité d'ouvrir le menu, et les états ouvert / fermé du sommaire.

Style du bouton

js.TableOfContentPlugin.button.toggle.effect

Définit l'effet et le style du bouton.
Liste des valeurs possibles dans la la librarie de burgers CSS de Jonathan Suh.

Titre du sommaire

js.TableOfContentPlugin.title.text

Titre à afficher dans l'en-tête du sommaire.

Valeur par défaut : SOMMAIRE

Centrer le titre

js.TableOfContentPlugin.title.center

Centre le texte présent dans l'en-tête.

Sommaire fixe

js.TableOfContentPlugin.sticky.activate

Lors de la lecture d'un article, le sommaire se fixe en haut de page, et reste accessible en permanence.

Espace supérieur

js.TableOfContentPlugin.sticky.topSpace Distance (en px) ajoutée au dessus du sommaire lorsque l'option "Sommaire fixe" est activée.
Utile par exemple si un header fixe est déjà présent en haut de page.

Sommaire fixe largeur 100%

js.TableOfContentPlugin.sticky.fullWidth Le sommaire prendra toute la largeur de l'écran lorsqu'il se fixe en haut de page.
Indenter le sommaire js.TableOfContentPlugin.indent

Indente le sommaire à chaque nouveau niveau de titre.

Note : Les intégrateurs peuvent régler l'indentation via la variable @table-of-content-indentation-margin dans le fichier variables.less du module.

Numérotation js.TableOfContentPlugin.useCssCounterNumerotation Affiche une numérotation dans le sommaire.
z-index du sommaire js.TableOfContentPlugin.sticky.zindex Définit la propriété CSS z-index du sommaire par rapport aux autres éléments de la page.
Utile pour éviter que le sommaire passe au-dessus ou en-dessous d'autres éléments de la page.
Note : La valeur par défaut 500 permet à certains éléments natifs JCMS de ne pas passer sous le sommaire : menu d'édition contextuel, outils de partage de publications...
Repère sur titre ciblé js.TableOfContentPlugin.landmark Ajoute un repère en face du titre ciblé.
Options JCMS
Uniquement en full display jcmsplugin.TableOfContentPlugin.onlyInFullDisplay Le sommaire s'affichera uniquement dans un contexte de full display JCMS.
Types de publications autorisés jcmsplugin.TableOfContentPlugin.publication.types.authorized

Types de contenus pour lesquels le sommaire doit s'afficher.

Note : cette option n'est effective que si l'option "Uniquement en full display" est activée.

Effets
Effet de scroll js.TableOfContentPlugin.effect.scrollEffect Pour plus d'information sur les effets et les valeurs possibles, consultez la page http://easings.net/fr.

Exemples de valeurs :
  • easeInOutCubic
  • easeOutSine
  • easeOutCirc
Vitesse de scroll js.TableOfContentPlugin.effect.scrollSpeed  Durée (en ms) pour atteindre le titre ciblé lors d'un clic sur un lien de sommaire.
Vitesse d'ouverture js.TableOfContentPlugin.effect.scrollSpeed Durée (en ms) pour déplier / replier le sommaire :
  • lors d'un clic sur l'en-tête
  • lors du scroll (uniquement si l'option Sommaire flottant est activée)
Référencement naturel
Micro-datas js.TableOfContentPlugin.seo.addMicroDatas

Ajoute des micros-datas Schema.org au sommaire, pour améliorer le référencement naturel de vos publications.

Ces micros-datas dédiées sont ajoutées aux balises olli et a.

Plus d'informations sur schema.org

Administration technique

Importer la librairie jQuery-easing jcmsplugin.TableOfContentPlugin.includes.js.jqueryeasing jQueryEasing est une librairie d'animations nécessaire au fonctionnement du menu.
Note : Indiquer Non uniquement si cette librairie est déjà présente sur TOUTES les pages où le sommaire est utilisé.
Mode développement js.TableOfContentPlugin.devMode Activez cette option pour obtenir des logs dans la console du navigateur web

 

Enregistrement des nouvelles propriétés

Attention :   la plupart des  propriétés de ce module nécessitent un redémarrage du serveur (propriétés préfixés par ' js.' )

 

FAQ

Le module est prévu pour fonctionner avec un seul champ wysiwyg. Il n'est pas adapté pour des contenus composés de plusieurs champs de type wysiwyg.

Non, le module ne permet pas d'activer/désactiver le sommaire par contenu. Par ailleurs, il est possible de définir les types de contenu sur lesquels doit s'afficher le sommaire dans les propriétés du module. A noter que par défaut, le sommaire ne s'applique que sur les full display (affichage détaillé) des contenus.

Si vous rencontrez un problème lors de l'affichage du sommaire, vérifiez dans un premier temps que le balisage HTML du champ wysiwyg est correctement structuré (ordonnancement des balises titre H1? H2, etc.). Si le problème persiste, contactez nous !



Glossaire

A

ACSII

L'American Standard Code for Information Interchange (Code américain normalisé pour l'échange d'information), plus connu sous l'acronyme ASCII ([askiː]) est une norme de codage de caractères en informatique ancienne. Le jeu de caractères codés ASCII est le principal système qui a permis l'échange de textes en anglais à un niveau mondial, limitant ainsi l'usage des langues locales au travers d'extensions régionales.

Actions entrantes & actions sortantes

Ces actions sont paramétrables dans les workflows. Elles définissent l’entrée ou la sortie d’un état de workflow. Une action entrante signifie l’arrivée dans un état du workflow (ex : une publication qui est planifié). Une action sortante signifie la sortie d’un état vers un autre (ex : une publication qui passe de l’état planifié vers l’état publié).

C

Classe

En programmation orientée objet, une classe définie un ensemble d’objets ayant des attributs communs, et le même ensemble d'opérations.

J

Jsync

Jsync est un moteur de réplication des données et des fichiers. La tâche principale de JSync est de synchroniser les données d'un groupe de serveurs JCMS (aussi appelés réplicas), et de répartir la charge de ces serveurs. Ainsi, toute création, modification ou suppression de données (catégorie, membre, contenu, …) sur l'un des réplicas sera propagée par le réplica leader aux réplicas membres du groupe. JSync assure ainsi la cohérence globale des données d'un groupe de serveur JCMS. Ajouter un lien vers la fiche jsync sur jalios.com.

L

LOG

Correspond à un historique d’évènements stockés dans un fichier, appelé fichier de log (diminutif de logging), permettant de suivre et repérer toutes activités du site. Les évènements sont horodatés et ordonnés en fonction du temps.

LOG4J

Log4j est une bibliothèque de log en Java. Elle permet entre autres de gérer plusieurs niveaux de log :
- FATAL: utilisé pour journaliser une erreur grave pouvant mener à l'arrêt prématuré de l'application
- ERROR: utilisé pour journaliser une erreur qui n'empêche cependant pas l'application de fonctionner
- WARN: utilisé pour journaliser un avertissement, il peut s'agir par exemple d'une incohérence dans la configuration, l'application peut continuer à fonctionner mais pas forcément de la façon attendue
- INFO: utilisé pour journaliser des messages à caractère informatif (nom des fichiers, etc.)
- DEBUG: utilisé pour générer des messages pouvant être utiles au débogage
- TRACE: utilisé par exemple pour journaliser l'entrée ou la sortie d'une méthode

M

MailPolicyFilter

Il s’agit d’un point de débranchement (hook) intervenant lors de l’envoi d’un e-mail dans JCMS. Plus détails ici.

N

Notifications email

Il s’agit de notifications transmises par email à un ou plusieurs utilisateurs JCMS. Ces emails permettent d’alerter, informer ou d’envoyer un rappel aux utilisateurs concernant un évènement passé ou à venir, d’une action traitée ou à traiter. Sous JCMS, il existe 3 types de notification : INFO, ACTION, ALERTE.

P

Portail

Un portail permet d’agréger et de personnaliser des informations de provenances multiples pour en offrir une vision unique. On distingue les portails documentaires étroitement liés à la gestion de contenu, et les portails d’infrastructure liés à des problématiques d’intégration d’applications.

Portlet

Elément de portail. Il existe différents types de portlets : - portlets de construction de page
- portlets de contenu (en charge de récupérer et de formater l'information),
- portlets de navigation,
- portlets fonctionnelles,
- portlets de log.
L'assemblage des différents types de portlets permet de construire des gabarits de page portail.

S

Store

Fichier .xml stockant des données sur les publications, les portlets, les espaces de travails, et d'autres fonctionnalités propres à JCMS. Certaines données de l'application peuvent aussi être stockées en base.

Voir les contenus liés :
- Fiche "Utiliser le store" (fiche Jalios ou Wisen)
- Fiche "Nettoyer le store" (fiche Jalios ou Wisen)
- Autre entrée de glossaire

T

Top-bar

La top-bar ou super-header correspond à la barre de menu affichée en haut de page : topbar

W

Wiki

Le wiki est une site Web ou page web collaborative dont le contenu peut être modifié par les internautes autorisés.

Workflow

Les circuits de validation (ou workflow) permettent de gérer les cycles de vie des contenus dans l’outil. Ils sont paramétrables et personnalisables par contenu.

Wysiwyg

WYSIWYG (What You See Is What You Get), en français « ce que vous voyez est ce que vous obtenez », s'applique aux éditeurs de texte et outils de présentation qui permettent d'éditer directement un contenu sous la forme qui sera affichée aux utilisateurs finaux.