Changes

<!-- END interlang links -->

<!-- END interlang links -->

= [[File:Art.png]] Validation/activation d'un module externe sur Dolistore =

=[[File:Art.png]] Validation/activation d'un module externe sur Dolistore=

Voici les règles qui prévalent lors de la soumission à validation d'un module sur https://www.dolistore.com.

Voici les règles qui prévalent lors de la soumission à validation d'un module sur https://www.dolistore.com.

=== Nommage du package ===

===Nommage du package===

Tous les modules pour Dolibarr doivent être nommé '''module_mymodulename-VERSION.zip''' (où VERSION peut être x or x.y or x.y.z). Si le module st pour un autre logiciel, le nom du zip doit être '''moduleothersoftware_mymodulename-VERSION.zip''' (par exemple moduleprestashop_mymodulename-1.0.zip).

Tous les modules pour Dolibarr doivent être nommé '''module_mymodulename-VERSION.zip''' (où VERSION peut être x or x.y or x.y.z). Si le module st pour un autre logiciel, le nom du zip doit être '''moduleothersoftware_mymodulename-VERSION.zip''' (par exemple moduleprestashop_mymodulename-1.0.zip).

Le reste du document ne s'applique que pour les modules Dolibarr uniquement.

Le reste du document ne s'applique que pour les modules Dolibarr uniquement.

=== Structure ===

===Structure===

Tous les fichiers d'un module doivent être positionné de manière à suivre l'arborescence exemple proposé dans '''htdocs/modulebuilder/template'''

Tous les fichiers d'un module doivent être positionné de manière à suivre l'arborescence exemple proposé dans '''htdocs/modulebuilder/template'''

=== Inclusion ===  

===Inclusion===  

* Toutes les inclusions de fichier coeur doivent être réalisées par  

 

*Toutes les inclusions de fichier coeur doivent être réalisées par

 

<source lang="php">

<source lang="php">

include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtocorefile';

include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtocorefile';

</source>

</source>

* Toutes les inclusions de fichiers spécifiques au module par les pages du modules doivent être faites avec  

 

*Toutes les inclusions de fichiers spécifiques au module par les pages du modules doivent être faites avec

 

<source lang="php">

<source lang="php">

include_once/require_once/include/require './monmoduledir/...';

include_once/require_once/include/require './monmoduledir/...';

</source>

</source>

* Toutes les inclusions de fichiers spécifiques à un autre module externe doivent être faites par  

 

*Toutes les inclusions de fichiers spécifiques à un autre module externe doivent être faites par

 

<source lang="php">

<source lang="php">

dol_include_once('/extmoduledir/...');

dol_include_once('/extmoduledir/...');

</source>

</source>

=== Lien ===  

===Lien===  

Tous les liens générés pour le HTML vers les pages spécifiques (href, src,...) du module devraient utiliser getNomURL de la classe d'un object ou à minima utiliser dol_buildpath

Tous les liens générés pour le HTML vers les pages spécifiques (href, src,...) du module devraient utiliser getNomURL de la classe d'un object ou à minima utiliser dol_buildpath

=== Répertoire Custom ===  

===Répertoire Custom===  

Un module externe de dolibarr doit pouvoir se mettre dans un répertoire htdocs/custom, tout comme dans htdocs/, et il doit fonctionner dans les deux cas.

Un module externe de dolibarr doit pouvoir se mettre dans un répertoire htdocs/custom (cas standard), tout comme dans htdocs/ (cas alternatif), et il doit fonctionner dans les deux cas.

 

Le module ne doit pas écrire dans l'arborescence des fichiers "'''programmes'''" de Dolibarr mais uniquement dans des fichiers situés dans le répertoire "'''documents'''". Y compris pour des fichiers temporaires. Il ne faut pas oublier que sur une installation correcte de Dolibarr, l'ensemble de l'arborescence des programmes est positionné en lecture seule.

      

      

=== Modifications de fichier core Dolibarr ===

===Modifications de fichier core Dolibarr===

Si des modifications de fichiers coeur de Dolibarr nécessaire au module sont soumises, elles seront acceptées :

Si des modifications de fichiers du coeur de Dolibarr sont nécessaires au module, elles doivent être soumises a uprojet via github. Elles seront acceptées :

* Si elles sont poussées dans la branche dev du GitHub de Dolibarr (cas d'enrichissement de fonctionnalité Dolibarr)

 

* Si il s'agit d'ajout de hook, trigger ou fonction, ou ajout de paramètres optionnels à des fonctions existantes.

*Si elles sont poussées dans la branche dev du GitHub de Dolibarr (cas d'enrichissement de fonctionnalité Dolibarr)

*Si il s'agit d'ajout de hook, trigger ou fonction, ou ajout de paramètres optionnels à des fonctions existantes. L'ajout de hook permet de permettre à un module externe d'intégrer son propre code n'import où dans le code de Dolibarr.

=== Information sur la fiche produit ===

===Information sur la fiche produit===

==== Langue ====

====Langue====

La description du produit est obligatoire en Anglais.

La description du produit est obligatoire en Anglais.

==== Support ====

====Support====

Si votre module est payant, il doit obligatoirement figurer dans la description du produit un mail ou un canal pour le support aux utilisateurs (comme un lien vers un site web de contact)

Si votre module est payant, il doit obligatoirement figurer dans la description du produit un mail ou un canal pour le support aux utilisateurs (comme un lien vers un site web de contact)