You are here

Home » API reference » Quote 5

README.txt in Quote 5

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 6.2 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 "quote.module" and "quote.css" files should be uploaded to "modules/quote/".

Quote.module must be enabled via the 'administer/modules' interface. 


Filter
------

The Quote filter should be activated for each input format that you want to have
it available (input filters are edited via the 'administer/filters' interface).

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/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.

Alternatively, the rules from "quote.css" can be copied into your theme's
"style.css" files. If you do this, remember to remove "quote.css" from the
"modules/quote/" folder.


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

Quote module settings page: admin -> quote.
Filter management: admin -> 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.

  10. 

  11. When output by Drupal, the quote will be displayed with special formatting to 

  12. indicate the material has been quoted.

  13. 

  14. 

  15. Installation

  16. ------------

  17. 

  18. The "quote.module" and "quote.css" files should be uploaded to "modules/quote/".

  19. 

  20. Quote.module must be enabled via the 'administer/modules' interface. 

  21. 

  22. 

  23. Filter

  24. ------

  25. 

  26. The Quote filter should be activated for each input format that you want to have

  27. it available (input filters are edited via the 'administer/filters' interface).

  28. 

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

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

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

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

  33. 'rearrange filters' tab.

  34. 

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

  36. have the optional bbcode.module installed.

  37. 

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

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

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

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

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

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

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

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

  46. comment quote links.

  47. 

  48. Settings

  49. --------

  50. 

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

  52. admin/quote. This page allows the filter to be associated with specific node 

  53. types, control if the quote link is displayed for nodes (as opposed to comments)

  54. and so on.

  55. 

  56. Format

  57. ------

  58. 

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

  60. quote:

  61. 

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

  63. 

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

  65. 

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

  67. 

  68. 

  69. Theme

  70. -----

  71. 

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

  73. the display of the quotes.

  74. 

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

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

  77. 

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

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

  80. light gray background.

  81. 

  82. Alternatively, the rules from "quote.css" can be copied into your theme's

  83. "style.css" files. If you do this, remember to remove "quote.css" from the

  84. "modules/quote/" folder.

  85. 

  86. 

  87. Project navigation

  88. ------------------

  89. 

  90. Quote module settings page: admin -> quote.

  91. Filter management: admin -> input formats

  92. 

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