MDL-49462 tool_lp: added template competencies page
[moodle.git] / admin / tool / xmldb / README.txt
1 XMLDB - Base classes and edition interface.
3 Complete Documentation:
5   http://docs.moodle.org/en/XMLDB_Defining_one_XML_structure
7 Ciao, Eloy Lafuente (stronk7)
9 ========== ========== ========== ========== ==========
10 ========== ==========   HISTORY  ========== ==========
11 ========== ========== ========== ========== ==========
13 2006-08-07 - Editor working on production
15 The editor has been used succesfully to build
16 a bunch of install.xml files and everything
17 seems to be working properly.
19 ========== ========== ========== ========== ==========
21 2006-07-11 - PHP4 compatible release
23 Now everything seems to be working under PHP 4. What
24 a horrible OOP implementation!
26 Note that write permissions to */db dirs are required.
28 Now working in the 3 missing forms, to manually edit
29 fields, keys and indexes.
31 Ciao, Eloy Lafuente (stronk7)
33 ========== ========== ========== ========== ==========
35 2006-07-11 - Important notes
37 I've just discovered this some seconds ago, in order
38 to test properly the XMLDB classes and editor:
40 1.- PHP 5 required for now. Will change this soon.
41 2.- Perms to "apache" user needed in */db
42     dirs in order to allow the XMDBD interface
43     to write files.
45 Ciao, Eloy Lafuente (stronk7)
47 ========== ========== ========== ========== ==========
49 2006-07-11 - Initial commit
51 This directory contains the XMLDB classes to be used
52 under Moodle > 1.7 to store all the DB info in a
53 neutral form (classes dir). Also it contains one simple
54 interface to edit all those structures.
56 To install and test it, simply copy the whole xmldb directory
57 under your moodle/admin dir and point your browser (as admin)
58 to http://your.server/moodle/admin/xmldb
60 The edition interface isn't completed yet (it laks 3 more forms
61 to edit fields, keys and indexes) and there isn't any lang file
62 (although I hope everything is really clear).
64 The edition interface includes one reverse-engineering tool that
65 provides an easy way to retroffit and to generate any table from
66 MySQL to the new XMLDB format.
68 Once the XMLDB format was approved, we'll be able to build all the
69 "generators" needed in order to use it to create Moodle DB structures
70 for each RDBMS flavour.
72 Once the interface was finished (2-3 days from now) related documentation
73 will be sent to http://docs.moodle.org/en/XML_database_schema in order
74 to comment/modify/approve the final XML format.
76 All the code is, obviously GPL, with its copyrights and so on...
78 Ciao, Eloy Lafuente (stronk7) :-)