Journal
Suivez l’actualité de Fairytree
Personnaliser l'aide dans le gestionnaire de MODx
Dans les dernières versions de MODx Evolution, il est possible de personnaliser entièrement l'aide du gestionnaire. C'est particulièrement utile si vous souhaitez mettre à disposition une documentation à destination des futurs utilisateurs.
Accéder à l'aide
Pour accéder à la section Aide, vous trouverez un lien en haut à droite du gestionnaire:
Vous noterez que ce lien n'est pas très facile à localiser. N'hésitez donc pas à ajouter une icône liée à l'aide directement dans la page d'accueil du gestionnaire, à la suite des icônes déjà existantes. Ce tutoriel consacré à la personnalisation de l'accueil du gestionnaire devrait vous y aider. Ainsi, vos utilisateurs pourront accéder à l'aide bien plus rapidement.
Où trouver les modèles ?
Les modèles qui gèrent le contenu de l'aide sont situés dans le répertoire assets/templates/help. C'est ici que vous pourrez créer les fichiers correspondant à votre documentation. Par défaut, vous ne devriez y trouver qu'un seul fichier intitulé 01Help_Overview.php.
Ajouter des onglets
Chaque fichier créé dans le répertoire /help correspondra à un nouvel onglet dans l'aide. Pour qu'ils soient bien interprétés, le nom de chacun des fichiers doit impérativement respecter la convention de nommage suivante:
- position de l'onglet: par exemple 01,
- nom de l'onglet: par exemple Gestion_des_articles
- extension .php
Les underscores sont automatiquement convertis en espaces. Par ailleurs, je vous conseille de ne pas inclure de caractères accentués car ils ne seront pas encodés correctement dans le titre de l'onglet.
Afin d'illustrer ce fonctionnement, nous allons créons trois fichiers: 01Ajouter_des_articles.php, 02Gestion_des_images.php et 03Sauvegarde.php:
Voici le résultat au niveau de l'aide du gestionnaire. On retrouver bien les titres de nos onglets, ainsi que les positions qui ont été définies:
Créer de nouveaux blocs
On remarque que dans le fichier d'aide proposé par défaut, les informations sont organisées par blocs. Pour créer de nouveaux blocs, voici le code HTML à utiliser:
<div class="sectionHeader">Titre du bloc</div>
<div class="sectionBody">
Ceci est le contenu du bloc
</div>
Le code ci-dessus donnera au final le résultat suivant:
Bien entendu, rien ne vous oblige à utiliser ces styles de blocs. Vous pouvez même créer vos propres styles CSS. Mais si vous souhaitez garder une mise en page parfaitement intégrée à l'interface graphique du gestionnaire, je vous conseille d'utiliser les styles par défaut.
Voilà, maintenant vous savez tout sur le fonctionnement général de l'aide de MODx. N'hésitez pas à utiliser les différentes techniques énoncées, cela devrait vous faciliter la vie ainsi que celle de vos clients !