You are here

Home » API reference » Entity Legal 7.2

README.txt in Entity Legal 7.2

Same filename and directory in other branches
  1. 7 README.txt
CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Getting started
 * Difference from legal
 * Requirements
 * Recommended modules

INTRODUCTION
------------
The Entity Legal module provides a solid, versionable, exportable and flexible
method of storing legal documents such as Terms and Conditions and Privacy
Policies. Users can be forced or soft-suggested to re-read and re-accept legal
documents when they change and a full audit trail of which user has accepted
when is available.

GETTING STARTED
---------------
 1. Enable the module.
 2. Visit admin/structure/legal
 3. Click 'Add'
 4. Fill in the document form and click Next.
 5. Create in the version form and click save.

CREATING A NEW VERSION AND FORCING USERS TO ACCEPT
--------------------------------------------------
 1. Visit the edit page for the document you've already created.
 2. Click the 'Add new version' action link at the top of the page.
 3. Fill in the form and click save.
 4. On the document form, select the radio next to the new version you've
    created in the 'Current version' section and click save.
 5. Users who have not accepted the new version will be forced to re-accept
    based on the settings you've chosen in the 'Existing users' fieldgroup.
 6. Only users who have not agreed to the current version will be prompted to
    re-accept. Reverting to a previous version will mean the users who have
    accepted that version before will not have to re-accept.
 7. All acceptances for all version are stored for each user, creating a new
    version is safe and will not cause you to lose any previous acceptances.

DIFFERENCE FROM LEGAL
---------------------
There are a few key difference from the Legal module:

 1. Support for more than one type of document on the site (eg Terms of Use as
    well as Privacy Policy and Terms and Conditions)..
 2. Entity API based and fully exportable using Features.
 3. Each document has custom settings as to whether users accept during sign-up
    and need to re-accept when a new version is created. Alternatively documents
    can live as static pages with no user interaction required.
 4. Provides an audit trail of which user accepted which version and what time.
 5. Comes loaded with different methods of notifying users of a document update
    including popup, drupal status message and full page redirection.
 6. Comes complete with a very high level of automated test coverage for each
    acceptance method and Entity type.
 7. Extensible, site administrators can create their own delivery methods using
    the modules API and because the entire module is written using Entity there
    are also many hooks provided by the Entity API that are provided.

REQUIREMENTS
------------
This module requires the following modules:
 * Entity API (https://www.drupal.org/project/entity)

RECOMMENDED MODULES
-------------------
This module requires the following modules:
 * Simpletest (simpletest):
   Core simpletest module for running module tests and extending to create your
   own tests when creating new methods.

MAINTAINERS
-----------
Current maintainers:
 * Marton Bodonyi (interactivejunky) - https://www.drupal.org/user/1633774

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Getting started

  5.  * Difference from legal

  6.  * Requirements

  7.  * Recommended modules

  8. 

  9. INTRODUCTION

  10. ------------

  11. The Entity Legal module provides a solid, versionable, exportable and flexible

  12. method of storing legal documents such as Terms and Conditions and Privacy

  13. Policies. Users can be forced or soft-suggested to re-read and re-accept legal

  14. documents when they change and a full audit trail of which user has accepted

  15. when is available.

  16. 

  17. GETTING STARTED

  18. ---------------

  19.  1. Enable the module.

  20.  2. Visit admin/structure/legal

  21.  3. Click 'Add'

  22.  4. Fill in the document form and click Next.

  23.  5. Create in the version form and click save.

  24. 

  25. CREATING A NEW VERSION AND FORCING USERS TO ACCEPT

  26. --------------------------------------------------

  27.  1. Visit the edit page for the document you've already created.

  28.  2. Click the 'Add new version' action link at the top of the page.

  29.  3. Fill in the form and click save.

  30.  4. On the document form, select the radio next to the new version you've

  31.     created in the 'Current version' section and click save.

  32.  5. Users who have not accepted the new version will be forced to re-accept

  33.     based on the settings you've chosen in the 'Existing users' fieldgroup.

  34.  6. Only users who have not agreed to the current version will be prompted to

  35.     re-accept. Reverting to a previous version will mean the users who have

  36.     accepted that version before will not have to re-accept.

  37.  7. All acceptances for all version are stored for each user, creating a new

  38.     version is safe and will not cause you to lose any previous acceptances.

  39. 

  40. DIFFERENCE FROM LEGAL

  41. ---------------------

  42. There are a few key difference from the Legal module:

  43. 

  44.  1. Support for more than one type of document on the site (eg Terms of Use as

  45.     well as Privacy Policy and Terms and Conditions)..

  46.  2. Entity API based and fully exportable using Features.

  47.  3. Each document has custom settings as to whether users accept during sign-up

  48.     and need to re-accept when a new version is created. Alternatively documents

  49.     can live as static pages with no user interaction required.

  50.  4. Provides an audit trail of which user accepted which version and what time.

  51.  5. Comes loaded with different methods of notifying users of a document update

  52.     including popup, drupal status message and full page redirection.

  53.  6. Comes complete with a very high level of automated test coverage for each

  54.     acceptance method and Entity type.

  55.  7. Extensible, site administrators can create their own delivery methods using

  56.     the modules API and because the entire module is written using Entity there

  57.     are also many hooks provided by the Entity API that are provided.

  58. 

  59. REQUIREMENTS

  60. ------------

  61. This module requires the following modules:

  62.  * Entity API (https://www.drupal.org/project/entity)

  63. 

  64. RECOMMENDED MODULES

  65. -------------------

  66. This module requires the following modules:

  67.  * Simpletest (simpletest):

  68.    Core simpletest module for running module tests and extending to create your

  69.    own tests when creating new methods.

  70. 

  71. MAINTAINERS

  72. -----------

  73. Current maintainers:

  74.  * Marton Bodonyi (interactivejunky) - https://www.drupal.org/user/1633774