You are here

README.txt in Forward 5


        FORWARD MODULE - README
______________________________________________________________________________

NAME:       Forward
AUTHORS:    Sean Robertson <seanr@ngpsoftware.com>
            Peter Feddo
______________________________________________________________________________


DESCRIPTION

Adds a "forward this page" link to each node and a "Send an e-Postcard" link to
the menu. The node link allows users to forward a link to a specific node on 
your site to a friend.  The menu item allows users to send a generic message 
about the site as a whole rather than a specific node; this is useful for an 
"Invite your Friends" feature.  You can customize the default form field values 
and even view a running count of the emails sent so far using the forward module.


INSTALLATION

Step 1) Download latest release from http://drupal.org/project/forward

Step 2)
  Extract the package into your 'modules' directory.


Step 3)
  Enable the forward module.

  Go to "administer >> build >> modules" and put a checkmark in the 'status' column next
  to 'forward'.


Step 4)
  Go to "administer >> site configuration >> forward" to configure the module.

  Edit 'forward.theme' to change the look and feel of your emails.  You can also
  create different themes for different phptemplate themes with by copying the
  contents of 'forward.theme' into your theme's 'template.php' file and
  prepending the function name with 'phptemplate_'.  There is one theme function
  for the "forward this page" email and another for the "Send an e-Postcard" email.
  Then you can customize the function as needed and those changes will only appear
  went sent by a user using that theme.  For more information, see the Drupal
  handbook:

  http://drupal.org/node/11811


Step 5)
  Enable permissions appropriate to your site.

  The forward module provides two permissions:
   - 'access forward': allow user to forward pages.
   - 'administer forward': allow user to configure forward.

  Note that you need to enable 'access forward' for users who should be able to
  send emails using the forward module.


Step 6)
  Go to "administer >> logs >> forward tracking" to view forward usage statistics.


CREDITS & SUPPORT

Special thanks to Jeff Miccolis of developmentseed.org for supplying the
tracking features and various other edits.  Thanks also to Nick White for his
EmailPage module, some code from which was used in this module, as well as the
numerous other users who have submitted issues and patches for forward.

All issues with this module should be reported via the following form:
http://drupal.org/node/add/project_issue/forward

______________________________________________________________________________
http://www.ngpsystems.com

File

README.txt
View source
  1. FORWARD MODULE - README
  2. ______________________________________________________________________________
  3. NAME: Forward
  4. AUTHORS: Sean Robertson
  5. Peter Feddo
  6. ______________________________________________________________________________
  7. DESCRIPTION
  8. Adds a "forward this page" link to each node and a "Send an e-Postcard" link to
  9. the menu. The node link allows users to forward a link to a specific node on
  10. your site to a friend. The menu item allows users to send a generic message
  11. about the site as a whole rather than a specific node; this is useful for an
  12. "Invite your Friends" feature. You can customize the default form field values
  13. and even view a running count of the emails sent so far using the forward module.
  14. INSTALLATION
  15. Step 1) Download latest release from http://drupal.org/project/forward
  16. Step 2)
  17. Extract the package into your 'modules' directory.
  18. Step 3)
  19. Enable the forward module.
  20. Go to "administer >> build >> modules" and put a checkmark in the 'status' column next
  21. to 'forward'.
  22. Step 4)
  23. Go to "administer >> site configuration >> forward" to configure the module.
  24. Edit 'forward.theme' to change the look and feel of your emails. You can also
  25. create different themes for different phptemplate themes with by copying the
  26. contents of 'forward.theme' into your theme's 'template.php' file and
  27. prepending the function name with 'phptemplate_'. There is one theme function
  28. for the "forward this page" email and another for the "Send an e-Postcard" email.
  29. Then you can customize the function as needed and those changes will only appear
  30. went sent by a user using that theme. For more information, see the Drupal
  31. handbook:
  32. http://drupal.org/node/11811
  33. Step 5)
  34. Enable permissions appropriate to your site.
  35. The forward module provides two permissions:
  36. - 'access forward': allow user to forward pages.
  37. - 'administer forward': allow user to configure forward.
  38. Note that you need to enable 'access forward' for users who should be able to
  39. send emails using the forward module.
  40. Step 6)
  41. Go to "administer >> logs >> forward tracking" to view forward usage statistics.
  42. CREDITS & SUPPORT
  43. Special thanks to Jeff Miccolis of developmentseed.org for supplying the
  44. tracking features and various other edits. Thanks also to Nick White for his
  45. EmailPage module, some code from which was used in this module, as well as the
  46. numerous other users who have submitted issues and patches for forward.
  47. All issues with this module should be reported via the following form:
  48. http://drupal.org/node/add/project_issue/forward
  49. ______________________________________________________________________________
  50. http://www.ngpsystems.com