Dans mon précédent article numéro 880, comment j'ai rajouté un bloc statique aide-mémoire dans la partie édition Joomla content de l'administrateur, je vous ai proposé comment rajouter une petite aide mémoire de vos commandes personnalisées de vos plugins.

J'ai refait un équivalent de la solution à cette problématique, en rendant modulable l'ensemble de ce que je vous avais déjà proposé dans l'article précédemment cité.

Quoi de neuf ?

Dans cette nouvelle méthode de faire, j'ai réalisé le stockage de l'ensemble de mes informations dans un simple fichier externe au format XML de chacun des plugins que je développe, ainsi qu'un petit élément qui vous permet de lire ces fichiers XML.

Ainsi, si vous souhaitez rajouter des éléments, il vous suffit simplement d'éditer ce fichier XML de votre plugin dans un éditeur simple, afin de rajouter de nouvelles données.

Modifications à apporter

Pour mettre en place ce système, j'ai dû apporter quelques modifications aux dichiers de base de joomla.

Après avoir effectué un héritage de votre Fichier edit.php de administrator->com_content->edit, j'ai simplement rajouter à la suite de la ligne 75, le code suivant :

<?php include('explications.php'); ?>

De cette manière, si je veux modifier des choses particulières dans ma nouvelle modification, il ne suffit pas d'aller rechercher et bidouiller le fichier d'origine, les données se trouve dans un fichier externe explication.php. C'est un choix personnel mis je prèfère. Un moyen simple, à mon avis, de se retrouver plus facilement.

Désormais, l'ensemble des modifications que je vais apporter seront incluses dans ce nouveau fichier explications.php

Fonctionnement de ce nouveau fichier

Comme beaucoup d'informaticiens, je suis très fainéant. Ainsi, dans ce fichier, je vais aller scanner l'ensemble des noms de fichiers qui portent la le sous chaine SEOExplication dans les noms de fichiers au format XML, qui seront disséminés dans l'ensemble du sous répertoire administrator.

Ainsi, mon petit outil va rechercher l'ensemble des explications contenues dans les sous répertoires de mes modules ainsi que de mes plugins que j'ai développé. Nous retrouverons ici l'ensemble de la doc de l'ensemble de mes développements.

Fonctionnement générique

De manière à ce que ce fonctionnement s'applique à l'ensemble de mes développements, je me suis fixé une norme XML afin de pouvoir faire en sorte que ensemble de mes documentations de mes plugins (ou de mes modules) soit tout identiques. Le format de mon fichier XML et le suivant et porte toujours un nom qui va contenir la chaîne de caractères SEBExplication, avec comme extension de fichiers XML. Ce sont les deux conditions pour que le fichier soit détecté par mon système soit reconnu comme un fichier d'aide.

Exemple d'un fichier XML

<SEBexplication>
	<nom>SEOExplication</nom>
	<tag>{ici mon tag}</tag>
	<explications>Ce tag permet de ...</explications>
</SEBexplication>

Les modifications à apporter.

Dans un premier temps, vous devez créer le fichier explications.php et le placer dans le dossier administrateur template Isis -> HTML -> com_content -> article.

Désormais que ce fichier est créé, vous devez le faire appeler par le fichier edit que vous aurez préalablement hérité, et qui se trouvera dans le répertoire, après héritage, administrator->template->Isis->HTML->com_content->article edit.php en rajoutant ligne 76 :

<?php include('explications.php'); ?>

Enfin, vous devez corriger ou modifier le fichier CSS de la template d'administration de Joomla, je vous donne ce que moi j'ai rajouté mais à vous d'y faire votre propre style de cet outil :

.seb-admin-explications {
  border: 2px solid red;
  padding: 1%;
  border-radius: 5px;
  background-color: lightyellow;
}

.seb-admin-explications .nom {
  text-align: center;
  font-weight: bold;
}

.seb-admin-explications .tag {
  float: left;
  margin-right: 2%;
  color: blue;
  font-weight: bold;
}