modules/devel/README.txt

README.txt
==========

A module containing helper functions for Drupal developers and
inquisitive admins. This module can print a log of
all database queries for each page request at the bottom of each page. The
summary includes how many times each query was executed on a page, and how long
each query took.
 
 It also
 - a block for running custom PHP on a page
 - a block for quickly accessing devel pages
 - a block for masquerading as other users (useful for testing)
 - reports memory usage at bottom of page
 - more
 
 This module is safe to use on a production site. Just be sure to only grant
 'access development information' permission to developers.

Also a dpr() function is provided, which pretty prints arrays and strings.
Useful during development. Many other nice functions like dpm(), dvm().

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.

Included in this package is also: 
- devel_themer.module which outputs deep information related to all theme calls
  on a page.
- 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.
- devel_generate.module which bulk creates nodes, users, comment, terms for 
  development.

Macro module has moved to http://drupal.org/project/macro.

COMPATIBILITY NOTES
==================
- 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.
- 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().

AUTHOR/MAINTAINER
======================
-moshe weitzman
weitzman at tejasa DOT com
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
8	each query 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.
21	Useful during development. Many other nice functions like dpm(), dvm().
22
23	AJAX developers in particular ought to install FirePHP Core from
24	http://www.firephp.org/ and put it in the devel directory. Your path to fb.php
25	should looks like devel/FirePHPCore/lib/FirePHPCore/fb.php. You can use svn
26	checkout http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore.
27	Then you can log php variables to the Firebug console. Is quite useful.
28
29	Included in this package is also:
30	- devel_themer.module which outputs deep information related to all theme calls
31	on a page.
32	- devel_node_access module which prints out the node_access records for a given
33	node. Also offers hook_node_access_explain for all node access modules to
34	implement. Handy.
35	- devel_generate.module which bulk creates nodes, users, comment, terms for
36	development.
37
38	Macro module has moved to http://drupal.org/project/macro.
39
40	COMPATIBILITY NOTES
41	==================
42	- Modules that use AHAH may have incompatibility with the query log and other
43	footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE in order to
44	avoid issues.
45	- Modules that use AJAX should idenify their response as:
46	Content-type: text/javascript
47	The easiest way to do that is run your reply through drupal_json().
48
49	AUTHOR/MAINTAINER
50	======================
51	-moshe weitzman
52	weitzman at tejasa DOT com