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

[elecoest]

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

En regardant de plus près... c'est une arborescence donc orienté développeur plus orienté utilisateur final. Un utilisateur sait qu'il a une entrée de menu en front. L'arborescence exacte il s'en moque

Idem pour les plugins, il a besoin de connaitre ses plugins... maintenant que c'est un plugin pour le xtd-editors...

Idem pour les modules, il connait le nom du module (il le voit dans les modules pour Joomla), là çà fait une arborescence donc un niveau en plus.

C'est pour çà que j'avais tout mis avec une racine XXX qui correspondait à la catégorie que le développeur souhaite présenter à ses utilisateurs.

Une idée, choisir la présentation finale : Mode développeur / Mode utilisateur. Mode développeur = Arborescence, Mode utilisateur = Affichage direct.


J'ai laissé mon ancienne doc pour qe tu vois la différences

Manu

[liubov]

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

En regardant de plus près... c'est une arborescence donc orienté développeur plus orienté utilisateur final. Un utilisateur sait qu'il a une entrée de menu en front. L'arborescence exacte il s'en moque

Écoute, j'étais dessus (ta doc MarNotes) et c'est vrai que je me fesais exactement la même réflexion !
Scanner un maximum de composant est enrichissant

Cette première étape m'a permis de réorienter la recherche structurelle. Je voulais créer uniquement une arborescence qui contenait quelque chose. Dans la V1, j'avais des répertoires créés, avec plein de fichiers défaut (Template), mais vides, car pas de xml.
C'est pour cela que j'ai figé l'arbo standard des xml, et que la création des répertoires est conditionnelle (xml? oui/non).

Extensions->Extension->CheckFolders->MakeMD(); 

Donc d'accord avec toi, pour un output 'Lisible' par l'utilisateur. Le core est là, la mise en forme doit se gérer assez facilement.

[elecoest]

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

on est en phase, c'est juste de la présentation

[liubov]

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

Je veux bien faire ce change:

=> 2 outputs: Utilisateur ou Développeur
=> revoir output Utilisateur: est ce que cela te convient ?

-Category
-- Component Name
--- FrontEnd
---- Vues (Lien de Menus)
----- *.md
---- Models/Items (j'ai du mal avec Items, pour moi ça signifie 'données' or on présente des champs/filtres ...)
----- *.md

--- BackEnd
---- Vues
----- *.md
---- Models/Items/autre idée?
----- *.md
--- config.md

-- Module Name
--- *.md

-- Plugin Name
--- *.md

[elecoest]

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

exactement çà !

Emmanuel

[liubov]

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

Nouvelle version/2.1.0
Installation via URL : https://jbreeding.github.io/com_mani...anifest2md.xml

Change Log:
+ paramètre Mode d'édition [Dev / User].
+ entêtes et titres traduits.

Extensions : Sites de mise à jour

Info: j'ai renommé mon repository Git pour la synchro avec NetBeans8.2. Il faudra donc supprimer et reconstruire la nouvelle URL pour le suivi des mises à jours ...

[y.berges]

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

hello je suis passé sur ton compo !! de la balle
par contre j'ai pas l'option dev/user et je trouve comment faire une doc multilangue ... mais c'est super prometteur

[liubov]

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

Merci pour l'appréciation.

Si tu as installé la version si dessus (v2.1.0), elle inclus ce nouveau paramètre.


Pour la génération des documents, le fichier de paramètres du composant charge les codes Lang installés, donc c'est dynamique à ce niveau.
Cependant, le composant n'intègre que les traductions de fr-FR et en-GB. Si tu as d'autres langues, faut rajouter les fichiers .ini correspondants... et traduire !

[y.berges]

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

bon bizarre j'ai pas l'option doc mais pas grave
j'ai fait une doc 7 langues !!!!!
j'adore : j'ai ouvert 2 issues
mais mille merci

[liubov]

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

et dans Extensions/Gestion/Manifest2md ça dit quoi coté infos de version ?
Le Mode 'Utilisateur' est mieux, destiné aux Utilisateurs ...

Si pb avec Joomla update, réinstalle avec l'url directe du package:

https://jbreeding.github.io/com_manifest2md/updates/com_manifest2md.zip

Ok pour les 2 issues.
Pour le multi-lang, j'ajoute un paramètre 'All'. MakeMD générera autant de dossiers que de Langages installés.
Clés de trad à ta charge, que je récupérerai pour intégration, merci d'avance

[y.berges]

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

hello
desoler c'est quoi cles de trad ???? lol
franchement ca va être topissime !!!
par contre j'ai pas réellement compris pourquoi certain md ne ce créer pas, tu as parler d'un espace dans les fichiers qui pose soucis ... une correction de mon coté ou un cas spécial que tu peus gérer dans le composant ?

MErci

edit je revient de faire une mise à jour en telechargent le zip master + installation je suis toujour en 2.0

[lomart]

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

Salut Marc,

Il ne me semble pas que tu prennes en charge les fichiers langages dans le dossier de l'extension comme préconisé par Joomla : https://docs.joomla.org/Manifest_files#Language_files

"Since Joomla! 1.6 it has been encouraged placing your extension's language files in your extension folder. Joomla! will then automatically load your extension's language files."

Encore bravo pour ton engagement sur ce projet

[liubov]

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

Lomart,

tu as tout as fait raison. j'ai failli tout réécrire avec Cook, mais bon, la surcharge de travail ne se justifiait pas au regard de 2 ou trois éléments hors standard, surtout que c'est toujours supporté ainsi.

[liubov]

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

desoler c'est quoi cles de trad ???? lol

Le composant intègre 2 fichiers de Lang:

• en-GB.com_manifest2md.ini
• fr-FR.com_manifest2md.ini

Quand tu généreras la documentation pour tes 7 langues installées, il te manquera les 5 fichiers correspondant aux autres langues. il faudra que tu les crées et que tu les traduises.

CLÉ="Traduction"

MANIFEST2MD_FIELD_CATEGORY_NAME="Category Name"
MANIFEST2MD_FIELD_DOC_ELEMENT="Doc element"
MANIFEST2MD_FIELD_ELEMENT="Element"
MANIFEST2MD_FIELD_FOLDER="Folder"

[y.berges]

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

ok merci