You are here

INSTALL.txt in Disclaimer 6

Same filename and directory in other branches
  1. 6.2 INSTALL.txt
*******************************************************************************************
Warning
-------
In order to work, disclaimer need client has JAVASCRIPT ENABLED and ACCEPT COOKIE.

IMPORTANT NOTE FOR THOSE USING PATH.MODULE (URL ALIAS):

Please ensure you have no other pages setup with the URL ALIAS 'disclaimer' when 
installing the disclaimer.module which uses the 'disclaimer' URL Alias by default.

CAUTION ON AGE VERIFICATION:

If you set age form option to your disclaimer, delete cookie and see the modal from "admin/settings/disclaimer", age verification will not work, because of preview windows under modal and CheckAge() js function witch get id of elements.

*******************************************************************************************

Requirements
------------

This module require at least version 6.x of Drupal.
This module require 
Thickbox module (easy setup !) from
http://drupal.org/project/thickbox
- AND/OR -
NyroModal jquery plugin 1.6.1+ from
http://plugins.jquery.com/project/nyroModal
- AND/OR -
jqModal jquery plugin 2009.03.01 +r14+ from
http://plugins.jquery.com/project/jqModal
(up to date) http://dev.iceburg.net/jquery/jqModal/

Installation
------------

1. Copy the folder named 'disclaimer' and its contents to the modules directory
   of your Drupal installation (for example 'sites/all/modules/').

   -- you can choose Modal script you will set --

   -- if you choose thickbox --

1.1. Download and install 'thickbox' module to the modules directory
   of your Drupal installation (for example 'sites/all/modules/').
1.2. Go to 'admin/build/modules' and enable thickbox.
   
   -- if you choose nyroModal --

1.1. Download NyroModal archive (version 1.6.1+) at 
   http://plugins.jquery.com/project/nyroModal

1.2. Create nyroModal folder in disclaimer module
   sites/all/modules/disclaimer/nyroModal

1.3. Extract all NyroModal archive content in this folder.
   so directory look likes:
    disclaimer/nyroModal/js/
    disclaimer/nyroModal/img/
    disclaimer/nyroModal/styles/
    
    no need of php files given in NyroModal package.

1.4. Rename one of the NyroModal script (packed recommended) on "disclaimer/nyromodal/js/" 
   to "jquery.nyroModal.js"

1.5. Module will use nyroModal.css, rename -full version if you need. Edit to your need.

   -- if you choose jqModal --

1.1. Download jqModal script (version 2009.03.01 +r14+) at 
   http://plugins.jquery.com/project/jqModal
   (up to date) http://dev.iceburg.net/jquery/jqModal/
   Download jqModal css sample at
   http://dev.iceburg.net/jquery/jqModal/

1.2. Create jqModal folder in disclaimer module
   sites/all/modules/disclaimer/jqModal

1.3. Copy both js AND css files in this folder.
   so directory look likes:
    disclaimer/jqModal/jqModal.js
    disclaimer/jqModal/jqModal.css

  -- then --

2. In order to get disclaimer with customizes regions (no sidebar, etc...), you 
  can set-up a tpl file. The better way is to copy your page.tpl.php file from
  your theme directory, rename it page-disclaimer.tpl.php and edit to your need
  to delete sidebar zones. 
  There is a sample page-disclaimer.tpl.php file in disclaimer module made from
  GARLAND theme. It can produce error on other themes.

3. Go to 'admin/build/modules' and enable disclaimer.

4. Go to 'admin/settings/disclaimer' and edit option and content for the disclaimer
   to your need.

*******************************************************************************************

Post a message on the drupal.org site if you have any ideas on 
how we can improve the module.

Mog.
tech@arthura.fr

File

INSTALL.txt
View source
  1. *******************************************************************************************
  2. Warning
  3. -------
  4. In order to work, disclaimer need client has JAVASCRIPT ENABLED and ACCEPT COOKIE.
  5. IMPORTANT NOTE FOR THOSE USING PATH.MODULE (URL ALIAS):
  6. Please ensure you have no other pages setup with the URL ALIAS 'disclaimer' when
  7. installing the disclaimer.module which uses the 'disclaimer' URL Alias by default.
  8. CAUTION ON AGE VERIFICATION:
  9. If you set age form option to your disclaimer, delete cookie and see the modal from "admin/settings/disclaimer", age verification will not work, because of preview windows under modal and CheckAge() js function witch get id of elements.
  10. *******************************************************************************************
  11. Requirements
  12. ------------
  13. This module require at least version 6.x of Drupal.
  14. This module require
  15. Thickbox module (easy setup !) from
  16. http://drupal.org/project/thickbox
  17. - AND/OR -
  18. NyroModal jquery plugin 1.6.1+ from
  19. http://plugins.jquery.com/project/nyroModal
  20. - AND/OR -
  21. jqModal jquery plugin 2009.03.01 +r14+ from
  22. http://plugins.jquery.com/project/jqModal
  23. (up to date) http://dev.iceburg.net/jquery/jqModal/
  24. Installation
  25. ------------
  26. 1. Copy the folder named 'disclaimer' and its contents to the modules directory
  27. of your Drupal installation (for example 'sites/all/modules/').
  28. -- you can choose Modal script you will set --
  29. -- if you choose thickbox --
  30. 1.1. Download and install 'thickbox' module to the modules directory
  31. of your Drupal installation (for example 'sites/all/modules/').
  32. 1.2. Go to 'admin/build/modules' and enable thickbox.
  33. -- if you choose nyroModal --
  34. 1.1. Download NyroModal archive (version 1.6.1+) at
  35. http://plugins.jquery.com/project/nyroModal
  36. 1.2. Create nyroModal folder in disclaimer module
  37. sites/all/modules/disclaimer/nyroModal
  38. 1.3. Extract all NyroModal archive content in this folder.
  39. so directory look likes:
  40. disclaimer/nyroModal/js/
  41. disclaimer/nyroModal/img/
  42. disclaimer/nyroModal/styles/
  43. no need of php files given in NyroModal package.
  44. 1.4. Rename one of the NyroModal script (packed recommended) on "disclaimer/nyromodal/js/"
  45. to "jquery.nyroModal.js"
  46. 1.5. Module will use nyroModal.css, rename -full version if you need. Edit to your need.
  47. -- if you choose jqModal --
  48. 1.1. Download jqModal script (version 2009.03.01 +r14+) at
  49. http://plugins.jquery.com/project/jqModal
  50. (up to date) http://dev.iceburg.net/jquery/jqModal/
  51. Download jqModal css sample at
  52. http://dev.iceburg.net/jquery/jqModal/
  53. 1.2. Create jqModal folder in disclaimer module
  54. sites/all/modules/disclaimer/jqModal
  55. 1.3. Copy both js AND css files in this folder.
  56. so directory look likes:
  57. disclaimer/jqModal/jqModal.js
  58. disclaimer/jqModal/jqModal.css
  59. -- then --
  60. 2. In order to get disclaimer with customizes regions (no sidebar, etc...), you
  61. can set-up a tpl file. The better way is to copy your page.tpl.php file from
  62. your theme directory, rename it page-disclaimer.tpl.php and edit to your need
  63. to delete sidebar zones.
  64. There is a sample page-disclaimer.tpl.php file in disclaimer module made from
  65. GARLAND theme. It can produce error on other themes.
  66. 3. Go to 'admin/build/modules' and enable disclaimer.
  67. 4. Go to 'admin/settings/disclaimer' and edit option and content for the disclaimer
  68. to your need.
  69. *******************************************************************************************
  70. Post a message on the drupal.org site if you have any ideas on
  71. how we can improve the module.
  72. Mog.
  73. tech@arthura.fr