Aide en ligne

L'aide s'affiche au survol d'un élément du CMS, plusieurs familles d'éléments sont concernées (Outils, boutons, champs de configuration, etc.). Elle est matérialisée et accessible via les tooltips, si l'aide en ligne est disponible, un lien "En savoir plus s'affiche".

Il est possible de personnaliser ou d'enrichir l'aide en créant le fichier WEB-INF/param/help.xml avec la structure suivante :

<?xml version="1.0" encoding="UTF-8"?> 
<help> 
    <link family="org.ametys.core.ui.UIToolsFactoriesManager" id="uitool-messagestracker"> 
        <fr>http://localhost</fr> 
        <en>http://localhost/en</en> 
    </link> 
    <link family="org.ametys.core.ui.RibbonControlsManager" id="org.ametys.web.userinterface.Sitemap"> 
        <fr>http://localhost</fr> 
    </link> 
    <link family="org.ametys.cms.contenttype.ContentTypeExtensionPoint" id="org.ametys.test.Content.exhaustif/title"> 
        <fr>http://localhost</fr> 
    </link> 
    <link family="org.ametys.runtime.config.ConfigManager2018" id="online.help.search.url"> 
        <fr>http://localhost</fr> 
    </link> 
</help> 

Le fichier help.xml est composé de plusieurs balises link ayant différents éléments :

  • family : Attribut définissant la famille sur laquelle l'aide sera portée.
    Il existe différentes familles actuellement gérées par Ametys :
    • org.ametys.core.ui.UIToolsFactoriesManager : Outil comme la recherche, le plan du site etc.
    • org.ametys.core.ui.RibbonControlsManager : Bouton du ruban
    • org.ametys.cms.contenttype.ContentTypeExtensionPoint : Propriété de contenu
    • org.ametys.runtime.config.ConfigManager2018 : Configuration
  • id : Attribut contenant l'identifiant de l'élément concerné par l'aide en ligne, l'identifiant se retrouve en explorant les fichiers plugin.xml ou les fichiers de description des types de contenu.
    Dans le cas des contenus, il est possible de mettre des aides sur les propriétés. L'aide doit être définie avec l'identifiant du type de contenu qui porte la propriété et peut concerner un composite ou un repeater, dans ce cas, chaque étage de la structure est séparé par un /.
    De façon concrète, pour ajouter une aide en ligne sur le code d'un "Parcours", ce sera l'identifiant : org.ametys.plugins.odf.Content.programItem/code car la propriété code est apportée par le type de contenu "Composant de formation" dont l'identifiant est org.ametys.plugins.odf.Content.programItem et pour ajouter une aide en ligne sur l'URL des fiches LOM dans les contenus de type "Element pédagogique", ce sera org.ametys.plugins.odf.Content.course/lomSheets/linkUrl.
  • [lang] : Il est possible d'ajouter une ou plusieurs balises langues qui correspondront chacune à l'aide en ligne pour la langue sélectionnée. L'aide en ligne s'ouvre selon la langue avec laquelle le CMS est ouvert dans le navigateur.

L'aide en ligne fonctionne quelque soit le contexte, dans le CMS, dans l'administration et dans les autres contextes disponibles dans l'application Ametys.