|
| 1 | +==================== |
| 2 | +Community Chat Rooms |
| 3 | +==================== |
| 4 | + |
| 5 | +In the **Events** app, users can create *Jitsi* video conference rooms for event attendees to |
| 6 | +connect and discuss topics related to the event. |
| 7 | + |
| 8 | +Configuration |
| 9 | +============= |
| 10 | + |
| 11 | +To set up community rooms, the *Community Chat Rooms* feature needs to be enabled in the **Events** |
| 12 | +settings by navigating to :menuselection:`Events app --> Configuration --> Settings`. In the |
| 13 | +*Events* section, enable :guilabel:`Community Chat Rooms` and click :guilabel:`Save`. |
| 14 | + |
| 15 | +With the *Community Chat Rooms* feature enabled, users can then :ref:`create community rooms |
| 16 | +<community_rooms/create-room>` in the database and publish them on the website. Event attendees can |
| 17 | +not only join rooms but also create them directly :ref:`on the website <community_rooms/website>`. |
| 18 | + |
| 19 | +.. _community_rooms/create-room: |
| 20 | + |
| 21 | +Create a room |
| 22 | +============= |
| 23 | + |
| 24 | +To create a community room in the database, open the **Events** app, then select or create an event. |
| 25 | + |
| 26 | +A :icon:`fa-comments-o` :guilabel:`Rooms` smart button appears at the top of the event form. Click |
| 27 | +it to open the list of meeting rooms created for the event. |
| 28 | + |
| 29 | +.. image:: community_rooms/meeting-rooms-list.png |
| 30 | + :alt: List of meeting rooms for an event in Odoo Events. |
| 31 | + |
| 32 | +Meeting room form |
| 33 | +----------------- |
| 34 | + |
| 35 | +To create a new room, click :guilabel:`New`. This opens a form to configure details about the room. |
| 36 | + |
| 37 | +.. image:: community_rooms/meeting-room-form.png |
| 38 | + :alt: Meeting room form in Odoo Events. |
| 39 | + |
| 40 | +Begin by entering the name of the topic in the :guilabel:`Topic` field. |
| 41 | + |
| 42 | +Then, complete the information in the following fields: |
| 43 | + |
| 44 | +- :guilabel:`Event`: Select the corresponding event for the meeting room. This field is |
| 45 | + automatically populated. |
| 46 | +- :guilabel:`Summary`: Enter a short description of the meeting room's purpose. |
| 47 | +- :guilabel:`Audience`: Specify the intended audience of the meeting room. |
| 48 | +- :guilabel:`Is Pinned`: Specify whether the meeting room should be pinned on the event website. |
| 49 | +- :guilabel:`Max capacity`: Select the maximum number of participants allowed in the room. |
| 50 | +- :guilabel:`Language`: Select the language of the meeting. |
| 51 | + |
| 52 | +The :guilabel:`Chat Room` field is automatically populated with a generated name for the *Jitsi* |
| 53 | +conference room. If desired, the user can change this name by clicking the field and modifying any |
| 54 | +details on the resulting form. |
| 55 | + |
| 56 | +Finally, the :guilabel:`Participant count` field automatically populates with the number of |
| 57 | +attendees currently in the meeting room. |
| 58 | + |
| 59 | +Once the meeting room form is complete, a :guilabel:`Reporting` tab appears at the bottom of the |
| 60 | +form, allowing users to monitor the :guilabel:`Last activity` date and the :guilabel:`Peak |
| 61 | +participants` count for the event. |
| 62 | + |
| 63 | +Publish meeting room |
| 64 | +-------------------- |
| 65 | + |
| 66 | +After configuring the meeting room form, users must publish the room on the event website to make it |
| 67 | +visible for event attendees. To do this, click the :icon:`fa-globe` :guilabel:`Go to Website` smart |
| 68 | +button at the top of the meeting room form. |
| 69 | + |
| 70 | +This opens the meeting room page on the event website, currently invisible to attendees. To publish |
| 71 | +it, toggle the :icon:`fa-toggle-off` :guilabel:`Unpublished` button. The meeting room is then |
| 72 | +:icon:`fa-toggle-on` :guilabel:`Published` and available for attendees to join. |
| 73 | + |
| 74 | +.. _community_rooms/website: |
| 75 | + |
| 76 | +Community rooms on the website |
| 77 | +============================== |
| 78 | + |
| 79 | +Once published, community rooms appear on the event's webpage. To access them, open the **Website** |
| 80 | +app and navigate to the :guilabel:`Events` header menu item on the website. Then, select the desired |
| 81 | +event to open the event-specific webpage. The sub-menu appears with the :guilabel:`Community` |
| 82 | +option. |
| 83 | + |
| 84 | +.. note:: |
| 85 | + If the :guilabel:`Community` sub-menu item is not displayed, the website must first be modified |
| 86 | + in the database using the editor mode in order to display the sub-menu. |
| 87 | + |
| 88 | + To start, click :guilabel:`Edit` in the top corner. In the :guilabel:`Customize` tab, toggle the |
| 89 | + :guilabel:`Sub-menu (Specific)` option, then click :guilabel:`Save`. |
| 90 | + |
| 91 | +.. image:: community_rooms/meeting-rooms-page.png |
| 92 | + :alt: Meeting rooms page on event webpage in Odoo Events. |
| 93 | + |
| 94 | +Clicking the :guilabel:`Community` sub-menu item opens the *Join a room* page, listing all published |
| 95 | +meeting rooms, along with information including the topic title, a short summary of the room's |
| 96 | +purpose, and the number of participants in the room. Optionally, attendees can also pin a meeting |
| 97 | +room by clicking the :icon:`fa-thumb-tack` :guilabel:`(pin)` icon next to the title. |
| 98 | + |
| 99 | +To join a room, click on the desired topic. This opens the *Jitsi* video conferencing room where |
| 100 | +attendees can chat. |
| 101 | + |
| 102 | +.. image:: community_rooms/meeting-room.png |
| 103 | + :alt: Meeting room on event webpage in Odoo Events. |
| 104 | + |
| 105 | +Create a room as an attendee |
| 106 | +---------------------------- |
| 107 | + |
| 108 | +The *Join a room* page on the event website also features an option for attendees to launch a new |
| 109 | +meeting room for a specific topic. |
| 110 | + |
| 111 | +To create a new meeting room as an attendee, click the :guilabel:`Create a Room` button. This opens |
| 112 | +a *Launch a new topic* pop-up window. |
| 113 | + |
| 114 | +Similar to creating a room in the database, continue by filling in the following details about the |
| 115 | +room: |
| 116 | + |
| 117 | +- :guilabel:`Room Topic`: The name of the topic. |
| 118 | +- :guilabel:`Short Summary`: A short description about the meeting's purpose. |
| 119 | +- :guilabel:`Target People`: The intended audience of the meeting. |
| 120 | +- :guilabel:`Language`: The target language of the meeting. |
| 121 | +- :guilabel:`Capacity`: The maximum capacity of the room. |
| 122 | + |
| 123 | +After completing the form, click :guilabel:`Create` to finish. The room is then created and the |
| 124 | +attendee is redirected to the conferencing page. |
0 commit comments