summaryrefslogtreecommitdiff
path: root/doc/en/plugins
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2012-12-17 05:04:17 +0100
committerFlorent Le Coz <louiz@louiz.org>2012-12-17 05:04:17 +0100
commitd2a701354609051f3ac3034c69a482001b3597cd (patch)
tree15baba6819665bd59e0b97a38778ce0ae7f787b1 /doc/en/plugins
parent29f3d9a0bc898fdb25b183805b6b30a06bd147dd (diff)
downloadpoezio-d2a701354609051f3ac3034c69a482001b3597cd.tar.gz
poezio-d2a701354609051f3ac3034c69a482001b3597cd.tar.bz2
poezio-d2a701354609051f3ac3034c69a482001b3597cd.tar.xz
poezio-d2a701354609051f3ac3034c69a482001b3597cd.zip
Add the documentation for the time marker plugin.
Diffstat (limited to 'doc/en/plugins')
-rw-r--r--doc/en/plugins/index.txt5
-rw-r--r--doc/en/plugins/time_marker.txt31
2 files changed, 36 insertions, 0 deletions
diff --git a/doc/en/plugins/index.txt b/doc/en/plugins/index.txt
index f902870c..a6bcd5a2 100644
--- a/doc/en/plugins/index.txt
+++ b/doc/en/plugins/index.txt
@@ -143,3 +143,8 @@ Plugins index
*Replace*:: link:replace.html[Replace plugin]
Replace some patterns in your messages.
+
+*Time Marker*:: like::time_marker.html[Time marker plugin]
+
+ Display the time between two messages.
+
diff --git a/doc/en/plugins/time_marker.txt b/doc/en/plugins/time_marker.txt
new file mode 100644
index 00000000..ad171b0d
--- /dev/null
+++ b/doc/en/plugins/time_marker.txt
@@ -0,0 +1,31 @@
+Time Marker
+===========
+
+Display the time between two messages.
+
+Installation
+------------
+
+You only have to load the plugin.
+
+================
+
+ /load amsg
+
+================
+
+Configuration
+-------------
+
+You can configure the minimum delay between two messages, to display the time marker, in seconds. The default is 10 minutes (aka 600 seconds).
+
+[source,conf]
+---------------------------------------------------------------------
+[time_marker]
+delay = 600
+---------------------------------------------------------------------
+
+Usage
+-----
+
+Messages like “2 hours, 25 minutes passed…” are automatically displayed into the converstation. You don’t need to (and can’t) do anything.