| 1 |
/* $Id: README.txt,v 1.6 2008/04/19 16:48:40 sun Exp $ */
|
| 2 |
|
| 3 |
-- SUMMARY --
|
| 4 |
|
| 5 |
Journal module adds additional fields to all forms in a Drupal site to allow
|
| 6 |
developers and site administrators to record and track all actions that have
|
| 7 |
been performed to setup a site or change its configuration.
|
| 8 |
|
| 9 |
Journal is primarily useful for developers and site administrators working in a
|
| 10 |
team environment. Since Drupal is a full-fledged content management framework,
|
| 11 |
it is often not easy to communicate, track and audit all changes that have been
|
| 12 |
applied to a site. Even without contributed modules one is able to build a
|
| 13 |
totally customized site.
|
| 14 |
|
| 15 |
For a full description visit the project page:
|
| 16 |
http://drupal.org/project/journal
|
| 17 |
Bug reports, feature suggestions and latest developments:
|
| 18 |
http://drupal.org/project/issues/journal
|
| 19 |
|
| 20 |
|
| 21 |
-- INSTALLATION --
|
| 22 |
|
| 23 |
* Copy journal module to your modules directory and enable it on the modules
|
| 24 |
page.
|
| 25 |
|
| 26 |
* Go to Administer -> User management -> Permissions to allow users of certain
|
| 27 |
roles to access the journal (which includes adding new journal entries) by
|
| 28 |
enabling 'access journal' and 'access site reports' permissions.
|
| 29 |
|
| 30 |
* Optionally enable the Journal block at Administer -> Build -> Blocks. This
|
| 31 |
block displays all entries which have been made in the past for the url
|
| 32 |
currently visited.
|
| 33 |
|
| 34 |
|
| 35 |
-- USAGE --
|
| 36 |
|
| 37 |
* On any form, you or your co-workers/team are submitting to alter site
|
| 38 |
settings and features, enter a meaningful description of your action into the
|
| 39 |
journal entry form field.
|
| 40 |
|
| 41 |
* To view all changes, go to
|
| 42 |
Administer -> Reports -> Journal entries
|
| 43 |
|
| 44 |
|
| 45 |
-- CUSTOMIZATION --
|
| 46 |
|
| 47 |
* Until Form controller integration (http://drupal.org/node/228244) or a similar
|
| 48 |
solution is implemented, you can override the variable 'journal_form_ids' in
|
| 49 |
your site's settings.php to hide or require the journal entry field on
|
| 50 |
specified forms. To do this, you need to identify the $form_id of the target
|
| 51 |
form and add it along with the default values defined in the function
|
| 52 |
journal_form_ids_default() of this module to your settings.php. For example:
|
| 53 |
<code>
|
| 54 |
$conf = array(
|
| 55 |
...
|
| 56 |
'journal_form_ids' => array(
|
| 57 |
'devel_admin_settings' => 0,
|
| 58 |
'devel_execute_form' => 0,
|
| 59 |
'devel_switch_user_form' => 0,
|
| 60 |
'search_block_form' => 0,
|
| 61 |
'search_theme_form' => 0,
|
| 62 |
...
|
| 63 |
// Examples of custom form ids starting from here:
|
| 64 |
'fivestar_custom_widget' => 0,
|
| 65 |
'guestbook_form_entry_form' => 0,
|
| 66 |
'imagefield_js' => 0,
|
| 67 |
'img_assist_header_form' => 0,
|
| 68 |
'img_assist_properties_form' => 0,
|
| 69 |
'link_widget_js' => 0,
|
| 70 |
),
|
| 71 |
...
|
| 72 |
);
|
| 73 |
</code>
|
| 74 |
A value of 0 means that Journal will not show up in the given form; a value of
|
| 75 |
1 indicates that a journal entry is required. Please note that above example
|
| 76 |
does not contain all default values.
|
| 77 |
|
| 78 |
|
| 79 |
-- CONTACT --
|
| 80 |
|
| 81 |
Current maintainers:
|
| 82 |
* Daniel F. Kudwien (sun) - dev@unleashedmind.com
|
| 83 |
* Stefan M. Kudwien (smk-ka) - dev@unleashedmind.com
|
| 84 |
|
| 85 |
This project has been sponsored by:
|
| 86 |
* UNLEASHED MIND
|
| 87 |
Specialized in consulting and planning of Drupal powered sites, UNLEASHED
|
| 88 |
MIND offers installation, development, theming, customization, and hosting
|
| 89 |
to get you started. Visit http://www.unleashedmind.com for more information.
|
| 90 |
|
Parent Directory
| 
Revision Log
| 
Revision Graph