summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2014-10-13 00:39:55 +0200
committermathieui <mathieui@mathieui.net>2014-10-13 00:39:55 +0200
commit8305f3bd53412cd694baffadbca645227c9c883f (patch)
tree88c98b4e6079640cee9bbe65bd6902daa1b8f2a5 /plugins
parent5a5d5812edeb852232ea22f8b10e6d2073ca05d1 (diff)
downloadpoezio-8305f3bd53412cd694baffadbca645227c9c883f.tar.gz
poezio-8305f3bd53412cd694baffadbca645227c9c883f.tar.bz2
poezio-8305f3bd53412cd694baffadbca645227c9c883f.tar.xz
poezio-8305f3bd53412cd694baffadbca645227c9c883f.zip
Document the before_quote and the after_quote options of the quote
plugin
Diffstat (limited to 'plugins')
-rw-r--r--plugins/quote.py22
1 files changed, 22 insertions, 0 deletions
diff --git a/plugins/quote.py b/plugins/quote.py
index 3236ef4d..8a4fd95c 100644
--- a/plugins/quote.py
+++ b/plugins/quote.py
@@ -19,6 +19,28 @@ Usage
If there is a message at 21:12:23, it will be put in the input. If there
isn’t, you will get a warning.
+
+Options
+-------
+
+.. glossary::
+ :sorted:
+
+ before_quote
+
+ **Default value:** ``[empty]``
+
+ Text to insert before the quote. ``%(nick)s`` and ``%(time)s`` can
+ be used to insert the nick of the user who sent the message or the
+ time of the message.
+
+ after_quote
+
+ **Default value:** ``[empty]``
+
+ Text to insert after the quote. ``%(nick)s`` and ``%(time)s`` can
+ be used to insert the nick of the user who sent the message or the
+ time of the message.
"""
from plugin import BasePlugin
from xhtml import clean_text