diff --git a/manual/docbook/README b/manual/docbook/README index ffeed991b..07fe184cc 100644 --- a/manual/docbook/README +++ b/manual/docbook/README @@ -16,3 +16,13 @@ For documentation about docbook XSL, visit: http://www.sagehill.net/docbookxsl/index.html For information about docbook itself, google - there's LOTS of sites. +This is a good reference: +http://xml.web.cern.ch/XML/goossens/dbatcern/index.html + +Xsieve is used for syntax highlighting: + +http://xsieve.sourceforge.net/ + +Downloaded from CVS, it has 'experiments/programlisting' directory +containing stuff for the highlighting - check the makefile +to see how it works. diff --git a/manual/docbook/doctrine.xml b/manual/docbook/doctrine.xml index 3348588ba..7012a86d1 100644 --- a/manual/docbook/doctrine.xml +++ b/manual/docbook/doctrine.xml @@ -103,14 +103,6 @@ - - Getting Started - - The installation of doctrine is very easy. Just get the latest revision of Doctrine from - http://doctrine.pengus.net/svn/trunk. - - - Contributing @@ -123,6 +115,97 @@ email the users mailing list. + + + Installation + + As of the time of writing, there is no stable release of doctrine. That is not to say + that it's unstable, but simply that the best way to install it is to aquire it from + SVN. + + + To get the latest copy, simple check out 'trunk' from SVN. You will need subversion + install to check out doctrine. If you are unable to install subversion for whatever + reason, see below for details on downloading a snapshot. + + + bash $svn checkout http://doctrine.pengus.net/svn/trunk + + + Daily snapshots can be found at + http://doctrine.pengus.net/downloads/ + and the latest daily snapshot can always be found at + http://doctrine.pengus.net/downloads/latest-snapshot.tar.gz + + + + + Include and autoload + + In order to use Doctrine in your project it must first be included. + + + ]]> + + + + Doctrine support Autoloading for including + files so that you do not have to include anything more then the base + file. There are two different strategies that can be used to do this: + + + + If you do use the __autoload function for your own + logic you can use it. + + + ]]> + + + + If your project uses autoload and/or you have other libraries that use + it you could use spl_autoload_register + to register more then one autoloading function. + + + + ]]> + + + + + Compiling + + Compiling is a method for making a single file of most used doctrine + runtime components including the compiled file instead of multiple files + (in worst cases dozens of files) can improve performance by an order of + magnitude. In cases where this might fail, a Doctrine_Exception is throw + detailing the error. + + + ]]> + + + @@ -172,34 +255,33 @@ getTable('User')->findAll(); - foreach($users as $user) { - print $user->name."\n"; - foreach($user->Phonenumber as $phonenumber) { - print $phonenumber."\n"; - } - } - - // same thing implemented much more efficiently: - // (using only one sql query for object population) - - $users = $conn->query("FROM User.Phonenumber"); - foreach($users as $user) { - print $user->name."\n"; - foreach($user->Phonenumber as $phonenumber) { - print $phonenumber."\n"; - } - } + + $users = $conn->getTable('User')->findAll(); + foreach($users as $user) { + print $user->name."\n"; + foreach($user->Phonenumber as $phonenumber) { + print $phonenumber."\n"; + } + } + + // same thing implemented much more efficiently: + // (using only one sql query for object population) + + $users = $conn->query("FROM User.Phonenumber"); + foreach($users as $user) { + print $user->name."\n"; + foreach($user->Phonenumber as $phonenumber) { + print $phonenumber."\n"; + } + } +?> ]]> - +