Refs #22575: Updated the application menu user manual

Signed-off-by: Juanjo Garcia <[email protected]>

docs/rst/user_manual/application_menu.rst

@@ -15,44 +15,52 @@ File
 
 .. _init_monitor_button:
 
-Initialize Monitor
-------------------
+Initialize DDS Monitor
+----------------------
 
 Button to start monitoring a new DDS network.
 The entities of this network will be automatically discovered.
 Moreover, their connections, their configuration and statistical data reported by them will be built and
 displayed on the monitor for further user queries.
 
-Section :ref:`monitor_domain` contains all the definitions and explanation about what monitor a domain means in the
+Section :ref:`monitor_domain` contains all the definitions and explanation about what monitoring a domain means in the
 context of the application.
 
-Pressing this button, a new Dialog with two tabs will be displayed.
-Each tab allows to start a monitor in a DDS network deployed using the Simple Discovery Protocol (SDP)
-or the Fast DDS Discovery Server (DS).
+Pressing this button, a new Dialog will be displayed requesting the user to introduce a number between 0 and 200, 
+which will be the DDS Domain number. This will start a monitor in a specific DDS domain.
+The entities in this domain will be automatically discovered.
 
 .. warning::
-    Starting a monitor in a domain or *Discovery Server* already initialize will duplicate the entities in them
-    and may lead to an undefined behavior.
+    Starting a monitor in a Domain already initialized will prompt an error message,
+    and create an issue that can be found in :ref:`issues_panel`. Selecting ``Retry`` allows the user to select
+    a different Domain.
 
-Simple Discovery
-^^^^^^^^^^^^^^^^
-This dialog requests the user to introduce a number between 0 and 200 which will be the DDS Domain number.
-This will start a monitor in a specific DDS domain.
-The entities in this domain will be automatically discovered.
+Initialize Discovery Server Monitor
+-----------------------------------
+
+Button to start monitoring a new DDS network.
+The entities of this network will be automatically discovered.
+Moreover, their connections, their configuration and statistical data reported by them will be built and
+displayed on the monitor for further user queries.
 
-Discovery Server
-^^^^^^^^^^^^^^^^
-This dialog requests the user to introduce a list of network addresses in a specific string format to connect with one
-or more *Fast DDS Discovery Servers*.
+Section :ref:`monitor_domain` contains all the definitions and explanation about what monitoring a domain means in the
+context of the application.
+
+Pressing this button, a new Dialog will be displayed requesting the user to introduce a list of network addresses in
+a specific string format to connect with one or more *Fast DDS Discovery Servers*.
 This string must contain the IP-port pair where the Discovery Server is listening in the format ``ip:port``
 separated by ``;``.
 
 This will connect the *Fast DDS Monitor* to the Discovery Servers listening on the addresses set,
 and it will get all the discovery information of the entities connecting through them.
 
+.. warning::
+    Starting a monitor in a *Discovery Server* already initialized will prompt an error message,
+    and create an issue that can be found in :ref:`issues_panel`. Selecting ``Retry`` allows the user to select
+    a different *Discovery Server*.
 
-Export to CSV
--------------
+Export Charts to CSV
+--------------------
 
 Export all the data displayed in the current Fast DDS Monitor session to a CSV file.
 Please refer to section :ref:`export_data` for more information on the format of the generated CSV file.
@@ -86,22 +94,22 @@ Edit
 
 Display Historical Data
 -----------------------
-Create a new historic *Chartbox* in the central panel.
+Create a new historic *Chartbox* in the :ref:`chart_panel_index`.
 To know how to configure a historic *Chartbox*, please refer to the section :ref:`historic_series`.
 
 .. _display_dynamic_data_button:
 
-Display Dynamic Data
+Display Real-Time Data
 --------------------
-Create a new dynamic *Chartbox* in the central panel.
+Create a new dynamic *Chartbox* in the :ref:`chart_panel_index`.
 To know how to configure a dynamic *Chartbox*, please refer to the section :ref:`dynamic_series`.
 
 .. _clear_inactive_entities:
 
 Delete inactive entities
 ------------------------
 
-This button remove all the inactive entities from the database.
+This button removes all the inactive entities from the database.
 
 .. _delete_statistics_data:
 
@@ -115,8 +123,8 @@ This button clear the statistics data of all the entities.
 Scheduler Configuration
 -----------------------
 
-Creates a schedule to dump the database to a file, remove old data and/or remove inactive entities at
-a specified interval.
+Prompts a dialogue box allowing to create a schedule to dump the database to a file, remove old data and/or remove
+inactive entities at a specified interval.
 
 .. _refresh_button:
 
@@ -154,13 +162,13 @@ Hide/Show Metatraffic
 Entities utilized for sharing metatraffic data are not shown by default.
 These include Fast-DDS Statistics module topics and the ones used by ROS for metatraffic data exchange, as well as the
 endpoints to which these topics are bound.
-Same as with the hide/show inactive entities feature, when metatraffic entities are hidden they are no longer available
+As with the hide/show inactive entities feature, when metatraffic entities are hidden they are no longer available
 in the whole application framework.
 This button displays/hides the metatraffic entities detected by the monitor.
 
 Dashboard Layout
 ----------------
-Changes the size of the chart boxes displayed in the main panel of the application.
+Changes the size of the chart boxes displayed in the :ref:`chart_panel_index` of the application.
 Three mutually exclusive layout options are defined and explained below.
 
  * |dashboard_layout_1| **Large**: A single full-screen chart is displayed.
@@ -173,12 +181,16 @@ Hide the shortcuts superior toolbar if visible, or reveal it otherwise.
 
 Customize Shortcuts Toolbar
 ---------------------------
-Allow to show or hide independently the shortcut buttons in the shortcut toolbar.
+Allows to show or hide independently the shortcut buttons in the shortcut toolbar.
 
 Hide/Show Left sidebar
 ----------------------
 Hide the left sidebar if visible, or reveal it otherwise.
 
+Customize Left sidebar
+----------------------
+Allows to show or hide independently the different panels in the :ref:`left_panel`.
+
 Help
 ====
 
@@ -203,7 +215,7 @@ Link to the `Issues`_ section of the `GitHub Fast DDS Monitor repository`_.
 
 Report Issue
 ------------
-Link to the `Issues`_ section of the `GitHub Fast DDS Monitor repository`_.
+Link to create a new Issue in the `Issues`_ section of the `GitHub Fast DDS Monitor repository`_.
 
 .. todo::
     Explain the form to add an issue.

docs/rst/user_manual/layout.rst

@@ -10,7 +10,7 @@ It will briefly explain the main menus and windows that could be seen, in order
 with where to find the buttons and information.
 Below is a screenshot of the *Fast DDS Monitor* application in operation.
 
-.. figure:: /rst/figures/screenshots/App-run.png
+.. figure:: /rst/figures/screenshots/App_run.png
     :align: center
 
 .. _application_menu_layout:
@@ -154,8 +154,8 @@ Monitor Status Panel
 ====================
 
 In this panel, different data related to the entities being monitored or the current state of the application
-will be displayed. This panel contains two different subpanels, the :ref:`status_panel_layout` and the :ref:`log_panel_layout`.
-To change from one another, press on the name of the subpanel to be displayed.
+will be displayed. This panel contains two different subpanels, the :ref:`status_panel_layout` and the
+:ref:`log_panel_layout`. To change from one another, press on the name of the subpanel to be displayed.
 
 To increase or decrease this sidebar size, grab the border of it and move it to the desired size.
 In order to hide the whole left sidebar, click *Hide Left sidebar* in the *View* menu.
@@ -236,8 +236,8 @@ To create a new *Chartbox* go to *Chart View* in the Main Panel default tab, and
 This button will create a new *Chartbox* where new series could be added, removed or modified.
 
 These *Chartboxes* can be moved along the *Chart View* tab.
-In order to move one of these charts, click on the *Chartbox* title and grab the object to its new desired location inside the
-main panel.
+In order to move one of these charts, click on the *Chartbox* title and grab the object to its new desired location
+inside the main panel.
 The rest of the *Chartboxes* will automatically rearrange when one of them is moved to a different position.
 
 .. figure:: /rst/figures/screenshots/chartbox.png