summaryrefslogtreecommitdiff
path: root/doc/en/plugins
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2012-05-09 19:27:06 +0200
committermathieui <mathieui@mathieui.net>2012-05-09 19:27:06 +0200
commit089d94e6dbe757fb8309ec6c2179a71dbae79c34 (patch)
tree277a4be482429e29cd2ada68e6378adc09a11f53 /doc/en/plugins
parente1a817607b56c2cdb116b5ef55e17e8d856b10e5 (diff)
downloadpoezio-089d94e6dbe757fb8309ec6c2179a71dbae79c34.tar.gz
poezio-089d94e6dbe757fb8309ec6c2179a71dbae79c34.tar.bz2
poezio-089d94e6dbe757fb8309ec6c2179a71dbae79c34.tar.xz
poezio-089d94e6dbe757fb8309ec6c2179a71dbae79c34.zip
Add help for the translate plugin, but hide it for now
(since the plugin doesn’t work)
Diffstat (limited to 'doc/en/plugins')
-rw-r--r--doc/en/plugins/.translate.txt51
-rw-r--r--doc/en/plugins/index.txt5
2 files changed, 51 insertions, 5 deletions
diff --git a/doc/en/plugins/.translate.txt b/doc/en/plugins/.translate.txt
new file mode 100644
index 00000000..cb605699
--- /dev/null
+++ b/doc/en/plugins/.translate.txt
@@ -0,0 +1,51 @@
+Translate
+=========
+
+This plugin translates what is said in the groupchats using google translate.
+
+Installation
+------------
+You only have to load the plugin.
+
+================
+
+ /load translate
+
+================
+
+Configuration
+-------------
+
+You can set the rooms you want to be translated in the configuration file,
+with their associated language. If no language is specified, the _default_
+option is used, and if no option is set, _en_ is used as a target language.
+
+.No default set
+=====================
+[source,conf]
+------------
+[translate]
+poezio@muc.poezio.eu = en
+------------
+=====================
+
+.Default set
+=====================
+[source,conf]
+-------------
+[translate]
+default = fr
+prosody@conference.prosody.im =
+jabberfr@chat.jabberfr.org = en
+-------------
+=====================
+
+You can of course also set the options with _/set_:
+
+============================
+
+ /set translate| default jp
+
+ /set translate|translate poezio@muc.poezio.eu en
+
+============================
diff --git a/doc/en/plugins/index.txt b/doc/en/plugins/index.txt
index 92558c30..747411ca 100644
--- a/doc/en/plugins/index.txt
+++ b/doc/en/plugins/index.txt
@@ -134,11 +134,6 @@ Plugins index
Tells a message to a nick when he connects to a MUC.
-*Translate*:: Translation plugin
-
- Translates everything that is said in the poezio room into english (useful
- for non-french speakers). Can of course be tweaked to apply to other rooms.
-
*Uptime*:: link:uptime.html[Uptime plugin]
Gets the uptime of a XMPP server or a component.