You are here

README.txt in Legal 5

Same filename and directory in other branches
  1. 6.8 README.txt
  2. 6.7 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
********************************************************************
D R U P A L    M O D U L E
********************************************************************
Name: Legal Module 
Author: Robert Castelo
Sponsor: Code Positive [www.codepositive.com]
Drupal: 5.0.x
********************************************************************
DESCRIPTION:

	A module which displays your Terms & Conditions to users who want to
    register, and makes sure they accept the T&C before their registration
    is accepted.
    
    Each time a new version of the T&C is created all users will be required to 
    accept the new version.

   Note: 
          * T&C text should only be entered by administrators or other highly trusted users.
             filter_xss_admin() is used to filter content for display, this is a very permissive 
             XSS/HTML filter intended for admin-only use.

          * No T&C will be displayed until the T&C text has been input by
             the administrator.

          * Legal module is incompatible with SecureSite module, the two should not be 
             used on the same site.


********************************************************************
INSTALLATION:

	Note: It is assumed that you have Drupal up and running.  Be sure to
    check the Drupal web site if you need assistance.  If you run into
    problems, you should always read the INSTALL.txt that comes with the
    Drupal package and read the online documentation.

	1. Place the entire legal directory into your Drupal
        modules/directory.

	2. Enable the legal module by navigating to:

	   Administer > Site building > Modules

	Click the 'Save configuration' button at the bottom to commit your
    changes.
    


********************************************************************
CONFIGURATION

	1. Go to Administer > User management > Access control
	    
	    Set which roles can "view Terms and Conditions"
	    Set which roles can "administer Terms and Conditions"
	
	2. Go to Administer > Site configuration > Legal

	   Input your terms & conditions text, set how you would like it
     displayed:

	- Scroll Box - Standard form text box (read only) Text is entered
    and displayed as text only

	- Scroll Box (CSS) - Scrollable text box created in CSS Text should
    be entered with HTML formatting. 
       (less accessible than a standard scroll box)

	- HTML Text - Terms & conditions displayed as HTML formatted text
       Text should be entered with HTML formatting

	Note: When displayed on the page /legal your T&Cs will be automatically 
                reformatted to HTML Text if entered as a Scroll Box or Scroll Box (CSS)


********************************************************************
KNOWN PROBLEMS

There is a conflict with the SecureSite module - do not use Legal and SecureSite on the same site.
       
       
       
********************************************************************
ACKNOWLEDGEMENTS

* Drupal 5 update sponsorship
Lullabot (http://www.lullabot.com)

* User data variables clean up
Steven Wittens (Steven)

* T&C Page formatting
Bryant Mairs (Susurrus) 




File

README.txt
View source
  1. ********************************************************************
  2. D R U P A L M O D U L E
  3. ********************************************************************
  4. Name: Legal Module
  5. Author: Robert Castelo
  6. Sponsor: Code Positive [www.codepositive.com]
  7. Drupal: 5.0.x
  8. ********************************************************************
  9. DESCRIPTION:
  10. A module which displays your Terms & Conditions to users who want to
  11. register, and makes sure they accept the T&C before their registration
  12. is accepted.
  13. Each time a new version of the T&C is created all users will be required to
  14. accept the new version.
  15. Note:
  16. * T&C text should only be entered by administrators or other highly trusted users.
  17. filter_xss_admin() is used to filter content for display, this is a very permissive
  18. XSS/HTML filter intended for admin-only use.
  19. * No T&C will be displayed until the T&C text has been input by
  20. the administrator.
  21. * Legal module is incompatible with SecureSite module, the two should not be
  22. used on the same site.
  23. ********************************************************************
  24. INSTALLATION:
  25. Note: It is assumed that you have Drupal up and running. Be sure to
  26. check the Drupal web site if you need assistance. If you run into
  27. problems, you should always read the INSTALL.txt that comes with the
  28. Drupal package and read the online documentation.
  29. 1. Place the entire legal directory into your Drupal
  30. modules/directory.
  31. 2. Enable the legal module by navigating to:
  32. Administer > Site building > Modules
  33. Click the 'Save configuration' button at the bottom to commit your
  34. changes.
  35. ********************************************************************
  36. CONFIGURATION
  37. 1. Go to Administer > User management > Access control
  38. Set which roles can "view Terms and Conditions"
  39. Set which roles can "administer Terms and Conditions"
  40. 2. Go to Administer > Site configuration > Legal
  41. Input your terms & conditions text, set how you would like it
  42. displayed:
  43. - Scroll Box - Standard form text box (read only) Text is entered
  44. and displayed as text only
  45. - Scroll Box (CSS) - Scrollable text box created in CSS Text should
  46. be entered with HTML formatting.
  47. (less accessible than a standard scroll box)
  48. - HTML Text - Terms & conditions displayed as HTML formatted text
  49. Text should be entered with HTML formatting
  50. Note: When displayed on the page /legal your T&Cs will be automatically
  51. reformatted to HTML Text if entered as a Scroll Box or Scroll Box (CSS)
  52. ********************************************************************
  53. KNOWN PROBLEMS
  54. There is a conflict with the SecureSite module - do not use Legal and SecureSite on the same site.
  55. ********************************************************************
  56. ACKNOWLEDGEMENTS
  57. * Drupal 5 update sponsorship
  58. Lullabot (http://www.lullabot.com)
  59. * User data variables clean up
  60. Steven Wittens (Steven)
  61. * T&C Page formatting
  62. Bryant Mairs (Susurrus)