Difference between revisions of "Developer documentation"
| Line 34: | Line 34: | ||
To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]] | To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]] | ||
| − | = Setup system = | + | = Technical components of Dolibarr == |
| + | == Setup system == | ||
There is 3 area for Dolibarr setup parameters. | There is 3 area for Dolibarr setup parameters. | ||
* Dolibarr technical 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. | * Dolibarr technical 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. | ||
| Line 40: | Line 41: | ||
* Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information. | * Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information. | ||
| − | = Menus system = | + | == Menus system == |
See page [[Menus system]] | See page [[Menus system]] | ||
| − | = Skins system = | + | == Skins system == |
See page [[Skins]] | See page [[Skins]] | ||
| − | = Box system = | + | == Box system == |
See page [[Box system]] | See page [[Box system]] | ||
| − | = Authentication system = | + | == Authentication system == |
See page [[Authentication]] | See page [[Authentication]] | ||
| − | = Permission system = | + | == Permission system == |
See page [[Permissions En|Permissions]] | See page [[Permissions En|Permissions]] | ||
| − | = Translation system = | + | == Translation system == |
See page [[Translation system]] | See page [[Translation system]] | ||
| − | = Error management = | + | == Error management == |
See page [[Error reporting|Error reporting]] | See page [[Error reporting|Error reporting]] | ||
| − | = Numbering modules = | + | == Numbering modules == |
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module. | For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module. | ||
For more information, see on page [[Create numeration module]] | For more information, see on page [[Create numeration module]] | ||
| − | = Numbering modules and generating documents = | + | == Numbering modules and generating documents == |
More documentation about document generation from modeles is available on page [[Create document model]] | More documentation about document generation from modeles is available on page [[Create document model]] | ||
| − | = Files/Documents storage management = | + | == Files/Documents storage management == |
See page [[Generated documents]] | See page [[Generated documents]] | ||
Revision as of 15:13, 3 September 2010
Development organization and tools
This chapter contains global informations that must be read before to start any development on Dolibarr.
- Organization of project
- To known before to start to develop
- Environment and development tools
- Dependencies and external libraries
- Get the development CVS version
Coding rules
Database
List of existing modules
Technical documentations on standard business modules are available on developer documentation of each modules. Choose page you are interested in to go on it:
- List of standard modules is defined on page List of Modules
- List of other modules is defined on page Complementary modules
To develop a new module/addon for GUI (new screens)
This section describe how to develop a new module on Dolibarr graphic user interfaces (GUI). A GUI module can contains its own screens, its own data and its own CSS stylesheet. Script development is not included in this section (this is described in next chapter). Numbering modules, modules for documents generation, skins or triggers are also described in other following chapters.
To develop your own GUI extension, go on tutorial: Module development
To develop a batch or command line script
This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...). Making modifications on user gui interface (GUI) is not included in this chpter. See previous chapter for this.
To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: Script development
Technical components of Dolibarr =
Setup system
There is 3 area for Dolibarr setup parameters.
- Dolibarr technical 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.
- Global features parameters are stored in Table llx_const. See page Constants for more information.
- Feature parameters for particular users are stored in Table llx_user_param. See page Constants for more information.
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 Permissions
Translation system
See page Translation system
Error management
See page Error reporting
Numbering modules
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.
For more information, see on page Create numeration module
Numbering modules and generating documents
More documentation about document generation from modeles is available on page Create document model
Files/Documents storage management
See page Generated documents
Mass exports/imports
Interfaces and links with other applications
- Interfaces Dolibarr toward foreign systems or toward Dolibarr (Dolibarr Triggers)
- Interfaces from foreign systems toward Dolibarr
- Web Services
FAQ
All FAQ are available through index page FAQ EN