VC/Vidyo: Fix docs, add missing link

sphinx-conf.py

@@ -120,7 +120,7 @@ html_theme = 'default'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

vc_vidyo/doc/admin.rst

@@ -1,5 +0,0 @@
-Vidyo plugin settings
-=====================
-
-The Vidyo plugin settings can be found in the `Server Administration` area, on the `Plugins` page under `Video
-conference`. To access the settings page, simply click on the badge labelled `Vidyo`.

vc_vidyo/doc/index.rst

@@ -1,19 +0,0 @@
-Vidyo plugin's guide
-====================
-
-Contents:
-
-.. toctree::
-   :numbered:
-   :maxdepth: 2
-
-   ./admin.rst
-   ./user.rst
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

vc_vidyo/docs/Makefile

@@ -0,0 +1 @@
+../../SphinxMakefile

vc_vidyo/docs/source/conf.py

@@ -0,0 +1,5 @@
+execfile('../../../sphinx-conf.py')
+
+latex_documents = [
+    ('user', 'user.tex', u'Vidyo Guide', u'Indico Team', 'manual'),
+]

vc_vidyo/docs/source/index.rst

@@ -0,0 +1,10 @@
+Vidyo Guide
+===========
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   ./user.rst

vc_vidyo/docs/source/user.rst

@@ -80,7 +80,7 @@ area. You can identify Vidyo rooms by the Vidyo logo on the left hand side of a
 You can see the Vidyo specific options by clicking on the arrow at the very left of the Vidyo logo.
 
 Edit a Vidyo room
----------------------------
+-----------------
 You can edit a Vidyo room like any other videoconference room by clicking on the pencil icon next to the room's name.
 This will bring you to the room edit form, where you will be able to set all the base and Vidyo specific options.
 
@@ -108,13 +108,13 @@ Join
 You can join a Vidyo room by clicking the blue Join button next to a room's name. This will connect you to the Vidyo
 room through am available Vidyo client, usually the VidyoDesktop™ or VidyoMobile™ client.
 
-Make me moderator
------------------
+Make me owner
+-------------
 This action is only available on the event page or from the event's videoconference page in the case of conferences. It
-allows someone to replace the current moderator of a room with himself. This is equivalent to editing the room and set
+allows someone to replace the current owner of a room with himself. This is equivalent to editing the room and set
 the owner of the room as yourself.
 
-The action is only be available to event managers who are not the moderator of the room. If available it will be shown
+The action is only be available to event managers who are not the owner of the room. If available it will be shown
 as a drop-down next to the `join`. Clicking on the drop-down arrow, a menu with the `Make me owner` will appear. Then
 click on `Make me an owner` to set yourself as the owner of the room.
 
@@ -125,6 +125,6 @@ conferences. They are accessible in the same way as any videoconference room det
 ``LINK_TO_VC_MODULE_SEE_ROOM_DETAILS``)
 
     **NOTE**: The auto-join URL is intended to be copied and pasted in emails and other places to give people a way to
-    automatically join the Vidyo room. To join the room from the Indico page, you should instead use the `join`_ button.
+    automatically join the Vidyo room. To join the room from the Indico page, you should instead use the `Join`_ button.
     The link might appear to be cut if it is very long as it overflows, the easiest way to make sure you have copied the
     entire link correctly is to use the copy button to the right of the link.

vc_vidyo/indico_vc_vidyo/plugin.py

@@ -17,7 +17,6 @@
 from __future__ import unicode_literals
 
 from flask import session
-from flask_pluginengine import render_plugin_template
 from sqlalchemy.orm.attributes import flag_modified
 from wtforms.fields import IntegerField, TextAreaField
 from wtforms.fields.html5 import URLField, EmailField
@@ -26,6 +25,7 @@ from wtforms.validators import NumberRange, DataRequired
 
 from indico.core.config import Config
 from indico.core.plugins import IndicoPlugin, url_for_plugin, IndicoPluginBlueprint, wrap_cli_manager
+from indico.core import signals
 from indico.modules.vc.exceptions import VCRoomError, VCRoomNotFoundError
 from indico.modules.vc import VCPluginSettingsFormBase, VCPluginMixin
 from indico.modules.vc.views import WPVCManageEvent, WPVCEventPage
@@ -81,6 +81,7 @@ class VidyoPlugin(VCPluginMixin, IndicoPlugin):
 
     def init(self):
         super(VidyoPlugin, self).init()
+        self.connect(signals.indico_help, self._extend_indico_help)
         self.inject_css('vc_vidyo_css', WPVCManageEvent)
         self.inject_js('vc_vidyo_js', WPTPLConferenceDisplay)
         self.inject_js('vc_vidyo_js', WPVCEventPage)
@@ -113,6 +114,16 @@ class VidyoPlugin(VCPluginMixin, IndicoPlugin):
     def icon_url(self):
         return url_for_plugin(self.name + '.static', filename='images/vidyo_logo_notext.png')
 
+    def _extend_indico_help(self, sender, **kwargs):
+        return {
+            _('Videoconference'): {
+                _('Vidyo'): (
+                    url_for_plugin(self.name + '.static', filename='help/html/user.html'),
+                    url_for_plugin(self.name + '.static', filename='help/pdf/user.pdf')
+                )
+            }
+        }
+
     def update_data_association(self, event, vc_room, event_vc_room, data):
         super(VidyoPlugin, self).update_data_association(event, vc_room, event_vc_room, data)