Pluxopolis

Ajouter une aide aux thèmes de PluXml 5.5+

---

Rédigé par jack le 09 mai 2016 1 commentairee

Avec le gestionnaire de thème apparu depuis la version 5.5 de PluXml, il est possible d'ajouter une aide aux thèmes, visible sous forme d'un lien Aide au niveau du descriptif du thème. Cet aide peut servir par exemple à indiquer à l'utilisateur des pré-requis, comme les plugins à installer pour le bon fonctionnement du thème.

Nous allons voir quel fichier utiliser et comment le renseigner pour afficher l'aide d'un thème.

Le fichier d'aide est dépendant de la langue sélectionnéee dans PluXml, soit par le paramètre général que l'on trouve dans "Paramètres > Configuration de base > Langue par défaut du site", soit en fonction des préférences de l'utilisateur connecté par rapport à la langue choisie dans son profil à partir du menu "Profil > Langue utilisée dans l'administration".

Le fichier d'aide est un fichier .php stocké dans le dossier themes/defaut/lang, si on parle ici du thème par défaut.

Son nom est normalisé de la façon suivante:

• fr-help.php : pour le fichier d'aide en français
• en-help.php : pour le fichier d'aide en anglais

Le nom du fichier est donc préfixé par les 2 caractères identifiant la langue (fr, en, de, ru, etc...)

fr-help.php

Concernant le contenu de ce fichier, voici un exemple:

<?php if (!defined('PLX_ROOT')) exit; ?>
<p>Aucune aide disponible</p>

Vous pouvez y écrire dedans toute l'aide nécessaire au format html pour l'installation et la configuration de votre thème.

Seule la première ligne est fortement recommandée pour des raisons de sécurité.

<?php if (!defined('PLX_ROOT')) exit; ?>

Cette ligne interdit de visualiser le contenu du fichier si on tape directement dans son navigateur l'url complète pour accéder au fichier d'aide. Avec cette ligne, le contenu ne pourra être lu qu'en passant par le gestionnaire de thèmes en cliquant sur le lien Aide.

DClassé dans : PluXml ,Mots clés : Administration, Thème

A propos de l'auteur, jack:

Webmestre de PluXopolis de 2018 à Avril 2023.

1 commentaire

rFil RSS des commentaires de cet article