| 1 | Drupal |
|---|
| 2 | ====== |
|---|
| 3 | |
|---|
| 4 | Prerequisites |
|---|
| 5 | ============= |
|---|
| 6 | |
|---|
| 7 | PHP5 |
|---|
| 8 | See: Installing Libraries (below) |
|---|
| 9 | |
|---|
| 10 | Installing Drupal |
|---|
| 11 | ================= |
|---|
| 12 | |
|---|
| 13 | http://drupal.org/drupal-5.7 (tested on 5.7 at the time of this writing) |
|---|
| 14 | http://drupal.org/getting-started/5/install |
|---|
| 15 | |
|---|
| 16 | Installing Libraries |
|---|
| 17 | ==================== |
|---|
| 18 | |
|---|
| 19 | Read the EXTERNALS file in jsdoc/lib |
|---|
| 20 | |
|---|
| 21 | Installing the Module |
|---|
| 22 | ===================== |
|---|
| 23 | |
|---|
| 24 | http://drupal.org/node/70151 |
|---|
| 25 | Drop the jsdoc folder into sites/all/modules |
|---|
| 26 | |
|---|
| 27 | Enable the Module |
|---|
| 28 | ================= |
|---|
| 29 | |
|---|
| 30 | Enable in: Administer->Site building->Modules |
|---|
| 31 | |
|---|
| 32 | Configure |
|---|
| 33 | ========= |
|---|
| 34 | |
|---|
| 35 | * Make sure that PHP has write persmissions to the util/jsdoc/cache directory |
|---|
| 36 | * Fill in the configuration in: Administer->Site configuration->JavaScript Documentation |
|---|
| 37 | ** Under "Directory to run your file from", |
|---|
| 38 | enter the FULL PATH to util/docscripts (eg /var/www/dojotoolkit/util/docscripts) |
|---|
| 39 | ** Under "Location of file used to parse your code", |
|---|
| 40 | enter the FULL PATH to util/docscripts/includes/dojo.inc |
|---|
| 41 | (eg /var/www/dojotoolkit/util/docscripts/includes/dojo.inc) |
|---|
| 42 | ** Under "This will be used as a base of our functions", enter "dojo" |
|---|
| 43 | * If you want to add a new namespace, see the plugins in util/docscripts/modules |
|---|
| 44 | (dojox.module is probably the easiest to copy). |
|---|
| 45 | Function names should begin with the file name prefix of the module file |
|---|
| 46 | eg dojo.module's functions start with "dojo". |
|---|
| 47 | * Remove (or change the file type) of these modules to exclude them from |
|---|
| 48 | processing. |
|---|
| 49 | |
|---|
| 50 | Run Cron |
|---|
| 51 | ======== |
|---|
| 52 | |
|---|
| 53 | In the base of your Drupal folder, you'll see cron.php. This has a 30s processing limit, |
|---|
| 54 | so you'll need to run it until your DB is fully populated. Run either in your browser |
|---|
| 55 | or with cron and a wget/curl command. |
|---|
