You are here

README.txt in Node Option Premium 8

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
NODE OPTION PREMIUM
===================

 * Introduction
 * Features
 * Requirements
 * Installation
 * Configuration
 * Who can fully view a premium node?
 * Limitations
 * Maintainers


INTRODUCTION
------------

This module adds a new node option "Premium content" to the core publishing
options (which are "Published", "Promoted to front page" and "Sticky at top of
lists"). When a node is published as premium content, only users with proper
privileges may view the full content of the node. Users without these privileges
can still access premium nodes, but only get the content rendered in teaser
context when trying to view the full content. An additional message informs them
that the content is available to premium users only.


FEATURES
--------

 * Mimics the way core publishing options work to ensure maximum integration
   with Drupal core and contributed modules.
 * Easy to use and to configure: you just need to set permissions.
 * Provides a permission to view full premium content for each content type.
 * Provides a permission to override the premium option for each content type.
   It allows users without the "administer nodes" permission to change the
   Premium content option on node editing. This completes what provides the
   essential Override Node Options module for core publishing options.
 * Integrates with Views: the module exposes a Premium content field, filter and
   sort.
 * Allows to theme the message displayed to non-premium users.
 * Allows to theme the teaser & message combination displayed to non-premium
   users.

The following features from the D7 version are not yet ported:

* Provides 2 actions/node operations: "Make content premium" and "Make content
  non-premium".
* Integrates with Rules: the module provides a "Content is premium" condition.


REQUIREMENTS
------------

No special requirements, the module only depends on the Node module, which is
included with Drupal Core.


INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. Visit
   https://www.drupal.org/docs/extending-drupal/installing-modules
   for further information.


CONFIGURATION
-------------

 * Navigate to admin/people/permissions and set the proper permissions for each
   content type.

 * Navigate to admin/config/content/nopremium to set the message for each
   content type that will be displayed to non-premium users.


WHO CAN FULLY VIEW A PREMIUM NODE?
----------------------------------

Obviously, any user with the view full NODE_TYPE premium content permission can
fully view it. But also:

 * Any user with the "administer nodes" permission.
 * The author of the node.
 * Any user with the edit any NODE_TYPE content permission.


LIMITATIONS
-----------

Node Option Premium does not have any effect on individual fields displayed in
views. But remember that you can control the way fields are displayed at the
theming level by overriding the proper views templates and checking the value of
the "Premium content" field. Node Option Premium has no built-in support for
time-limited premium contents.


MAINTAINERS
-----------

Current maintainers:
 * Youri van Koppen (MegaChriz) - https://www.drupal.org/u/megachriz
   https://www.webcoo.nl
 * Heshan Wanigasooriya (heshanlk) - https://www.drupal.org/u/heshanlk
   http://heididev.com

D7 module maintainer:
 * Henri MEDOT (anrikun) - https://www.drupal.org/u/anrikun
   http://www.absyx.fr

This project has been sponsored by:
 * Absyx
   Development of the D6 and D7 versions.
   http://www.absyx.fr
 * ElectricSage, LLC
   Ported the initial D8 version.
   http://electricsage.com
 * WebCoo
   Fixed bugs, provided automated tests and applied coding standards.
   https://www.webcoo.nl

File

README.txt
View source
  1. NODE OPTION PREMIUM
  2. ===================
  3. * Introduction
  4. * Features
  5. * Requirements
  6. * Installation
  7. * Configuration
  8. * Who can fully view a premium node?
  9. * Limitations
  10. * Maintainers
  11. INTRODUCTION
  12. ------------
  13. This module adds a new node option "Premium content" to the core publishing
  14. options (which are "Published", "Promoted to front page" and "Sticky at top of
  15. lists"). When a node is published as premium content, only users with proper
  16. privileges may view the full content of the node. Users without these privileges
  17. can still access premium nodes, but only get the content rendered in teaser
  18. context when trying to view the full content. An additional message informs them
  19. that the content is available to premium users only.
  20. FEATURES
  21. --------
  22. * Mimics the way core publishing options work to ensure maximum integration
  23. with Drupal core and contributed modules.
  24. * Easy to use and to configure: you just need to set permissions.
  25. * Provides a permission to view full premium content for each content type.
  26. * Provides a permission to override the premium option for each content type.
  27. It allows users without the "administer nodes" permission to change the
  28. Premium content option on node editing. This completes what provides the
  29. essential Override Node Options module for core publishing options.
  30. * Integrates with Views: the module exposes a Premium content field, filter and
  31. sort.
  32. * Allows to theme the message displayed to non-premium users.
  33. * Allows to theme the teaser & message combination displayed to non-premium
  34. users.
  35. The following features from the D7 version are not yet ported:
  36. * Provides 2 actions/node operations: "Make content premium" and "Make content
  37. non-premium".
  38. * Integrates with Rules: the module provides a "Content is premium" condition.
  39. REQUIREMENTS
  40. ------------
  41. No special requirements, the module only depends on the Node module, which is
  42. included with Drupal Core.
  43. INSTALLATION
  44. ------------
  45. * Install as you would normally install a contributed Drupal module. Visit
  46. https://www.drupal.org/docs/extending-drupal/installing-modules
  47. for further information.
  48. CONFIGURATION
  49. -------------
  50. * Navigate to admin/people/permissions and set the proper permissions for each
  51. content type.
  52. * Navigate to admin/config/content/nopremium to set the message for each
  53. content type that will be displayed to non-premium users.
  54. WHO CAN FULLY VIEW A PREMIUM NODE?
  55. ----------------------------------
  56. Obviously, any user with the view full NODE_TYPE premium content permission can
  57. fully view it. But also:
  58. * Any user with the "administer nodes" permission.
  59. * The author of the node.
  60. * Any user with the edit any NODE_TYPE content permission.
  61. LIMITATIONS
  62. -----------
  63. Node Option Premium does not have any effect on individual fields displayed in
  64. views. But remember that you can control the way fields are displayed at the
  65. theming level by overriding the proper views templates and checking the value of
  66. the "Premium content" field. Node Option Premium has no built-in support for
  67. time-limited premium contents.
  68. MAINTAINERS
  69. -----------
  70. Current maintainers:
  71. * Youri van Koppen (MegaChriz) - https://www.drupal.org/u/megachriz
  72. https://www.webcoo.nl
  73. * Heshan Wanigasooriya (heshanlk) - https://www.drupal.org/u/heshanlk
  74. http://heididev.com
  75. D7 module maintainer:
  76. * Henri MEDOT (anrikun) - https://www.drupal.org/u/anrikun
  77. http://www.absyx.fr
  78. This project has been sponsored by:
  79. * Absyx
  80. Development of the D6 and D7 versions.
  81. http://www.absyx.fr
  82. * ElectricSage, LLC
  83. Ported the initial D8 version.
  84. http://electricsage.com
  85. * WebCoo
  86. Fixed bugs, provided automated tests and applied coding standards.
  87. https://www.webcoo.nl