README.txt 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  2. ;; Field Permissions module
  3. ;;
  4. ;; Original author: markus_petrux (http://drupal.org/user/39593)
  5. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  6. CONTENTS OF THIS FILE
  7. =====================
  8. * OVERVIEW
  9. * USAGE
  10. * REQUIREMENTS
  11. * INSTALLATION
  12. OVERVIEW
  13. ========
  14. The Field Permissions module allows site administrators to set field-level
  15. permissions for fields that are attached to any kind of entity (such as nodes
  16. or users).
  17. Permissions can be set for editing or viewing the field (either in all
  18. contexts, or only when it is attached to an entity owned by the current user).
  19. Permissions can also be set for editing the field while creating a new entity.
  20. Permissions for each field are not created by default. Instead, administrators
  21. can enable these permissions explicitly for the fields where this feature is
  22. needed.
  23. USAGE
  24. =====
  25. Once Field Permissions module is installed, you need to edit the field settings
  26. form to enable permissions for each field where you need this feature. You can
  27. choose from three options:
  28. * Public (author and administrators can edit, everyone can view)
  29. * Private (only author and administrators can edit and view)
  30. * Custom permissions
  31. The default value ("Public") does not impose any field-level access control,
  32. meaning that permissions are inherited from the entity view or edit
  33. permissions. For example, users who are allowed to view a particular node that
  34. the field is attached to will also be able to view the field.
  35. "Private" provides quick and easy access to a commonly used form of field
  36. access control.
  37. Finally, if "Custom permissions" is chosen, a standard permissions matrix will
  38. be revealed allowing you full flexibility to assign the following permissions
  39. to any role on your site:
  40. * Create own value for field FIELD
  41. * Edit own value for field FIELD
  42. * Edit anyone's value for field FIELD
  43. * View own value for field FIELD
  44. * View anyone's value for field FIELD
  45. These permissions will also be available on the standard permissions page at
  46. Administer -> People -> Permissions.
  47. INSTALLATION
  48. ============
  49. 1) Copy all contents of this package to your modules directory preserving
  50. subdirectory structure.
  51. 2) Go to Administer -> Modules to install module. If the (Drupal core) Field UI
  52. module is not enabled, do so.
  53. 3) Review the settings of your fields. You will find a new option labelled
  54. "Field visibility and permissions" that allows you to control access to the
  55. field.
  56. 4) If you chose the setting labelled "Custom permissions", you will be able to
  57. set this field's permissions for any role on your site directly from the
  58. field edit form, or later on by going to the Administer -> People ->
  59. Permissions page.
  60. 5) Get an overview of the Field Permissions at:
  61. Administer -> Reports -> Field list -> Permissions