VC/Vidyo: Update docs

vc_vidyo/docs/source/conf.py

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

vc_vidyo/docs/source/index.rst

@@ -5,6 +5,9 @@ Contents:
 
 .. toctree::
    :numbered:
-   :maxdepth: 2
+   :maxdepth: 1
 
    ./user.rst
+   ./manager.rst
+   ./service-admin.rst
+   ./server-admin.rst

vc_vidyo/docs/source/manager.rst

@@ -0,0 +1,39 @@
+==========================
+Videoconference management
+==========================
+
+Indico allows attaching Vidyo rooms to an event and other users can see
+information about these in the public pages of the events. This can be
+accomplished within the *Videoconference* menu in the event management area by
+either:
+
+- The creator of an event
+- An event manager
+- A videoconference service manager
+
+
+--------------------------
+Event Videoconference menu
+--------------------------
+
+This page shows all Vidyo rooms attached to the event and allows to modify their
+configuration as well as attaching existing rooms, creating new ones or
+detaching them.
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Attaching an existing Vidyo room
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Clicking on the *Add existing room* button will make a Vidyo room search dialog
+appear. Here, existing rooms can be found by name and attached to the event.
+Also, some basic settings can be configured directly before attaching.
+
+
+~~~~~~~~~~~~~~~~~~~~~
+Creating a Vidyo room
+~~~~~~~~~~~~~~~~~~~~~
+
+Clicking on the *Create Vidyo room* will redirect to the Vidyo room creation
+form. Here, all details concerning the room can be specified. Upon completion,
+the room will be attached to the event.

vc_vidyo/docs/source/server-admin.rst

@@ -0,0 +1,6 @@
+====================
+Plugin configuration
+====================
+
+Indico server administrators can configure the plugin in
+*Admin pages > Plugins > Vidyo*.

vc_vidyo/docs/source/service-admin.rst

@@ -0,0 +1,9 @@
+==================
+Service management
+==================
+
+Administrators of the Videoconference service can overview rooms from
+*Services > Videoconference* on the global menu bar in Indico.
+
+This page allows searching for Vidyo rooms based on several filtering
+parameters.

vc_vidyo/docs/source/user.rst

@@ -1,130 +1,26 @@
-===========
-Vidyo rooms
-===========
-Vidyo rooms are one of the types of videoconference rooms available in Indico. They are provided and managed by the
-Vidyo plugin.
+==========================
+Videoconferences in events
+==========================
 
-Event managers
-==============
-As an event manager, you have the possibility to create, add, edit and remove Vidyo rooms for your event, in the same
-way as for any other kind of videoconference room.
+Indico allows event managers to attach `Vidyo <http://www.vidyo.com>`_ rooms to
+their events and users can join from the event page.
 
-Vidyo specific room options
----------------------------
-In addition to the base options for videconference rooms: `name`, `linked to` and `show room`
-(see ``VC_MODULE_VC_ROOM_OPTIONS``), a Vidyo room also possesses the following options:
+If videoconferences have been booked for a meeting or a lecture, they will be
+displayed in the event page. On a conference, they can be found in the section
+*Videoconference Rooms* of the side menu.
 
-========================= ============================================================================
-Option                    Description
-========================= ============================================================================
-Description               the description of the room
-Owner                     the owner of the room
-Moderation PIN            code to gain moderation capabilities in the Vidyo room,
-                          leave blank to disable (no one can gain moderation capabilities)
-Room PIN                  code to enter the Vidyo room, leave blank to have a public room
-Auto mute                 whether people will join with their web cam and mic disabled by default
-Show PIN                  whether to show the `room PIN` on the Indico event page
+----------------------
+Join a videoconference
+----------------------
 
-                            **WARNING**: Showing the Vidyo room's pin on the event page is insecure.
-                            Anyone could see the pin and join the room.
-Show auto-join URL        whether to show the URL to auto-join the Vidyo room on the event page
-Show phone access numbers whether to show a link to the list of phone access numbers on the event page
-========================= ============================================================================
+To launch an ongoing Vidyo videoconference just click on the *Join* button. This
+will redirect to the Vidyo Portal where the participant will be asked for their
+account name and password. If they are not yet registered in the system, guest
+access and PIN protected access is also allowed.
 
+After logging in, the VidyoDesktop client (which is required to be installed in
+the participant's computer) will open and you will receive/send video and audio
+from/to the meeting.
 
-Creating a Vidyo room for an event
-----------------------------------
-To create a Vidyo room, go to the management area of your event and on the side menu on the left, select
-`Videoconference`. Then click on the button `Create a new room`, a pop-up is displayed, prompting you to select the type
-of video service you would like to use. Select the Vidyo badge. This will take you to the room creation form.
-
-    **NOTE**: If only Vidyo is available as video service, then the `Create a new room` button is replaced with a
-    `Create new Vidyo room` button which will take you directly to the room creation form.
-
-In addition to the base options (see ``LINK_TO_VC_MODULE_CREATE_ROOM``), you can set the following Vidyo specific
-options when creating the room:
-
-- description
-- owner
-- moderation pin
-- room pin
-- auto mute
-- show room
-- show auto-join URL
-- show phone access numbers
-
-Add an existing Vidyo room to an event
---------------------------------------
-To add an existing Vidyo room, go to the management area of your event and on the side menu on the left, select
-`Videoconference`. Then click on the button `Add existing room`, a pop-up is displayed, prompting you to select the type
-of video service you would like to use. Select the Vidyo badge. This will take you to the room attachment form.
-
-    **NOTE**: If only Vidyo is available as video service, then the `Add existing room` button will not ask you to
-    select a video service and instead display the room attachment form directly in the pop-up.
-
-On the room attachment form, you can search for the name of the room you want to attach to the event; as well as set the
-base options to attach any kind of videoconference room (see ``LINK_TO_VC_MODULE_ATTACH_ROOM``)
-
-In addition you can set the following Vidyo options:
-
-- show room
-- show auto-join URL
-- show phone access numbers
-
-Review Vidyo rooms
-------------------
-Vidyo rooms are listed among the other videoconference rooms in the videconference section of your event's management
-area. You can identify Vidyo rooms by the Vidyo logo on the left hand side of a room entry in the list (see
-``LINK_TO_VC_MODULE_MANAGEMENT_ROOMS_LIST``).
-
-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.
-
-Be aware that whilst the show room, show auto-join URL and show phone access numbers options can be set individually per
-event for the same room, the other options are only specific to the room. That is if you change, for example the room
-PIN, it will be changed for the room itself and people coming to the room from another event will have to know the new
-PIN to access the room.
-
-Delete a Vidyo room
--------------------
-You can delete a Vidyo room like any other videoconference room by clicking on the trash icon next to the room's name.
-
-Be aware that if the room is not attached to another event in Indico, it will be deleted from Vidyo as well and you will
-not be able to add it back. But if a room is attached to many events, deleting it from one event will only remove it
-from that event but not from the others or from Vidyo itself. In that case you can add the room back to the event with
-the `Add existing room` button (see `Add an existing Vidyo room to an event`_)
-
-Vidyo actions
-=============
-The Vidyo plugin also provides actions directly from an Indico event page or from the event's videoconference page in
-the case of conferences (and from the management area as well for event managers).
-
-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 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 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 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.
-
-Vidyo room details
-==================
-Details regarding a Vidyo room are visible on the event page or from the event's videoconference page in the case of
-conferences. They are accessible in the same way as any videoconference room details (see
-``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.
-    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.
+For information about registration, please go to
+`Vidyo Service <http://cern.ch /vidyo-service/>`_.

vc_vidyo/indico_vc_vidyo/plugin.py

@@ -120,8 +120,8 @@ class VidyoPlugin(VCPluginMixin, IndicoPlugin):
         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')
+                    url_for_plugin(self.name + '.static', filename='help/html/index.html'),
+                    url_for_plugin(self.name + '.static', filename='help/pdf/index.pdf')
                 )
             }
         }