From 2ec5ffee48491da78a20fb2f88f0f858c9fd1753 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sat, 5 Jul 2008 11:27:23 +0000 Subject: [PATCH] Documentation --- dev/README.txt | 6 ++++-- dev/skeletons/README | 48 ++++++++++++++++++++++---------------------- 2 files changed, 28 insertions(+), 26 deletions(-) diff --git a/dev/README.txt b/dev/README.txt index 33970acfad1..8d306b231e6 100644 --- a/dev/README.txt +++ b/dev/README.txt @@ -1,7 +1,9 @@ README (English) -------------------------------- -This directory contains sub-directories to provide -tools or documentation for developers. +This directory contains sub-directories to provide tools or +documentation for developers. +Note: All files in this directory are in CVS only and are not +provided with a standard release. There is also some documentation (in French) on Dolibarr diff --git a/dev/skeletons/README b/dev/skeletons/README index fe599fc0bec..db9c424677c 100644 --- a/dev/skeletons/README +++ b/dev/skeletons/README @@ -1,24 +1,24 @@ -README (english) --------------------------------- -This directory contains PHP script samples that can be used to start a development on Dolibarr. - - -modMyModule.class.php: -Is a sample of module descriptor you can use if you want to build a new module/plugin for -Dolibarr. - -skeleton_script.php: -Is a sample you can use as an example if you need to build a script to run on command line - -skeleton_page.php: -Is a sample you can use as an example if you need to build an HTML page to include in Dolibarr GUI. - -skeleton_class.class.php: -Is a sample you can use as an example if you need to build a class file to access a new table -required by a Dolibarr development. -However it is better to run the script build_class_from_table.php that accept a table name as a -parameter and will used table description in database and the skeleton_class.class.php file to -generate full code for your class file. -After running this script, the class to access your table (insert a record, update, delete and select) -is directly finished and can be used by your business code. No more coding for accesser on table -is needed with this script as the file is completely generated once. +README (English) +-------------------------------- +This directory contains PHP script samples that can be used to start a development on Dolibarr. + + +modMyModule.class.php: +Is a sample of module descriptor you can use if you want to build a new module/plugin for +Dolibarr. + +skeleton_script.php: +Is a sample you can use as an example if you need to build a script to run on command line + +skeleton_page.php: +Is a sample you can use as an example if you need to build an HTML page to include in Dolibarr GUI. + +skeleton_class.class.php: +Is a sample you can use as an example if you need to build a class file to access a new table +required by a Dolibarr development. +However it is better to run the script build_class_from_table.php that accept a table name as a +parameter and will used table description in database and the skeleton_class.class.php file to +generate full code for your class file. +After running this script, the class to access your table (insert a record, update, delete and select) +is directly finished and can be used by your business code. No more coding for accesser on table +is needed with this script as the file is completely generated once.