Contents of /contributions/sandbox/jamesandres/shrinksafe/INSTALL

# $Id: INSTALL,v 1.0 2007/11/01 14:32:06 jamesandres Exp $

1. Install the Java JRE on your machine and ensure it is accessible to PHP. Do
   not continue until you've completed this step!  You should be able to run
   
   java -version
   
   from the command line with a response stating that your Java version is at
   least 1.4 or higher.
   
3. Uncompress the shrinksafe module into the modules directory of your site.

2. Download the shrinksafe 'jar' package from the DoJo Toolkit website.  At
   the time of writing the URL was: http://dojotoolkit.org/docs/shrinksafe and
   http://svn.dojotoolkit.org/dojo/trunk/buildscripts/lib/custom_rhino.jar.
   
   Copy the file custom_rhino.jar to the subdirectory 'shrinksafe' inside your
   shrinksafe module.
   
3. Now, enable the shrinksafe module from the Drupal administrative section
   of you're site.
   
4. Configure and enable shrinksafe by navigating to the path
   'admin/settings/shrinksafe'.  Ensure both the java path and shrinksafe
   path's are correct.  The boxes should be green.
   
   When both boxes are green, with status OK, enable Shrinksafe.
   
5. Lastly, the most important step is to actually USE shrinksafe in your theme.
   Unfortunately this couldn't be done in a simpler manner on Drupal 5.x sites.
   
   5.1 First, navigate to the directory of the theme your site is running.
       For example, if you're running the Garland theme this directory would
       be themes/garland
       
   5.2 Edit the page.tpl.php file and search for either '<?php print $scripts ?>'
       or the command 'drupal_get_js', depending on the theme.
       
   5.3 In either case, we'll need to replace the line with a call to the
       custom drupal_get_js_shrinksafe function.
       
       eg: <?php print $scripts ?>
           ... should be replaced with ...
           <?php print drupal_get_js_shrinksafe() ?>

       eg: <?php print drupal_get_js() ?>
           ... should be replaced with ...
           <?php print drupal_get_js_shrinksafe() ?>

Hopefully that all made sense.

James Andres
1	# $Id: INSTALL,v 1.0 2007/11/01 14:32:06 jamesandres Exp $
2
3	1. Install the Java JRE on your machine and ensure it is accessible to PHP. Do
4	not continue until you've completed this step! You should be able to run
5
6	java -version
7
8	from the command line with a response stating that your Java version is at
9	least 1.4 or higher.
10
11	3. Uncompress the shrinksafe module into the modules directory of your site.
12
13	2. Download the shrinksafe 'jar' package from the DoJo Toolkit website. At
14	the time of writing the URL was: http://dojotoolkit.org/docs/shrinksafe and
15	http://svn.dojotoolkit.org/dojo/trunk/buildscripts/lib/custom_rhino.jar.
16
17	Copy the file custom_rhino.jar to the subdirectory 'shrinksafe' inside your
18	shrinksafe module.
19
20	3. Now, enable the shrinksafe module from the Drupal administrative section
21	of you're site.
22
23	4. Configure and enable shrinksafe by navigating to the path
24	'admin/settings/shrinksafe'. Ensure both the java path and shrinksafe
25	path's are correct. The boxes should be green.
26
27	When both boxes are green, with status OK, enable Shrinksafe.
28
29	5. Lastly, the most important step is to actually USE shrinksafe in your theme.
30	Unfortunately this couldn't be done in a simpler manner on Drupal 5.x sites.
31
32	5.1 First, navigate to the directory of the theme your site is running.
33	For example, if you're running the Garland theme this directory would
34	be themes/garland
35
36	5.2 Edit the page.tpl.php file and search for either '<?php print $scripts ?>'
37	or the command 'drupal_get_js', depending on the theme.
38
39	5.3 In either case, we'll need to replace the line with a call to the
40	custom drupal_get_js_shrinksafe function.
41
42	eg: <?php print $scripts ?>
43	... should be replaced with ...
44	<?php print drupal_get_js_shrinksafe() ?>
45
46	eg: <?php print drupal_get_js() ?>
47	... should be replaced with ...
48	<?php print drupal_get_js_shrinksafe() ?>
49
50	Hopefully that all made sense.
51
52	James Andres