Difference between revisions of "Developer documentation"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
m (New page: == Global informations == This chapter contains global informations that must be read before to start any development on Dolibarr. # To known before to start # [[Environment and develo...)
 
m
Line 42: Line 42:
 
Voir la page [[Constantes]]
 
Voir la page [[Constantes]]
  
== Le Système de menus ==
+
== Menus system ==
Voir la page [[Système de menus]]
+
See page [[Menus system]]
  
== Le Système des thèmes ==
+
== Skins system ==
Voir la page [[Themes]]
+
See page [[Skins]]
  
== Le Système des boites ==
+
== Box system ==
Voir la page [[Système des boites]]
+
See page [[Box system]]
  
== Le Système d'authentification ==
+
== Authentication system ==
Voir la page [[Authentification]]
+
See page [[Authentication]]
  
== Le Système des permissions ==
+
== Permission system ==
Voir la page [[Permissions]]
+
See page [[PermissionsEn]]
  
== Le Système de traduction ==
+
== Trnaslation system ==
Voir la page [[Système de traduction]]
+
See page [[Translation system]]
  
== La Gestion d'erreur ==
+
== Error management ==
 +
See page [[Error reporting|Error reporting]]
  
* Voir la page [[Gestion d'erreur]]
+
== Numbering modules ==
* See page [[Error reporting|Error reporting]]
 
 
 
== Les modules de numérotation ==
 
 
Pour chaque entité crée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.
 
Pour chaque entité crée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.
 
Plus d'information sur la page [[Créer un module de numérotation]]
 
Plus d'information sur la page [[Créer un module de numérotation]]
Line 72: Line 70:
 
Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Creer un modele de document]]
 
Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Creer un modele de document]]
  
== Le stockage des fichiers/documents ==
+
== Files/Documents storage management ==
Voir la page [[Document générés]]
+
See pagee [[Generated documents]]
  
== Les exports/imports de masse ==
+
== Mass exports/imports ==
# [[Imports de masse]]
+
# [[Mass imports]]
# [[Exports|Exports de masse]]
+
# [[Mass exports]]
  
== Interfaces et liens avec d'autres applications ==
+
== Interfaces and links with other applications ==
# [[Interfaces Dolibarr vers exterieur]] (Triggers Dolibarr)
+
# [[Interfaces Dolibarr toward foreign systems]] (Dolibarr Triggers)
# [[Interfaces Exterieur vers Dolibarr]]
+
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Services Web]]
+
# [[Web services]]
  
 
== FAQ ==
 
== FAQ ==
# [[FAQ Développeur]]
+
# [[Developer FAQ]]

Revision as of 21:29, 7 January 2009

Global informations

This chapter contains global informations that must be read before to start any development on Dolibarr.

  1. To known before to start
  2. Environment and development tools
  3. Dependencies and external libraries
  4. Langage and development rules
  5. Get a version from CVS

Technical setup of Dolibarr

Dolibarr setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See Configuration file for more information.

Database

  1. Naming rules
  2. List of tables
  3. Database structure update

Understand an existing module

Documentations, for developers, for a standard business modules, are defined on page ModulesEn.

List of other modules is defined on page [1]

Développer un nouveau module/extension pour les IHM (nouveaux écrans)

Cette section décrit comment développer un nouveau module sur l'interface utilisateur de Dolibarr (IHM). Un module pour l'IHM contient aussi bien des écrans que des données propres, voir une feuille de style. Le développement de script ne rentre pas dans ce périmètre et est décrit au chapitre suivant. Le développement de modules de numérotations, de documents, de thèmes ou de triggers est décrit dans des chapitres suivants également.

Pour développer votre propre module d'extension des IHM, aller sur le didacticiel: Developpement module

Développer un script ligne de commande ou batch

Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, eccriture, etc...). La réalisation de modification sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issus d'un autre système, se référer à la page: Developpement script

Le Système de paramétrage

Il existe 2 niveaux de paramétrage dans Dolibarr.

Voir la page Constantes

Menus system

See page Menus system

Skins system

See page Skins

Box system

See page Box system

Authentication system

See page Authentication

Permission system

See page PermissionsEn

Trnaslation system

See page Translation system

Error management

See page Error reporting

Numbering modules

Pour chaque entité crée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation. Plus d'information sur la page Créer un module de numérotation

Les modèles et la géneration de documents

Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page Creer un modele de document

Files/Documents storage management

See pagee Generated documents

Mass exports/imports

  1. Mass imports
  2. Mass exports

Interfaces and links with other applications

  1. Interfaces Dolibarr toward foreign systems (Dolibarr Triggers)
  2. Interfaces from foreign systems toward Dolibarr
  3. Web services

FAQ

  1. Developer FAQ