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

Réduire
X
  • Filtrer
  • Heure
  • Afficher
Tout effacer
nouveaux messages

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

    Hello,

    Petite question, la doc de votre module, plugin, composant,... vous le gérer comment ?

    genre à chaque nouveau paramètre ? vous mettez à jour une page de documentation ? vous avez un template pour ce type de documentation ?

    Merci les amis.

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

    suite à plusieurs question en privé, ma question est : comment bien afficher les informations sur ses plugins, modules, pages, paramètres... dans sa documentation.

    Avec marknotes, j'ai développé ce WE un générateur de doc au format Markdown. Ceci pour tout le composant AllEvents. C'est fonctionnel, çà a un beau rendu, c'est du joomla pour du joomla... Maintenant je recherche les bonnes pratiques de mise à jour des doc...

    Voici ce que çà donne : http://marknotes.allevents3.com/ toute la partie dans le repertoire AllEvents est générée en automatique depuis les différents fichiers de configuration du composant.

    Commentaire


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

      Tu as programmé un script en php qui génère automatiquement tes fichiers de documentation (au format Markdown) depuis les fichiers XML de tes programmes ? (composant/modules/plugins)

      C'est topissime !
      Christophe (cavo789)
      Logiciel gratuit de scan antivirus : https://github.com/cavo789/aesecure_quickscan (plus de 45.000 virus détectés, 700.000 fichiers sur liste blanche)
      Développeur de marknotes, logiciel de gestion de prises de notes avec interface web et de multiples convertisseur https://github.com/cavo789/marknotes
      Mes logiciels OpenSource : https://www.avonture.be

      Commentaire


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

        Oui c'est bien cela.
        et depuis cet après midi, idem pour le fichier config.xml lié au access.xml.

        Avec çà j'ai tous les paramètres. Merci aux fichiers manifest de joomla qui sont bien fait donc c'est simple d'avoir ce rendu.

        Commentaire


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

          Cool! Faudra promouvoir cet outil à d'autres programmeurs joomla.
          Christophe (cavo789)
          Logiciel gratuit de scan antivirus : https://github.com/cavo789/aesecure_quickscan (plus de 45.000 virus détectés, 700.000 fichiers sur liste blanche)
          Développeur de marknotes, logiciel de gestion de prises de notes avec interface web et de multiples convertisseur https://github.com/cavo789/marknotes
          Mes logiciels OpenSource : https://www.avonture.be

          Commentaire


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

            pour le moment c'est expérimental mais oui pourquoi pas

            Commentaire


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

              salut
              question intéressante, Marknotes nous interroge sur l'amélioration de nos documentations
              je suis aussi en train de me creuser la tete, je suis donc cette discussion avec attention
              CEd
              Vive Joomla! http://www.joomlack.fr Tutoriels et extensions pour Joomla!. Livre création de template Joomla de plus de 200 pages.
              http://www.template-creator.com Outil de création de templates
              Module Maximenu CK - Megamenu, multicolonnes, chargement de module, description de lien, deroulement animé - Compatible Virtuemart, Hikashop

              Commentaire


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

                Pour info, j'ai commencé à développer un plugin de type "content" (un peu à la Joomla). J'en ai parlé hier nuit sur mon FB.

                L'idée est que marknotes génère un évènement juste avant l'affichage d'une note et transmets le contenu html de celle-ci. En interceptant cet évènement, on peut alors intervenir sur le code html (ajouter une div, remplacer une variable, exécuter du code php pour injecter le résultat dans le code (p.ex. lire un fichier externe), etc.)

                Affaire à suivre.
                Christophe (cavo789)
                Logiciel gratuit de scan antivirus : https://github.com/cavo789/aesecure_quickscan (plus de 45.000 virus détectés, 700.000 fichiers sur liste blanche)
                Développeur de marknotes, logiciel de gestion de prises de notes avec interface web et de multiples convertisseur https://github.com/cavo789/marknotes
                Mes logiciels OpenSource : https://www.avonture.be

                Commentaire


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

                  le plugin content c'est très simple.
                  EDIT : très simple car on a l'URL de la note.

                  Le top serait d'hériter du css du site joomla et que le contenu de la note MD soit repris à l'exception de la TOC.

                  Perso Ced1870 je peux t'envoyer le code pour générer la documentation d'un module ;-)
                  Dernière édition par elecoest à 19/04/2017, 09h37

                  Commentaire


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

                    ouais je veux bien tester

                    Le top serait d'hériter du css du site joomla et que le contenu de la note MD soit repris à l'exception de la TOC.
                    normalement c'est juste du html/css à modifier dans ton template Marknotes (si j'ai compris comment ça marche)

                    j'ai un peu discuté avec Cavo, et il a soulevé un point intéressant sur le référencement. Si tu mets toute la doc sur un sous-domaine, tu peux perdre de la valeur pour le site principal par rapport à si tu mets la doc sur le domaine principal
                    Sans compter la gestion entre le payant et le gratuit (j'ai des docs payantes)
                    J'en suis encore au stade réflexion ...
                    Vive Joomla! http://www.joomlack.fr Tutoriels et extensions pour Joomla!. Livre création de template Joomla de plus de 200 pages.
                    http://www.template-creator.com Outil de création de templates
                    Module Maximenu CK - Megamenu, multicolonnes, chargement de module, description de lien, deroulement animé - Compatible Virtuemart, Hikashop

                    Commentaire


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

                      pourquoi pas un composant Joomla! qui récupérerait le buffer HTML généré par Marknotes, et l'afficherait dans la zone de contenu
                      ça garderait le domaine principal, ça serait bon pour le référencement, et ça garderait la charte graphique
                      après à voir comment lier l'arborescence du menu MN pour actualiser les pages (en Ajax ?)

                      c'est une idée en passant ...
                      Vive Joomla! http://www.joomlack.fr Tutoriels et extensions pour Joomla!. Livre création de template Joomla de plus de 200 pages.
                      http://www.template-creator.com Outil de création de templates
                      Module Maximenu CK - Megamenu, multicolonnes, chargement de module, description de lien, deroulement animé - Compatible Virtuemart, Hikashop

                      Commentaire


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

                        on est bien en phase

                        Maintenant ton sous domaine tu peux aussi le définir en répertoire. Dans mon cas : www.AllEvents3.com/marknotes

                        je t'envoie le code sur quelle adresse ?

                        Commentaire


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

                          ah oui pas mal
                          petit aparté sur les css/responsive, il va falloir améliorer un peu ça car dans les deux directions ça ne s'adapte pas très bien (meme si on modifie que la hauteur de la fenetre, ça reste figé et la scrollbar ne s'affiche pas forcément ce qui empeche la lecture du contenu)
                          @cavo : on peut voir ça ensemble si tu as besoin d'aide sur la partie CSS

                          maintenant j'ai quand meme une question référencement. Les notes sont chargées en Ajax et la page ne se recharge pas (très bien pour la rapidité), mais ça ne sera pas indexé par les moteurs alors ?

                          (désolé si je sors un peu du sujet initial)
                          Vive Joomla! http://www.joomlack.fr Tutoriels et extensions pour Joomla!. Livre création de template Joomla de plus de 200 pages.
                          http://www.template-creator.com Outil de création de templates
                          Module Maximenu CK - Megamenu, multicolonnes, chargement de module, description de lien, deroulement animé - Compatible Virtuemart, Hikashop

                          Commentaire


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

                            Envoyé par ced1870 Voir le message
                            ah oui pas mal
                            petit aparté sur les css/responsive, il va falloir améliorer un peu ça car dans les deux directions ça ne s'adapte pas très bien (meme si on modifie que la hauteur de la fenetre, ça reste figé et la scrollbar ne s'affiche pas forcément ce qui empeche la lecture du contenu)
                            @cavo : on peut voir ça ensemble si tu as besoin d'aide sur la partie CSS
                            C'est un projet Open Source Cédric : récupère le dépôt sur GitHub et modifie mes fichiers puis propose un "PR" ;-)
                            Merci car oui, un peu d'aide côté design est plus que bienvenue.

                            (ai-je déjà dit que j'étais nul sur ce point-là ? :-D )

                            Envoyé par ced1870 Voir le message
                            maintenant j'ai quand meme une question référencement. Les notes sont chargées en Ajax et la page ne se recharge pas (très bien pour la rapidité), mais ça ne sera pas indexé par les moteurs alors ?)
                            Là, c'est simple : sitemap.xml.

                            Référence le tonsite/marknotes/sitemap.xml et le tour est joué.

                            (ce fichier n'existe pas mais le routeur est assez intelligent que pour le générer à la volée)
                            Christophe (cavo789)
                            Logiciel gratuit de scan antivirus : https://github.com/cavo789/aesecure_quickscan (plus de 45.000 virus détectés, 700.000 fichiers sur liste blanche)
                            Développeur de marknotes, logiciel de gestion de prises de notes avec interface web et de multiples convertisseur https://github.com/cavo789/marknotes
                            Mes logiciels OpenSource : https://www.avonture.be

                            Commentaire


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

                              (ai-je déjà dit que j'étais nul sur ce point-là ? :-D )
                              heu ... comment dire ...

                              je prends note pour le sitemap

                              Pour github, je n'ai jamais pris le temps de bien m'y pencher donc je ne l'utilise pas pour l'instant
                              j'ai essayé une fois, j'ai mis 1h à soumettre un truc pour lequel je n'ai jamais réussi à supprimer un espace en trop ...
                              Vive Joomla! http://www.joomlack.fr Tutoriels et extensions pour Joomla!. Livre création de template Joomla de plus de 200 pages.
                              http://www.template-creator.com Outil de création de templates
                              Module Maximenu CK - Megamenu, multicolonnes, chargement de module, description de lien, deroulement animé - Compatible Virtuemart, Hikashop

                              Commentaire

                              Annonce

                              Réduire
                              1 sur 2 < >

                              C'est [Réglé] et on n'en parle plus ?

                              A quoi ça sert ?
                              La mention [Réglé] permet aux visiteurs d'identifier rapidement les messages qui ont trouvé une solution.

                              Merci donc d'utiliser cette fonctionnalité afin de faciliter la navigation et la recherche d'informations de tous sur le forum.

                              Si vous deviez oublier de porter cette mention, nous nous permettrons de le faire à votre place... mais seulement une fois
                              Comment ajouter la mention [Réglé] à votre discussion ?
                              1 - Aller sur votre discussion et éditer votre premier message :


                              2 - Cliquer sur la liste déroulante Préfixe.

                              3 - Choisir le préfixe [Réglé].


                              4 - Et voilà… votre discussion est désormais identifiée comme réglée.

                              2 sur 2 < >

                              Assistance au forum - Outil de publication d'infos de votre site

                              Compatibilité: PHP 4.1,PHP4, 5, 6DEV MySQL 3.2 - 5.5 MySQLi from 4.1 ( @ >=PHP 4.4.9)

                              Support Version de Joomla! : | J!3.0 | J!2.5.xx | J!1.7.xx | J!1.6.xx | J1.5.xx | J!1.0.xx |

                              Version française (FR) D'autres versions sont disponibles depuis la version originale de FPA

                              UTILISER À VOS PROPRES RISQUES :
                              L'exactitude et l'exhaustivité de ce script ainsi que la documentation ne sont pas garanties et aucune responsabilité ne sera acceptée pour tout dommage, questions ou confusion provoquée par l'utilisation de ce script.

                              Problèmes connus :
                              FPA n'est actuellement pas compatible avec des sites Joomla qui ont eu leur fichier configuration.php déplacé en dehors du répertoire public_html.

                              Installation :

                              1. Téléchargez l'archive souhaitée : http://afuj.github.io/FPA/

                              Archive zip : https://github.com/AFUJ/FPA/zipball/master

                              2. Décompressez le fichier de package téléchargé sur votre propre ordinateur (à l'aide de WinZip ou d'un outil de décompression natif).

                              3. Lisez le fichier LISEZMOI inclus pour toutes les notes de versions spécifiques.

                              4. LIRE le fichier de documentation inclus pour obtenir des instructions d'utilisation détaillées.

                              5. Téléchargez le script fpa-fr.php à la racine de votre site Joomla!. C'est l'endroit que vous avez installé Joomla et ce n'est pas la racine principale de votre serveur. Voir les exemples ci-dessous.

                              6. Exécutez le script via votre navigateur en tapant: http:// www. votresite .com/ fpa-fr.php
                              et remplacer www. votresite .com par votre nom de domaine


                              Exemples:
                              Joomla! est installé dans votre répertoire web et vous avez installé la version française du fichier FPA:
                              Télécharger le script fpa-fr.php dans: /public_html/
                              Pour executer le script: http://www..com/fpa-fr.php

                              Joomla! est installé dans un sous-répertoire nommé "cms" et vous avez installé la version française du fichier FPA:
                              Télécharger le script fpa-fr.php dans: /public_html/cms/
                              Pour executer le script: http://www..com/cms/fpa-fr.php

                              En raison de la nature très sensible de l'information affichée par le script FPA, il doit être retiré immédiatement du serveur après son utilisation.

                              Pour supprimer le script de votre site, utilisez le lien de script de suppression fourni en haut de la page du script. Si le lien de suppression échoue pour supprimer le script, utilisez votre programme FTP pour le supprimer manuellement ou changer le nom une fois que le script a généré les données du site et le message publié sur le forum. Si le script est toujours présent sur le site, il peut être utilisé pour recueillir suffisamment d'informations pour pirater votre site. Le retrait du script empêche des étrangers de l'utiliser pour jeter un oeil à la façon dont votre site est structuré et de détecter les défauts qui peuvent être utilisé à vos dépends.
                              Voir plus
                              Voir moins

                              Partenaire de l'association

                              Réduire

                              Hébergeur Web PlanetHoster
                              Travaille ...
                              X