remove themer bar image. not in use.
[project/devel.git] / README.txt
1 README.txt
2 ==========
3
4 A module containing helper functions for Drupal developers and
5 inquisitive admins. This module can print a log of
6 all database queries for each page request at the bottom of each page. The
7 summary includes how many times each query was executed on a page, and how long each query
8  took.
9  
10  It also
11  - a block for running custom PHP on a page
12  - a block for quickly accessing devel pages
13  - a block for masquerading as other users (useful for testing)
14  - reports memory usage at bottom of page
15  - more
16  
17  This module is safe to use on a production site. Just be sure to only grant
18  'access development information' permission to developers.
19
20 Also a dpr() function is provided, which pretty prints arrays and strings. Useful during
21 development. Many other nice functions like dpm(), dvm().
22
23 AJAX developers in particular ought to install FirePHP Core from http://www.firephp.org/ and put it in the devel directory. Your path to fb.php should looks like devel/FirePHPCore/lib/FirePHPCore/fb.php. You can use svn checkout http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore. Then you can log php variables to the firebug console. Is quite useful. 
24
25 Included in this package is also: 
26 - devel_themer.module which outputs deep information related to all theme calls on a page.
27 - devel_node_access module which prints out the node_access records for a given node. Also offers hook_node_access_explain for all node access modules to implement. Handy.
28 - devel_generate.module which bulk creates nodes, users, comment, terms for development
29
30 Macro module has moved to http://drupal.org/project/macro.
31
32 COMPATIBILITY NOTES
33 ==================
34 - Modules that use AHAH may have incompatibility with the query log and other footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE in order to avoid issues.
35 -  Modules that use AJAX should idenify their response as Content-type: text/javascript. The easiest way to do that is run your reply through drupal_json().
36
37
38 AUTHOR/MAINTAINER
39 ======================
40 -moshe weitzman
41 weitzman at tejasa DOT com