tricks/docbook2helphook/README.txt

$Id: README.txt,v 1.3 2005/10/15 02:31:47 webchick Exp $

This script converts the Drupal handbook module pages (found at: 
http://www.drupal.org/handbook/modules/) into admin help text for 
displaying inside the modules' hook_help functions.

** MAKE BACKUPS OF YOUR MODULES BEFORE RUNNING THIS SCRIPT!! **

To use:

1. Place this script in a writable directory (chmod 777 directoryname)
2. Right-click the "export DocBook XML" link on the handbook page and save as
   "modules.xml" in the same directory.
3. Execute the script in your web browser.
4. The file adminhelp.txt will be created, which will contain the help text
5. **NEW** Script will go through all of your modules and attempt to patch them.
   It is not always correct about this. That's why you MADE SURE YOU BACKED UP
   YOUR MODULE FILES, RIGHT? ;) Take the help text from adminhelp.txt to patch
   unwieldly files.
   
(optional) By default, this script patches all core modules. If you want to 
instead generate help for a specific module or modules, comment out the line:

     $modules = get_module_list($path);

and uncomment the line:

     $modules = array('modulename', 'modulename2');

Replace 'modulename' and 'modulename2' with your module name(s). Example:

     $modules = array('audio', 'video');

Make sure the module file is in the root modules directory. At some point I will
probably make the algorithm to find modules recursive.

WISHLIST
--------
- Get modules.xml automatically
- Search through all of modules directory to find files to patch (optional)
- Make this script into a Drupal module which lets you specify the name of a 
  module and will automatically generate its help text to the screen.
- Instead of returning help text that has to be placed in help_hook functions 
  via a manual copy and paste process, auto-generate a patch against the module
  itself.
- Even cooler: Upon module handbook page update, auto-generate help_hook patch 
  issue in the project system. WOAH! :O
1	$Id: README.txt,v 1.3 2005/10/15 02:31:47 webchick Exp $
2
3	This script converts the Drupal handbook module pages (found at:
4	http://www.drupal.org/handbook/modules/) into admin help text for
5	displaying inside the modules' hook_help functions.
6
7	MAKE BACKUPS OF YOUR MODULES BEFORE RUNNING THIS SCRIPT!!
8
9	To use:
10
11	1. Place this script in a writable directory (chmod 777 directoryname)
12	2. Right-click the "export DocBook XML" link on the handbook page and save as
13	"modules.xml" in the same directory.
14	3. Execute the script in your web browser.
15	4. The file adminhelp.txt will be created, which will contain the help text
16	5. NEW Script will go through all of your modules and attempt to patch them.
17	It is not always correct about this. That's why you MADE SURE YOU BACKED UP
18	YOUR MODULE FILES, RIGHT? ;) Take the help text from adminhelp.txt to patch
19	unwieldly files.
20
21	(optional) By default, this script patches all core modules. If you want to
22	instead generate help for a specific module or modules, comment out the line:
23
24	$modules = get_module_list($path);
25
26	and uncomment the line:
27
28	$modules = array('modulename', 'modulename2');
29
30	Replace 'modulename' and 'modulename2' with your module name(s). Example:
31
32	$modules = array('audio', 'video');
33
34	Make sure the module file is in the root modules directory. At some point I will
35	probably make the algorithm to find modules recursive.
36
37	WISHLIST
38	--------
39	- Get modules.xml automatically
40	- Search through all of modules directory to find files to patch (optional)
41	- Make this script into a Drupal module which lets you specify the name of a
42	module and will automatically generate its help text to the screen.
43	- Instead of returning help text that has to be placed in help_hook functions
44	via a manual copy and paste process, auto-generate a patch against the module
45	itself.
46	- Even cooler: Upon module handbook page update, auto-generate help_hook patch
47	issue in the project system. WOAH! :O