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

[liubov]

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

Manu,
installation => ok.
mais, j'ai posté une Issue, suite à erreur sql.

 Unknown column 'a.catid' in 'on clause'

https://github.com/elecoest/Manifest2MD/issues/7

[liubov]

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

Problème trouvé : mauvais nom de champ category => catid.

Table 'manifest2md_extensions'

ALTER TABLE `#__manifest2md_extensions` CHANGE `category` `catid` INT(11) NOT NULL;

et tout refonctionne

[liubov]

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

Extra Manu. très très bonne améliorations !

Si je peux me permettre, il y a un soucis structurel dans la recherche des .xml, je te donne un exemple avec mon composant: (présentation au JDay 2017)


, * NOT EXIST :
/var/www/html/joomla370/joomla-cms/administrator/components/conference/models/forms/jdayprogram.xml
, * NOT EXIST :
/var/www/html/joomla370/joomla-cms/administrator/components/coverfield/models/forms/jdayprogram.xml
, * NOT EXIST :
/var/www/html/joomla370/joomla-cms/administrator/components/horaire/models/forms/jdayprogram.xml
, * NOT EXIST :
/var/www/html/joomla370/joomla-cms/administrator/components/intervenant/models/forms/jdayprogram.xml
, * NOT EXIST :
/var/www/html/joomla370/joomla-cms/administrator/components/jday2017/models/forms/jdayprogram.xml
, * NOT EXIST :
/var/www/html/joomla370/joomla-cms/administrator/components/session/models/forms/jdayprogram.xml
, * NOT EXIST :
/var/www/html/joomla370/joomla-cms/administrator/components/theme/models/forms/jdayprogram.xml

Correction de recherche requise (standard MVC):

/var/www/html/joomla370/joomla-cms/administrator/components/com_jdayprogram/conference/models/forms/conference.xml

/var/www/html/joomla370/joomla-cms/administrator/components/com_jdayprogram/coverfield/models/forms/coverfield.xml

/var/www/html/joomla370/joomla-cms/administrator/components/com_jdayprogram/horaire/models/forms/horaire.xml

/var/www/html/joomla370/joomla-cms/administrator/components/com_jdayprogram/intervenant/models/forms/intervenant.xml

/var/www/html/joomla370/joomla-cms/administrator/components/com_jdayprogram/jday2017/models/forms/jday2017.xml

/var/www/html/joomla370/joomla-cms/administrator/components/com_jdayprogram/session/models/forms/session.xml

/var/www/html/joomla370/joomla-cms/administrator/components/com_jdayprogram/theme/models/forms/theme.xml

[elecoest]

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

je viens de versionner. tu peux ressayer stp ?

j'ai mis en place les templates aussi

[liubov]

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

=> Mise à jour composant OK (2 méthodes: update et réinstall OK)
=> Config OK


=> Make MD OK


Un super boulot Manu! J'entrevois un extraordinaire potentiel de cette extension pour la réalisation
rapide d'une partie de la documentation d'un Composant.

Manifest2md & MarkNotes

@ suivre ...

[elecoest]

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

C'est cool ! On partage le même point de vue sur les possibilités et çà te permet de vérifier ta documentation interne au produit. Pour les développeurs d'une extension, tu peux faire ton propre template avec des liens vers ton site &cie.

Coté developpement il faut que je regarde car :
- certaines vues en front ne sont pas accessible directement via une entrée de menu => elles sont quand même documentée
- certains objets du type filter_xxx qui permettent d'ajouter un filtre dans une vue backend sont aussi documenté

Pour le 1er cas je propose que le développeur supprime le fichier xml qui ne sert que pour l'entrée menu
Pour le 2eme cas je propose un paramètre de prise en compte ou non des filter_xxx

Sachant que les paramètres d'un filter_xxx sont différents, il faut que je fasse une documentation spécifique

Manu

[liubov]

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

Comment utilises tu la configuration des Templates ?
Oui, je veux bien en savoir plus la dessus

De mon côté, je regarde un peu comment mieux formatter le fichier .md. Il y a des choses récupérables, l'ajout des indentations '#', '##', '###' pour que le fichier brut soit directement lisible sous MarkNotes.
Si le standard de l'API est respecté :
- Tous les Filtres des vues Frontend (vus par les liens de Menus des Layouts), sont définis dans :
site/models/forms/*.xml
Exemple:

<?xml version="1.0" encoding="utf-8"?>
<form>
	<fieldset name="default.filters" addfieldpath="/administrator/components/com_jdprogram/models/fields">

		<field name="search_search_salles"
				listKey="id"
				labelKey="titre"
				type="cksearch"
				placeholder="JDPROGRAM_FILTER_NULL_RECHERCHE"
				label="JDPROGRAM_JSEARCH_RECHERCHE"
				class="element-filter element-search search-query"
				ui="chosen"/>

		<field name="filter_jour"
				listKey="value"
				labelKey="text"
				type="enum"
				submit="true"
				nullLabel="JDPROGRAM_FILTER_NULL_JOUR"
				enum="jdays2017_jour"
				label="JDPROGRAM_JSEARCH_JOUR"
				class="element-filter"
				ui="chosen"/>

		<field name="filter_class"
				listKey="value"
				labelKey="text"
				type="enum"
				submit="true"
				nullLabel="JDPROGRAM_FILTER_NULL_CLASS"
				enum="jdays2017_class"
				label="JDPROGRAM_JSEARCH_CLASS"
				class="element-filter"
				ui="chosen"/>

		<field name="sortTable"
				type="cksort"
				responsive="hidden-phone"
				submit="true"
				nullLabel="JGLOBAL_SORT_BY"
				class="span-2 element-filter"
				label="Sort by"
				ui="chosen"/>

		<field name="directionTable"
				type="ckdirection"
				responsive="hidden-phone"
				submit="true"
				nullLabel="JFIELD_ORDERING_DESC"
				class="span-2 element-filter"
				label="Direction"
				ui="chosen"/>

		<field name="limit"
				type="cklimit"
				submit="true"
				class="span-2 element-filter"
				label="Limit"
				ui="chosen"/>
	</fieldset>
</form>

- Tous les Filtres des vues Backend sont définis dans :
admin/models/forms/*.xml

[elecoest]

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

pour les templates c'est dans les paramètres

Exemple pour un module AllEvents :

# {extension_name}

[](http://documentation.allevents3.com/...allevents.html)

 <br/><br/>

Thank you for downloading our product. If you have any questions that are beyond the scope of this help file, please feel free to email via our [user page contact form](https://www.allevents3.com/en/support). Thanks so much!

## Description
{description}


**Why choose AllEvents Premium ?**

* Display your events friendly.
* View events via multiple layout.
* User friendly interface.
* Full layout or Compact layout.
* ...

<a class="btn btn-success" href="https://www.allevents3.com/en/buy">Subscribe Now</a> or [Live Demo](https://www.allevents3.com/en/demo/{extension})

## Install the module
1. Download the extension to your local machine as a zip file package.
2. From the backend of your Joomla site (administration) select **Extensions >> Manager**, then Click the <b>Browse</b> button and select the extension package on your local machine. Then click the **Upload & Install** button to install module.
3. Go to **Extensions >> Module**, find and click on **{extension_name}**. Then enable it.

## Configure the module
Once you have created a new AllEvents module, you can quickly gain access to its customization options by visiting `Administrator -> Extensions -> Module Manager` and selecting your AllEvents module.

Creating a new module is a simple process, as well. You just navigate to the **Module Manager** and select **New** on the toolbar in the upper-left area of the page.

Below, we have outlined the options available to you as you configure your AllEvents module :

<br/>

{parameters}

## My events are not displayed

If you want to display the events on the AllEvents - Module Based on uikit, you should make sure that:

1. The module or plugin is published (obviously)
2. The module assigned to a visible module position. There can be many module positions listed for you to select, but make sure that the module position you select is visible in front-page.
3. The module is assigned to a menu. When you want to display a module on specific menus, you need to assign it to the menus.
4. the filters selected have events (obviously).
5. your entities filtred are published.

## Frequently Asked Questions
No questions for the moment

## Uninstall the module
1. Login to Joomla backend.
2. Click **Extensions >> Manager** in the top menu.
3. Click **Manage** on the left, navigate on the extension and click the Uninstall button on top.

Once again, thank you so much for downloading our product. As I said at the beginning, I\'d be glad to help you if you have any questions relating to this product. No guarantees, but I\'ll do my best to assist.

> ###### Created on *{extension_date}* by *{extension_author}* ([{extension_authorEmail}](mailto:{extension_authorEmail}))

[elecoest]

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

Pour les fichiers oui je sais ou ils sont ;-)

Pour le filter je vais les mettre en place donc.

[elecoest]

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

pour les filter c'est fait.

PS : cà m'a permis de créer des entrées de traductions "oubliées"

Vous souhaitez voir ce que çà donne avec mon composant : http://www.allevents3.com/documentation/

tout est présent avec un template spécifique AllEvents.

[liubov]

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

Yeah, impec !

OK pigé, le Template, c'est ce que tu ajoutes en début de fichier .md en fonction de l'élément généré (conf, view, item, Module, Pluginetc ...)
pour sa futur présentation dans Marknotes. Ouais, pas mal du tout

ça en fait des fichiers de doc au final !

Dis moi quand tu mets Git à jour

[elecoest]

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

git est à jour

[liubov]

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

Vraiment TROP GENIAL !

J'ai couplé le répertoire /Documentation d'un Joomla3.7 et ton composant, avec le rép /Docs de MarkNotes (via un lien symbolique), pour une lecture et modification des fichiers, en Live.

Franchement tu pourrais présenter cet outil, ce composant Joomla, aux Lightning Talks de Christophe. Il recrute en plus

[cavo789]

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

Je recrute en effet pour les Lightning Talks. Allez Manu Marseille te réclame ;-)

[elecoest]

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

profession de foi de ma fille donc sans moi. Mais je suis sur que l'un d'entre vous pourra présenter ce début de projet à tout le monde ^_^. Il faut attendre aussi le retour de la doc sur flexicontent...