This is a full featured module template for Dolibarr. It's a tool for module developers to kickstart their project and give an hands-on sample of which features Dolibarr has to offer for module development.
If you're not a module developer you have no use for this.
Dolibarr uses Transifex to manage it's translations.
This template also contains a sample configuration for Transifex managed translations under the hidden .tx directory.
For more informations, see the translator's documentation.
The Transifex project for this module is available at http://transifex.com/projects/p/dolibarr-module-template
-
Make sure Dolibarr (>= 3.3.x) is already installed and configured on your workstation or development server.
-
In your Dolibarr installation directory, edit the
htdocs/conf/conf.php
file -
Find the following lines:
//$dolibarr_main_url_root_alt ... //$dolibarr_main_document_root_alt ...
-
Uncomment these lines (delete the leading
//
) and assign a sensible value according to your Dolibarr installationFor example :
-
UNIX:
$dolibarr_main_url_root = 'http://localhost/Dolibarr/htdocs'; $dolibarr_main_document_root = '/var/www/Dolibarr/htdocs'; $dolibarr_main_url_root_alt = '/custom'; $dolibarr_main_document_root_alt = '/var/www/Dolibarr/htdocs/custom';
-
Windows:
$dolibarr_main_url_root = 'http://localhost/Dolibarr/htdocs'; $dolibarr_main_document_root = 'C:/My Web Sites/Dolibarr/htdocs'; $dolibarr_main_url_root_alt = '/custom'; $dolibarr_main_document_root_alt = 'C:/My Web Sites/Dolibarr/htdocs/custom';
For more information about the
conf.php
file take a look at the conf.php.example file. -
Note that for Dolibarr versions before 3.5, the $dolibarr_main_url_root_alt
has to be an absolute path
- Clone the repository in
$dolibarr_main_document_root_alt/mymodule
(You may have to create the htdocs/custom
directory first if it doesn't exist yet.)
git clone git@github.com:GPCsolutions/dolibarr-module-template.git mymodule
-
From your browser:
-
Log into Dolibarr as a super-administrator
-
Under "Setup" -> "Other setup", set
MAIN_FEATURES_LEVEL
to2
-
Go to "Setup" -> "Modules"
-
The module is under one of the tabs
-
You should now be able to enable the new module and start coding ;)
-
Feel free to contribute and report defects at http://github.com/GPCsolutions/dolibarr-module-template/issues
GPLv3 or (at your option) any later version.
See COPYING for more information.
Used to display this README in the module's about page. Licensed under MIT.
Public domain
All texts and readmes.