Votre documentation d'extension, vous le gérez comment ?

[cavo789]

Re : Votre documentation d'extension, vous le gérez comment ?

@Manu : imagine un plugin marknotes qui irait lire en direct dans tes .xml :-D

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

uniquement le XML : c'est chaud ... il faut au moins le type mais... dans quel but ?
l'afficher dans un article joomla ?

[cavo789]

Re : Votre documentation d'extension, vous le gérez comment ?

Je pensais un tag tel que %com_allevents% par exemple pour que ton plugin récupère le manifest du composant mentionné et les textes associés exactement ce que ton script déjà codé fait.

Et l'output du script devient le HTML de la note marknotes 😊 et là tu te feras plein de super copains comme Cédric et Yannick.

Note : juste être vigilant à la vitesse du script et à sauver l'output (cache).

[y.berges]

Re : Votre documentation d'extension, vous le gérez comment ?

.... c'est vrai ca un generateur ultime de documentation multi composant (bien codé)

[garstud]

Re : Votre documentation d'extension, vous le gérez comment ?

Hello,
je vous lis avec intérêt

[y.berges]

Re : Votre documentation d'extension, vous le gérez comment ?

ohhh oui une autre personne qui va pouvoir nous aider !

[cavo789]

Re : Votre documentation d'extension, vous le gérez comment ?

Salut messieurs,

Je viens, sur ma machine (pas sur le GitHub de marknotes), de créer un petit plugin Joomla_Doc comme suit :

<?php

namespace MarkNotes\Plugins\Content\HTML;

defined('_MARKNOTES') or die('No direct access allowed');

class Joomla_Doc
{
    public static function doIt(&$content = null) : bool
    {
        if (trim($content) === '') {
            return true;
        }

        $manifest = 'C:\Site\administrator\components\com_contact\contact.xml';

        if (strpos($content, '%com_contacts%') !== false) {
            $tmp = file_get_contents($manifest);
            $content = str_replace('%com_contacts%', '<pre>'.str_replace('<', '&lt;', $tmp).'</pre>', $content);
        }
        return true;
    }

    /**
     * Attach the function and responds to events
     */
    public function bind() : bool
    {
        $aeEvents = \MarkNotes\Events::getInstance();
        $aeEvents->bind('render.content', __CLASS__.'::doIt');
        return true;
    }
}

Ce plugin est appelé par marknotes lors de l'affichage d'une note. L'appel se fait via le $aeEvents->bind() sur l'évènement render.content que j'appelle au moment d'envoyer le HTML de la note markdown (après conversion en html) au navigateur.

Le contenu de la note, au format markdown, est celui-ci :

# Joomla - com_contact

> Manifest du composant com_contact de Joomla!

%com_contacts%

L'idée c'est donc de mettre un tag (ici %com_contacts%) qui serait lu par le plugin (mon petit bout de code ci-dessus) et qui ferait le nécessaire pour extraire les informations. Manu a écrit un tel bout de code : https://github.com/elecoest/AE2MD/bl...ter/MakeMD.php

Faudrait, s'il y a un intérêt, faire un mix et récupérer le code de Manu et en faire un joli plugin marknotes.

Bonne journée.

[y.berges]

Re : Votre documentation d'extension, vous le gérez comment ?

oui je pense qu'un plugin qui permette de choisir un composant serait super !

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

Hello,

Oui c'est énorme comme potentiel. Il y a beaucoup de fichier de config et ... beaucoup de possibilité au niveau du développeur donc il faut adapter qqes fois le programme pour tel ou tel composant.

Je viens de le faire (c'est pas énorme, juste 30 minutes) pour un composant et le rendu est pas mal !

Manu content

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

Christophe,

En regardant ton code en fait dans ton cas c'est Marknotes qui va chercher le plugin qui va lie le manifest.

inconvénient ==> pour générer le contenu de la documentation du manifest, il me faut le fonction de Joomla jlang, jtext...

Une idée comme çà : ton plugin va chercher le contenu de la page via un appel ajax. et çà je sais faire .

Dans mon idée à moi :
- tu as un site joomla
- tu as installé MarkNotes sur ton site dans un répertoire YYY
- tu installes un composant com_manifest2MD en définissant le repertoire YYY qui contiendra les documentations de composants
- en backend, tu crées une entrée pour un la config d'un composant / une vue d'un composant / module / plugin installé sur ton site. Cette entrée servira car pour certain composants connus du marché les noeud père dans les manifest changent, l'utilisateur pour donc dire : pour com_allevents c'est un manifest standard, pour com_moncomposant le manifest commence à $HOME->metadata.
- en backend tu as un bouton de génération de l'arborescence de la future documentation
- en backend tu as un bouton de génération de la documentation pour toutes les entrées définies
- en backend tu peux définir les templates pour chaque type de page généré (en MD bien sur)
- en frontend tu à une liste qui reprend toutes tes documentations générées et quand tu clique dessus tu arrives sur marknotes

J'ai oublié un truc ?

pas de souci : n'hésitez pas à compléter


Au final j'aurais

CreateDirectory(component) // création de l'arborescence des répertoire pour un composant
MakeConfig(component) // génération de la documentation du manifest config.xml
MakeItems(component, Front|Back|Both) // pour tous les ~component/models/forms/*.xml (va boucler sur MakeItem)
MakeItem(component, item, Front|Back|Both) // pour un ~component/models/forms/item.xml
MakeViews(component, Front|Back|Both) // pour tous les ~component/views/*/tmp/default.xml(va boucler sur MakeView)
MakeView(component, view, Front|Back|Both) // pour un ~component/views/view/tmp/default.xml
MakePlugin(plugin,path) // pour un ~plugins/plugin/plugin.xml
MakeModule(module, Front|Back|Both) // pour un ~modules/module/module.xml 

[lomart]

Re : Votre documentation d'extension, vous le gérez comment ?

Salut Manu,

Ton approche me semble idéale car elle permet de définir les paramètres indispensables pour générer la doc.
Elle permet également à un utilisateur lambda de générer la doc d'une extension qu'il utilise pour la prendre plus rapidement en main grace à une lecture à plat des informations.
Pour le template, j'ajouterais la définition de l'attribut paramètre qui définit une classe pour la présentation. (exemple: level pour flexicontent)

@christophe
Marknotes gère t'il les attributs spéciaux de Markdown Extra. C'est à dire la possibilité d'affecter une classe à des éléments ?

[cavo789]

Re : Votre documentation d'extension, vous le gérez comment ?

@loic : j'utilise parsedown de erusev et je vois qu'il propose quelque chose pour markdown extra (https://github.com/erusev/parsedown-extra). À tester donc.

@manu : si je te comprends bien tu auras un plugin dans joomla qui va générer des fichiers md. Si c'est le cas, il n'y a donc strictement rien à faire du côté de marknotes car pour lui ce sera des fichiers statiques, plus de dynamisme. (je te relisais pour être sûr d'avoir bien compris).

Bonne journée

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

oui.

Il faudra pousser le test du coté plugin MarkNotes pour inclure les librairies Joomla. Dans cette optique çà pourrait le faire aussi pour un autre CMS ;-)

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

https://github.com/elecoest/AE2MD

première version du composant, çà fonctionne pour le fichier config, les modules, les plugins. il me reste les views et les items.

N'hésitez pas à le tester, c'est avec vous qu'il sera le plus complet ;-)

Manu

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?



pour vous aider à paramétrer le biniou, exemple avec icagenda.