You are here

README.txt in Read More Control 7

Read More Control module - http://drupal.org/sandbox/Monochrome/1088582
=======================================================================

DESCRIPTION
------------
A module to control when to show the Read More link that appears in Drupal 7.

There is no mechanism in core to decide if the Read More link should appear.
This means that this link will always show no matter if there is additional
content to display. This module tries to overcome this issue by allowing
administrators to determine how to handle this link in relation to both the
content type and individual fields.

As of version 7.x-1.1, the module can also be used to add Read More links to
other view modes and also other entity types. Core Drupal defined modes have
little additional functionality; the node RSS and Search Results page are about
the only additional displays that will accept a Read More link.

The module Entity view modes will allow users to define custom view modes that
will be customizble to allow users to append Read More links at will.

Note that some themes only display links on node teaser views, so these may
need twicking to get the link to appear.

REQUIREMENTS
------------
Drupal 7.x

INSTALLATION
------------
1.  Download the module from http://drupal.org/project/readmorecontrol

2.  Copy the module Read More Control modules into your modules directory.
    This is normally the "sites/all/modules" directory.

3.  Go to admin/build/modules. Enable the module.
    It is found in the User interface section.

UPGRADING
---------
As per any module, back up your site and run update.php.

USAGE
-----
By default, the module does not do anything, it must be configured first.

1 - Global settings
-------------------

There are three levels of configuration, the global is the recommended method.

Visit the page Admin » Configuration » Content authoring » Read more settings

This gives you the following options:

a) Always show link

This is the standard Drupal 7 behaviour. The link will show unless the theme or
another module removes it from the display.

b) Never show link

This removes the link.

c) Show link when required by any supported fields

This removes the link if there are fields with content that have a different
display settings that the main view. 

d) Show link when required by any supported text based fields

As per c, but limited to "Long text" or "Text with summary" text fields only.

e) Show link when required by the Body (body) field

Limited to the automatically created Body (body) field. This mimics the standard
Drupal 6 behaviour that checked the body, but ignored CCK fields.

Note:
* "Always/Never show link" (a & b) options never check field settings
* All fields can be configured to be ignored irrespective of these settings.
* Empty fields are not used when checking the need for the Read more link.
* If the main view does not show the field, the field will not trigger a link.
* Most themes link teaser titles to the node irrespective of these settings.
* When Text fields are referenced, this means fields of "Long text" or "Text
  with summary" only. Any teaser field is compared to the complete text value
  when determining if the read more link is show.
* All other fields have their field settings used to estimate if the link should
  appear. If display types or display type settings are different, then the two
  different views are considered different and this would trigger a Read more
  link. 
* More or less options may show here depending on the display mode and entity
  type that is being configured.

2 - Display settings
--------------------

Every custom display mode now has these options. Settings that were once found
in the content types edit page are now found under the default display settings.

These have the same options as above. Additionally, there is a "Default" option.
This effectively means that you want the global settings used rather than
overriding this value here.

If a custom view mode uses the default settings, the view mode settings for the
Default view mode are first checked, and if not set, then the global defaults
are used.

3 - Instance settings
---------------------

A new setting "Read More Behaviour" appears.

The default behaviour is to use the global or content type settings, but you can
expressively define that this field should be ignored or used. 

Note that if the global or content type settings do not use this field, then the
settings here are ignored. For example:

This setting is not processed if:

a) Always show link
b) Never show link

Fields are only checked if they are "Long text" or "Text with summary" fields.

d) Show link when required by any supported text based fields

Field is only checked if it is the core Body (body) field.

e) Show link when required by the Body (body) field

An example of when 'Read More Ignores Field' can be useful is if your teaser 
displays an image thumbnail that links to the full article that displays the
full sized image in it. If there is body text and the display between full and
teaser views don't differ, then the read more link wouldn't be displayed. To 
see the full image a visiter can just click on the image. However if the 
body text does differ a 'Read More' link would be displayed indicating there is
more body text in the article.

Another example when 'Read More Ignores Field' can be useful is to stop the 
'Read More' links from appearing if want to hide taxonomy fields from teaser 
view. Normally when the 'Display Read More' setting is set to 'When Required'
if you have a hidden field in teaser view that is not hidden in full view, the
'Read More' link will be shown. By setting the 'Read More Ignores Field' 
setting on something like a Taxonomy field you can stop it from being shown in 
the teaser but can still have it shown in the full view and not have a 
'Read More' link shown. 

As a note, even if the 'Read More' link is not shown, clicking on the Title of 
a node teaser will show the full node, so full node view is still easy to see.

AUTHORS
-------
Alan D. - http://drupal.org/user/198838.

Alan took over the very early sandbox prototype and developed this into the 
module it is now.

Alexis Ryan (Monochrome) - http://drupal.org/user/1147898.

Alexis developed the initial version of this module and has full credit for the
concept and base implementation.

Thanks to everybody else who have helped test and contribute patches!

File

README.txt
View source
  1. Read More Control module - http://drupal.org/sandbox/Monochrome/1088582
  2. =======================================================================
  3. DESCRIPTION
  4. ------------
  5. A module to control when to show the Read More link that appears in Drupal 7.
  6. There is no mechanism in core to decide if the Read More link should appear.
  7. This means that this link will always show no matter if there is additional
  8. content to display. This module tries to overcome this issue by allowing
  9. administrators to determine how to handle this link in relation to both the
  10. content type and individual fields.
  11. As of version 7.x-1.1, the module can also be used to add Read More links to
  12. other view modes and also other entity types. Core Drupal defined modes have
  13. little additional functionality; the node RSS and Search Results page are about
  14. the only additional displays that will accept a Read More link.
  15. The module Entity view modes will allow users to define custom view modes that
  16. will be customizble to allow users to append Read More links at will.
  17. Note that some themes only display links on node teaser views, so these may
  18. need twicking to get the link to appear.
  19. REQUIREMENTS
  20. ------------
  21. Drupal 7.x
  22. INSTALLATION
  23. ------------
  24. 1. Download the module from http://drupal.org/project/readmorecontrol
  25. 2. Copy the module Read More Control modules into your modules directory.
  26. This is normally the "sites/all/modules" directory.
  27. 3. Go to admin/build/modules. Enable the module.
  28. It is found in the User interface section.
  29. UPGRADING
  30. ---------
  31. As per any module, back up your site and run update.php.
  32. USAGE
  33. -----
  34. By default, the module does not do anything, it must be configured first.
  35. 1 - Global settings
  36. -------------------
  37. There are three levels of configuration, the global is the recommended method.
  38. Visit the page Admin » Configuration » Content authoring » Read more settings
  39. This gives you the following options:
  40. a) Always show link
  41. This is the standard Drupal 7 behaviour. The link will show unless the theme or
  42. another module removes it from the display.
  43. b) Never show link
  44. This removes the link.
  45. c) Show link when required by any supported fields
  46. This removes the link if there are fields with content that have a different
  47. display settings that the main view.
  48. d) Show link when required by any supported text based fields
  49. As per c, but limited to "Long text" or "Text with summary" text fields only.
  50. e) Show link when required by the Body (body) field
  51. Limited to the automatically created Body (body) field. This mimics the standard
  52. Drupal 6 behaviour that checked the body, but ignored CCK fields.
  53. Note:
  54. * "Always/Never show link" (a & b) options never check field settings
  55. * All fields can be configured to be ignored irrespective of these settings.
  56. * Empty fields are not used when checking the need for the Read more link.
  57. * If the main view does not show the field, the field will not trigger a link.
  58. * Most themes link teaser titles to the node irrespective of these settings.
  59. * When Text fields are referenced, this means fields of "Long text" or "Text
  60. with summary" only. Any teaser field is compared to the complete text value
  61. when determining if the read more link is show.
  62. * All other fields have their field settings used to estimate if the link should
  63. appear. If display types or display type settings are different, then the two
  64. different views are considered different and this would trigger a Read more
  65. link.
  66. * More or less options may show here depending on the display mode and entity
  67. type that is being configured.
  68. 2 - Display settings
  69. --------------------
  70. Every custom display mode now has these options. Settings that were once found
  71. in the content types edit page are now found under the default display settings.
  72. These have the same options as above. Additionally, there is a "Default" option.
  73. This effectively means that you want the global settings used rather than
  74. overriding this value here.
  75. If a custom view mode uses the default settings, the view mode settings for the
  76. Default view mode are first checked, and if not set, then the global defaults
  77. are used.
  78. 3 - Instance settings
  79. ---------------------
  80. A new setting "Read More Behaviour" appears.
  81. The default behaviour is to use the global or content type settings, but you can
  82. expressively define that this field should be ignored or used.
  83. Note that if the global or content type settings do not use this field, then the
  84. settings here are ignored. For example:
  85. This setting is not processed if:
  86. a) Always show link
  87. b) Never show link
  88. Fields are only checked if they are "Long text" or "Text with summary" fields.
  89. d) Show link when required by any supported text based fields
  90. Field is only checked if it is the core Body (body) field.
  91. e) Show link when required by the Body (body) field
  92. An example of when 'Read More Ignores Field' can be useful is if your teaser
  93. displays an image thumbnail that links to the full article that displays the
  94. full sized image in it. If there is body text and the display between full and
  95. teaser views don't differ, then the read more link wouldn't be displayed. To
  96. see the full image a visiter can just click on the image. However if the
  97. body text does differ a 'Read More' link would be displayed indicating there is
  98. more body text in the article.
  99. Another example when 'Read More Ignores Field' can be useful is to stop the
  100. 'Read More' links from appearing if want to hide taxonomy fields from teaser
  101. view. Normally when the 'Display Read More' setting is set to 'When Required'
  102. if you have a hidden field in teaser view that is not hidden in full view, the
  103. 'Read More' link will be shown. By setting the 'Read More Ignores Field'
  104. setting on something like a Taxonomy field you can stop it from being shown in
  105. the teaser but can still have it shown in the full view and not have a
  106. 'Read More' link shown.
  107. As a note, even if the 'Read More' link is not shown, clicking on the Title of
  108. a node teaser will show the full node, so full node view is still easy to see.
  109. AUTHORS
  110. -------
  111. Alan D. - http://drupal.org/user/198838.
  112. Alan took over the very early sandbox prototype and developed this into the
  113. module it is now.
  114. Alexis Ryan (Monochrome) - http://drupal.org/user/1147898.
  115. Alexis developed the initial version of this module and has full credit for the
  116. concept and base implementation.
  117. Thanks to everybody else who have helped test and contribute patches!