scripts/coder_format/README.txt

/* $Id: README.txt,v 1.1.2.1 2008/01/16 13:54:31 sun Exp $ */

-- SUMMARY --

This is a standalone script developed by sun (http://drupal.org/user/54136) that
only concentrates on re-formatting code and style review.

Coder Format alters source code files directly. Although this script is
state-of-the-art, be sure to backup your source files in front of executing this
script. If executed on a directory, the script automatically creates backup
copies of all changed files.

This is an alternative approach to the Coder module. Having two different
modules with different approaches is in some ways an advantage, since each
becomes - in effect - a unit test upon the other. This is a great way for them
to both improve, and maintain accuracy in what is a very detail oriented area!

See http://drupal.org/node/126938.


-- REQUIREMENTS --

* PHP command line interpreter.
* Path to includes/file.inc of a Drupal core codebase.


-- USAGE --

See coder_format.php.


-- INSTALLATION (WINDOWS) --

Coder Format provides a Windows Explorer context menu extension that allows you
to run Coder Format on single PHP files or complete directory trees.

WARNING: Do not proceed unless you know what you are doing!

- Copy all files of this directory to a central location. If you like to,
  c:\program files\coder_format\ is okay, too.

- Open coder_format.reg in your preferred editor and replace all instances of

  c:\\program files\\coder_format

  with the path of your chosen central location. Be sure to escape backslashes
  with another backslash (as shown above).

- "Merge" coder_format.reg into your Windows Registry using the "Merge" command
  in the context menu.

- Open coder_format.cmd in your preferred editor and replace the path in
  
  set coderFormatPath=c:\program files\coder_format

  with the path of your chosen central location. Afterwards, adjust the location
  of file.inc in

  set fileInc=c:\program files\coder_format\file.inc

  according to your local Drupal installation, i.e.

  set fileInc=c:\inetpub\www\path\to\drupal\includes\file.inc

  It is also possible to copy file.inc from a Drupal 5 installation to the
  central location and adjust the path accordingly.

- Done. Context menus of PHP files and directories should include the following
  commands now:

  - Clean Coding Style...
  - Unclean Coding Style... (directories only)


-- CONTACT --

Current maintainers:
* Daniel F. Kudwien (sun) - dev@unleashedmind.com

This project has been sponsored by:
* UNLEASHED MIND
  Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  MIND offers installation, development, theming, customization, and hosting
  to get you started. Visit http://www.unleashedmind.com for more information.

1	/* $Id: README.txt,v 1.1.2.1 2008/01/16 13:54:31 sun Exp $ */
2
3	-- SUMMARY --
4
5	This is a standalone script developed by sun (http://drupal.org/user/54136) that
6	only concentrates on re-formatting code and style review.
7
8	Coder Format alters source code files directly. Although this script is
9	state-of-the-art, be sure to backup your source files in front of executing this
10	script. If executed on a directory, the script automatically creates backup
11	copies of all changed files.
12
13	This is an alternative approach to the Coder module. Having two different
14	modules with different approaches is in some ways an advantage, since each
15	becomes - in effect - a unit test upon the other. This is a great way for them
16	to both improve, and maintain accuracy in what is a very detail oriented area!
17
18	See http://drupal.org/node/126938.
19
20
21	-- REQUIREMENTS --
22
23	* PHP command line interpreter.
24	* Path to includes/file.inc of a Drupal core codebase.
25
26
27	-- USAGE --
28
29	See coder_format.php.
30
31
32	-- INSTALLATION (WINDOWS) --
33
34	Coder Format provides a Windows Explorer context menu extension that allows you
35	to run Coder Format on single PHP files or complete directory trees.
36
37	WARNING: Do not proceed unless you know what you are doing!
38
39	- Copy all files of this directory to a central location. If you like to,
40	c:\program files\coder_format\ is okay, too.
41
42	- Open coder_format.reg in your preferred editor and replace all instances of
43
44	c:\\program files\\coder_format
45
46	with the path of your chosen central location. Be sure to escape backslashes
47	with another backslash (as shown above).
48
49	- "Merge" coder_format.reg into your Windows Registry using the "Merge" command
50	in the context menu.
51
52	- Open coder_format.cmd in your preferred editor and replace the path in
53
54	set coderFormatPath=c:\program files\coder_format
55
56	with the path of your chosen central location. Afterwards, adjust the location
57	of file.inc in
58
59	set fileInc=c:\program files\coder_format\file.inc
60
61	according to your local Drupal installation, i.e.
62
63	set fileInc=c:\inetpub\www\path\to\drupal\includes\file.inc
64
65	It is also possible to copy file.inc from a Drupal 5 installation to the
66	central location and adjust the path accordingly.
67
68	- Done. Context menus of PHP files and directories should include the following
69	commands now:
70
71	- Clean Coding Style...
72	- Unclean Coding Style... (directories only)
73
74
75	-- CONTACT --
76
77	Current maintainers:
78	* Daniel F. Kudwien (sun) - dev@unleashedmind.com
79
80	This project has been sponsored by:
81	* UNLEASHED MIND
82	Specialized in consulting and planning of Drupal powered sites, UNLEASHED
83	MIND offers installation, development, theming, customization, and hosting
84	to get you started. Visit http://www.unleashedmind.com for more information.
85