From d2a701354609051f3ac3034c69a482001b3597cd Mon Sep 17 00:00:00 2001
From: Florent Le Coz <louiz@louiz.org>
Date: Mon, 17 Dec 2012 05:04:17 +0100
Subject: Add the documentation for the time marker plugin.
---
doc/en/plugins/index.txt | 5 +++++
doc/en/plugins/time_marker.txt | 31 +++++++++++++++++++++++++++++++
2 files changed, 36 insertions(+)
create mode 100644 doc/en/plugins/time_marker.txt
(limited to 'doc/en/plugins')
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.
--
cgit v1.2.3