Documentation Développeur: Difference between revisions
m (→FAQ) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
= Informations générales = | |||
Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr. | Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr. | ||
# [[Projet Dolibarr|Organisation du projet]] | # [[Projet Dolibarr|Organisation du projet]] | ||
| Line 8: | Line 8: | ||
# [[FAQ_D%C3%A9veloppeur#R.C3.A9cup.C3.A9rer.2Fmettre_.C3.A0_jour_la_version_CVS_d.C3.A9veloppeur|Récupérer une version depuis le CVS]] | # [[FAQ_D%C3%A9veloppeur#R.C3.A9cup.C3.A9rer.2Fmettre_.C3.A0_jour_la_version_CVS_d.C3.A9veloppeur|Récupérer une version depuis le CVS]] | ||
= La configuration technique de Dolibarr = | |||
La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. | La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. | ||
Voir [[Fichier de configuration]] pour plus d'informations. | Voir [[Fichier de configuration]] pour plus d'informations. | ||
= La Base de données = | |||
# [[Charte de nommage]] | # [[Charte de nommage]] | ||
# [[Liste des tables]] | # [[Liste des tables]] | ||
# [[Mise à jour du format de la base]] | # [[Mise à jour du format de la base]] | ||
= Liste des modules existant = | |||
La documentation, pour les développeurs, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page [[Modules]]. | La documentation, pour les développeurs, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page [[Modules]]. | ||
La liste des modules complémentaires est définie sur la page des [http://wiki.dolibarr.org/index.php/Category:Modules_compl%C3%A9mentaires Modules complémentaires] | La liste des modules complémentaires est définie sur la page des [http://wiki.dolibarr.org/index.php/Category:Modules_compl%C3%A9mentaires Modules complémentaires] | ||
= 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). | 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. | Un module pour l'IHM contient aussi bien des écrans que des données propres, voir une feuille de style. | ||
| Line 30: | Line 30: | ||
Pour développer votre propre module d'extension des IHM, aller sur le didacticiel: [[Developpement module]] | 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, écriture, etc...). | Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, écriture, 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. | 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. | ||
| Line 36: | Line 36: | ||
Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues d'un autre système, se référer à la page: [[Developpement script]] | Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues 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. | Il existe 2 niveaux de paramétrage dans Dolibarr. | ||
* Le global est stocké dans la [[Table llx_const]]. | * Le global est stocké dans la [[Table llx_const]]. | ||
| Line 43: | Line 43: | ||
Voir la page [[Constantes]] | Voir la page [[Constantes]] | ||
= Le Système de menus = | |||
Voir la page [[Système de menus]] | Voir la page [[Système de menus]] | ||
= Le Système des thèmes = | |||
Voir la page [[Themes]] | Voir la page [[Themes]] | ||
= Le Système des boites = | |||
Voir la page [[Système des boites]] | Voir la page [[Système des boites]] | ||
= Le Système d'authentification = | |||
Voir la page [[Authentification]] | Voir la page [[Authentification]] | ||
= Le Système des permissions = | |||
Voir la page [[Permissions]] | Voir la page [[Permissions]] | ||
| Line 65: | Line 65: | ||
Voir la page [[Gestion d'erreur]] | Voir la page [[Gestion d'erreur]] | ||
= 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 72: | ||
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 = | |||
Voir la page [[Document générés]] | Voir la page [[Document générés]] | ||
= Les exports/imports de masse = | |||
# [[Imports de masse]] | # [[Imports de masse]] | ||
# [[Exports|Exports de masse]] | # [[Exports|Exports de masse]] | ||
= Interfaces et liens avec d'autres applications = | |||
# [[Interfaces Dolibarr vers exterieur]] (Triggers Dolibarr) | # [[Interfaces Dolibarr vers exterieur]] (Triggers Dolibarr) | ||
# [[Interfaces Exterieur vers Dolibarr]] | # [[Interfaces Exterieur vers Dolibarr]] | ||
# [[Services Web]] | # [[Services Web]] | ||
= FAQ = | |||
Toutes FAQ sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]] | Toutes FAQ sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]] | ||
Revision as of 13:43, 29 April 2009
Informations générales
Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr.
- Organisation du projet
- A savoir avant de commencer à developper
- Environnement et Outils de développement
- Librairies externes et dépendances
- Langage et normes de développement
- Récupérer une version depuis le CVS
La configuration technique de Dolibarr
La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. Voir Fichier de configuration pour plus d'informations.
La Base de données
Liste des modules existant
La documentation, pour les développeurs, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page Modules.
La liste des modules complémentaires est définie sur la page des Modules complémentaires
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, écriture, 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 issues 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.
- Le global est stocké dans la Table llx_const.
- Le paramétrage propre à un utilisateur est stocké dans la Table llx_user_param
Voir la page Constantes
Voir la page Système de menus
Le Système des thèmes
Voir la page Themes
Le Système des boites
Voir la page Système des boites
Le Système d'authentification
Voir la page Authentification
Le Système des permissions
Voir la page Permissions
Le Système de traduction
Voir la page Système de traduction
La Gestion d'erreur
Voir la page Gestion d'erreur
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. Plus d'information sur la page Créer un module de numérotation
Les modèles et la génération 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
Le stockage des fichiers/documents
Voir la page Document générés
Les exports/imports de masse
Interfaces et liens avec d'autres applications
- Interfaces Dolibarr vers exterieur (Triggers Dolibarr)
- Interfaces Exterieur vers Dolibarr
- Services Web
FAQ
Toutes FAQ sont disponibles via la page d'index FAQ FR