[MERGE] from master

[odoo/odoo.git] / addons / pad / static / plugin / ep_disable_init_focus / README.md

diff --git a/addons/pad/static/plugin/ep_disable_init_focus/README.md b/addons/pad/static/plugin/ep_disable_init_focus/README.md
new file mode 100644 (file)
index 0000000..49a904a
--- /dev/null
+++ b/addons/pad/static/plugin/ep_disable_init_focus/README.md
@@ -0,0 +1,28 @@
+Readme
+======
+
+`ep_disable_init_focus` is a very simple
+[Etherpad-lite](https://github.com/ether/etherpad-lite) plugin, which disable
+the focus on the pad content after its loading.
+
+Rationale
+---------
+
+Etherpad-lite autofocus can be annoying to end-users when it is used in Odoo's
+"pad" widget, because it will override web client focus rules. This plugin is
+design to get rid of this behavior.
+
+
+Installation instructions
+-------------------------
+
+1. Stop your Etherpad-lite server.
+2. Copy the `ep_disabl_init_focus` folder into the `node_modules` folder of
+   your Etherpad-lite installation.
+3. in the folder of your Etherpad-lite installation, run this command to
+   install the plugin:
+
+    ```sh
+    npm install node_modules/ep_disable_init_focus/
+    ```
+4. Restart the Etherpad-lite server.