modules/quote/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. (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.

Technically, the Quote filter is optional. If it is not activated, users will 
see the raw code instead of the themed output (see FORMAT below to see examples
of the raw code output).

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
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. (Filters can be rearranged by
31	using the weight selectors within the '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	Technically, the Quote filter is optional. If it is not activated, users will
37	see the raw code instead of the themed output (see FORMAT below to see examples
38	of the raw code output).
39
40	As the quote filter accesses the node (being quoted) directly, any content
41	within will be displayed without any processing. For example, if a user is
42	quoting a page node containing PHP (which by default is evaluated by the PHP
43	filter) or any other sensitive code, it is quoted as is without the PHP (or any
44	other) filter being applied. While the PHP code is never evaluated in a comment,
45	it is nevertheless possible that sensitive server side information is made
46	available to the public. To avoid this situation, quote links can be
47	enabled/disabled for the parent node via the settings page. This does not affect
48	comment quote links.
49
50	Settings
51	--------
52
53	The Quote module can be configured further through its settings page at
54	admin/quote. This page allows the filter to be associated with specific node
55	types, control if the quote link is displayed for nodes (as opposed to comments)
56	and so on.
57
58	Format
59	------
60
61	Quoted content can be placed between [quote] tags in order to be displayed as a
62	quote:
63
64	[quote]This is a simple quote.[/quote]
65
66	There is an optional attribute which allows quotes to cite the author:
67
68	[quote=author's name]This is a quote with an attribution line.[/quote]
69
70
71	Theme
72	-----
73
74	There are two css rules located in "quote.css" which can be altered to change
75	the display of the quotes.
76
77	'quote-msg' controls the display of the quote content.
78	'quote-author' controls the display of the attribution line.
79
80	The default "quote.css" rules are designed for Drupal's default Bluemarine
81	theme. By default, quoted content is placed into an indented box, which has a
82	light gray background.
83
84	Alternatively, the rules from "quote.css" can be copied into your theme's
85	"style.css" files. If you do this, remember to remove "quote.css" from the
86	"modules/quote/" folder.
87
88
89	Project navigation
90	------------------
91
92	Quote module settings page: admin -> quote.
93	Filter management: admin -> input formats
94
95	Project URL: http://drupal.org/project/quote