[RÉGLÉ] Où mettre la doc de mes plugins et modules ?

[slhuilli]

bonjour,

Je développe des plugins et des modules pour mon site internet non connecté au web, à destination à la fois de l'utilisateur principal, à savoir moi-même, mais aussi peut-être ultérieurement de nouveaux utilisateurs.
Dans le cadre du développement de plugins, qui prennent certains paramètres dans le code (Ex : {monPlugin=true}), je cherche à renseigner quelque part dans la console d'administration du plugin, la méthode d'utilisation de ce dernier ainsi qu'un peu de "doc".

Je souhaiterais savoir si il est possible dans le fichier manifeste d'un plugin ou d'un module s'il est possible de mentionner un bout de code en html pour expliquer le fonctionnement et les éventuels paramètres de l'outil. J'ai bien trouvé des champs de type note, mais relativement light pour pouvoir expliquer et sans pouvoir mettre de balises HTML de type B expliquant le fonctionnement.

Est il possible dans le fichier manifest d’intégrer du HTML explicatif ?

Merci

[RobertG]

Bonjour,

Dans ton fichier manifeste, pour chaque champ affiché dans le plugin, tu as ce type d'infos : le label et la description :

label="PLG_LAZYDBBKP_SITE_ONLY"
description="PLG_LAZYDBBKP_SITE_ONLY_DESC"

suivi du type (ici un switcher oui/non.
Ceci en plus de la description générale du plugin (ici PLG_LAZYDBBKP_XML_DESCRIPTION)


Sinon, un article explicatif et un lien dans la description du plugin ou du module renvoyant à cet article ?

[roland_d_alsace]

bonjour,

...

Je souhaiterais savoir si il est possible dans le fichier manifeste d'un plugin ou d'un module s'il est possible de mentionner un bout de code en html pour expliquer le fonctionnement et les éventuels paramètres de l'outil. J'ai bien trouvé des champs de type note, mais relativement light pour pouvoir expliquer et sans pouvoir mettre de balises HTML de type B expliquant le fonctionnement.

...

Pourquoi tu dis que tu ne peux pas mettre de html dans les champs de type note ?

Tu peux mettre du html dans tous les valeurs des attributs "label" et "description" de tous les types de champs (donc y compris -et surtout- les types note, spacer, etc...).

Il ne faut pas s'en priver.

[slhuilli]

roland_d_alsace je dis ca (mais je m'exprime peut etre mal) car mélanger du XML et HTML dans le manifest, si j'en crois mon validateur XML de notepad++, il me dit que c'est le mal
Par contre faire un lien, pourquoi pas, l'idée est bonne mais ca reste du HTML et l’intégration dans un fichier XML, il y a pas des choses particulière à noter ? là honnêtement je ne maitrise pas (en + ca sera sur un intranet sans connexion au web, donc que des liens en interne à Joomla, a creuser mais pourquoi pas. Vous auriez un exemple pour bien remplir mon XML pour ca ?

[roland_d_alsace]

Ok, je comprend.

Mais normalement on ne met pas les textes dans le manifest, mais les clés de langue et c'est dans les fichiers de langue (les .ini) que tu mets le texte avec les balises html.

Sinon dans un fichier xml pour ne pas interpréter lors de l’analyse du xml un littéral pouvant contenir des < et des > il faudrait utiliser une séquence

<![CDATA[content]]>  ​

, mais je n'ai jamais essayé de placer des CDATA dans un manifest Joomla.

[RobertG]

Si, CDATA fonctionne dans les manifestes Joomla!, certains auteurs l'ont fait et le font peut-être encore.

[slhuilli]

oui je comprends mais comme je dev sur un intranet non connecté au net dans un contexte où le français est obligatoire, je squizze les fichiers de langue volontairement. Mais je suis d'accord sur le principe, y'a aucun probleme !
J'ai testé avec des CDATA mais ca ne marche pas. Bien tenté

[roland_d_alsace]

Comme l'indique RobertG j'ai effectivement trouvé dans des manifest d'extensions du html dans des CDATA :

<description><![CDATA[<div style="margin-bottom: 20px;" align="center">
    <table border="0"
    width="90%">
    <tbody>
    <tr>
    <td colspan="2"
    width="100%">
.....
   </td>
    </tr>
    <tr>
    <td width="18%"><strong>Updated on:</strong></td>
    <td width="80%">2020-08-31</td>
    </tr>
    </tbody>
    </table>
    </div>]]></description>​
​

On en trouve aussi dans /plugins/editors/codemirror/codemirror.xml ligne 291 (html + texte lorem ipsum +même du javascript) dans une balise default d'un champ de type "editor"
etc...

Donc cela doit fonctionner.

[infograf768]

CDATA avec html est aussi utilisé pour les xml de fichiers langue.

<description><![CDATA[<div style="text-align: left;">
<h3>Joomla! 4 Full French (fr-FR) Language Package - Version 4.2.9 v3</h3>
<h3>Pack de langue Joomla! 4 français (fr-FR) complet - Version 4.2.9 v3</h3>
<p><a href="https:/www.joomla.fr" target="_blank">www.joomla.fr</a> - <a href="mailto:traduction@joomla.fr">traduction@joom la.fr</a></p>
</div>]]></description>​

[slhuilli]

Ah cool,
Merci beaucoup. Je regarde tout ca dès ce week end mais c'est ce qui ne marchait pas. En fait, de ce que je vois dans cet exemple, je m'y prenais très mal dant les CDATA où je mettais deux crochets consécutifs.
Je comprends mieux
Merci beaucoup

[slhuilli]

Bonjour
je vous remercie tous, j'ai réussi grace aux CDATA. Impeccable
merci à vous tous