You are here

Home » API reference » Quote 6.2

README.txt in Quote 6.2

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 5 README.txt
  3. 6 README.txt
  4. 7.2 README.txt
  5. 7 README.txt
Quote.module
------------

This module adds a 'quote' link below nodes and comments. When clicked, the 
contents of the node or comment are placed into a new comment enclosed with 
special markup that indicates it is quoted material. 

This module also features a filter which translates the special markup into HTML
code. When output by Drupal, the quote will be displayed with special formatting
to indicate the material has been quoted.


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

The module should be installed within an appropriate module directory such as
'sites/all/modules/quote'. Once installed, it can be enabled via the module
administration interface at 'admin/modules'.


Filter
------

The Quote filter should be activated for each input format that it needs to be a
part of. Input formats can be configured via the 'admin/settings/filters'.

For best effect, the Quote filter must be applied *after* any filters that 
replace HTML, and *before* the Linebreak filter. Or conversely, if
HTML filters consider <div> tags to be valid, the quote filter can be placed
before them. Filters can be rearranged by using the weight selectors within the
'rearrange filters' tab.

Additionally, the Quote filter must be applied *before* the BBCode filter if you
have the optional BBCode module installed.

As the quote filter accesses the node (being quoted) directly, any content 
within will be displayed without any processing. For example, if a user is 
quoting a page node containing PHP (which by default is evaluated by the PHP 
filter) or any other sensitive code, it is quoted as is without the PHP (or any
other) filter being applied. While the PHP code is never evaluated in a comment,
it is nevertheless possible that sensitive server side information is made 
available to the public. To avoid this situation, quote links can be 
enabled/disabled for the parent node via the settings page. This does not affect
comment quote links.

Settings
--------

The Quote module can be configured further through its settings page at
admin/settings/quote. This page allows the filter to be associated with specific
node types, control if the quote link is displayed for nodes (as opposed to
comments), and so on.

Format
------

Quoted content can be placed between [quote] tags in order to be displayed as a
quote:

[quote]This is a simple quote.[/quote]

There is an optional attribute which allows quotes to cite the author:

[quote=author's name]This is a quote with an attribution line.[/quote]


Theme
-----

There are two css rules located in "quote.css" which can be altered to change
the display of the quotes.

'quote-msg' controls the display of the quote content.
'quote-author' controls the display of the attribution line.

The default "quote.css" rules are designed for Drupal's default Bluemarine 
theme. By default, quoted content is placed into an indented box, which has a 
light gray background.

As mentioned above, CSS rules are meant to be overridden. In other words, there
should never be a need to directly edit the CSS (or for that matter, any other)
file in the module's directory.

If the markup used to display the quote needs to be changed, this can be done by
overriding the theme function theme_quote() from within a theme.


Project navigation
------------------

Settings: Administer -> Site configuration -> Quote.
Filter management: Administer -> Site configuration -> Input formats

Project URL: http://drupal.org/project/quote

File

README.txt
View source 
  1. Quote.module

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

  3. 

  4. This module adds a 'quote' link below nodes and comments. When clicked, the 

  5. contents of the node or comment are placed into a new comment enclosed with 

  6. special markup that indicates it is quoted material. 

  7. 

  8. This module also features a filter which translates the special markup into HTML

  9. code. When output by Drupal, the quote will be displayed with special formatting

  10. to indicate the material has been quoted.

  11. 

  12. 

  13. Installation

  14. ------------

  15. 

  16. The module should be installed within an appropriate module directory such as

  17. 'sites/all/modules/quote'. Once installed, it can be enabled via the module

  18. administration interface at 'admin/modules'.

  19. 

  20. 

  21. Filter

  22. ------

  23. 

  24. The Quote filter should be activated for each input format that it needs to be a

  25. part of. Input formats can be configured via the 'admin/settings/filters'.

  26. 

  27. For best effect, the Quote filter must be applied *after* any filters that 

  28. replace HTML, and *before* the Linebreak filter. Or conversely, if

  29. HTML filters consider 
     tags to be valid, the quote filter can be placed

  30. before them. Filters can be rearranged by using the weight selectors within the

  31. 'rearrange filters' tab.

  32. 

  33. Additionally, the Quote filter must be applied *before* the BBCode filter if you

  34. have the optional BBCode module installed.

  35. 

  36. As the quote filter accesses the node (being quoted) directly, any content 

  37. within will be displayed without any processing. For example, if a user is 

  38. quoting a page node containing PHP (which by default is evaluated by the PHP 

  39. filter) or any other sensitive code, it is quoted as is without the PHP (or any

  40. other) filter being applied. While the PHP code is never evaluated in a comment,

  41. it is nevertheless possible that sensitive server side information is made 

  42. available to the public. To avoid this situation, quote links can be 

  43. enabled/disabled for the parent node via the settings page. This does not affect

  44. comment quote links.

  45. 

  46. Settings

  47. --------

  48. 

  49. The Quote module can be configured further through its settings page at

  50. admin/settings/quote. This page allows the filter to be associated with specific

  51. node types, control if the quote link is displayed for nodes (as opposed to

  52. comments), and so on.

  53. 

  54. Format

  55. ------

  56. 

  57. Quoted content can be placed between [quote] tags in order to be displayed as a

  58. quote:

  59. 

  60. [quote]This is a simple quote.[/quote]

  61. 

  62. There is an optional attribute which allows quotes to cite the author:

  63. 

  64. [quote=author's name]This is a quote with an attribution line.[/quote]

  65. 

  66. 

  67. Theme

  68. -----

  69. 

  70. There are two css rules located in "quote.css" which can be altered to change

  71. the display of the quotes.

  72. 

  73. 'quote-msg' controls the display of the quote content.

  74. 'quote-author' controls the display of the attribution line.

  75. 

  76. The default "quote.css" rules are designed for Drupal's default Bluemarine 

  77. theme. By default, quoted content is placed into an indented box, which has a 

  78. light gray background.

  79. 

  80. As mentioned above, CSS rules are meant to be overridden. In other words, there

  81. should never be a need to directly edit the CSS (or for that matter, any other)

  82. file in the module's directory.

  83. 

  84. If the markup used to display the quote needs to be changed, this can be done by

  85. overriding the theme function theme_quote() from within a theme.

  86. 

  87. 

  88. Project navigation

  89. ------------------

  90. 

  91. Settings: Administer -> Site configuration -> Quote.

  92. Filter management: Administer -> Site configuration -> Input formats

  93. 

  94. Project URL: http://drupal.org/project/quote