Change project and product name in Documentation (#40)

* Refs #15089, #15090: Alias and naming convention Signed-off-by: Anton Rey <[email protected]> * Refs #15090: Win installation screenshots and opengl troubleshooting Signed-off-by: Anton Rey <[email protected]> * Refs #15090: Uncomment figure blocks Signed-off-by: Anton Rey <[email protected]> * Refs #15089: Linux install figure Signed-off-by: Anton Rey <[email protected]> * Refs #15105: refactor aliases Signed-off-by: jparisu <[email protected]> * Refs #15105: Final touches Signed-off-by: jparisu <[email protected]> Co-authored-by: Anton Rey <[email protected]>
eProsima · Jul 8, 2022 · fa894ab · fa894ab
1 parent 29327e3
commit fa894ab
Show file tree

Hide file tree

Showing 22 changed files with 158 additions and 124 deletions.
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -1,19 +1,19 @@
 # Copyright 2022 Proyectos y Sistemas de Mantenimiento SL (eProsima).
 #
-# This file is part of eProsima DDS Visualizer Plugin.
+# This file is part of eProsima Fast DDS Visualizer Plugin.
 #
-# eProsima DDS Visualizer Plugin is free software: you can redistribute it and/or modify
+# eProsima Fast DDS Visualizer Plugin is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# eProsima DDS Visualizer Plugin is distributed in the hope that it will be useful,
+# eProsima Fast DDS Visualizer Plugin is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with eProsima DDS Visualizer Plugin. If not, see <https://www.gnu.org/licenses/>.
+# along with eProsima Fast DDS Visualizer Plugin. If not, see <https://www.gnu.org/licenses/>.
 
 ###############################################################################
 # CMake build rules for DDS Visualizer Plugin Documentation
@@ -38,11 +38,11 @@ set(PROJECT_VERSION_MINOR "${PRODUCT_MINOR_VERSION}")
 set(PROJECT_VERSION_PATCH "${PRODUCT_PATCH_VERSION}")
 set(PROJECT_VERSION "${PRODUCT_VERSION_STR}")
 
-set(PROJECT_NAME_LARGE "DDS Visualizer Plugin Documentation")
+set(PROJECT_NAME_LARGE "Fast DDS Visualizer Plugin Documentation")
 string(TOUPPER "${PROJECT_NAME}" PROJECT_NAME_UPPER)
-set(${PROJECT_NAME}_DESCRIPTION_SUMMARY "ReadTheDocs documentation of DDS Visualizer Plugin")
+set(${PROJECT_NAME}_DESCRIPTION_SUMMARY "ReadTheDocs documentation of Fast DDS Visualizer Plugin")
 set(${PROJECT_NAME}_DESCRIPTION
-    "ReadTheDocs documentation of DDS Visualizer Plugin")
+    "ReadTheDocs documentation of Fast DDS Visualizer Plugin")
 
 message(STATUS "Configuring ${PROJECT_NAME_LARGE}")
 message(STATUS "Version: ${PROJECT_VERSION}")
@@ -88,16 +88,16 @@ install(DIRECTORY ${DOCS_OUTPUT_HTML_DIR}
     DESTINATION docs/${PROJECT_NAME}/sphinx
     COMPONENT monitor-sphinx
     PATTERN ".buildinfo" EXCLUDE)
-set(CPACK_COMPONENT_monitor-sphinx_DISPLAY_NAME "DDS Visualizer Plugin Sphinx")
+set(CPACK_COMPONENT_monitor-sphinx_DISPLAY_NAME "Fast DDS Visualizer Plugin Sphinx")
 set(CPACK_COMPONENT_monitor-sphinx_DESCRIPTION
-    "eProsima DDS Visualizer Plugin documentation in ${DOCS_BUILDER} format")
+    "eProsima Fast Fast DDS Visualizer Plugin documentation in ${DOCS_BUILDER} format")
 set(CPACK_COMPONENTS_ALL ${CPACK_COMPONENTS_ALL} ${DOCS_BUILDER})
 
 
 ###############################################################################
 # Test
 ###############################################################################
-option(BUILD_DOCUMENTATION_TESTS "Build DDS Visualizer Plugin documentation tests" OFF)
+option(BUILD_DOCUMENTATION_TESTS "Build Fast DDS Visualizer Plugin documentation tests" OFF)
 
 if (BUILD_TESTS)
     set(BUILD_DOCUMENTATION_TESTS ON)

diff --git a/docs/cmake/modules/FindSphinx.cmake b/docs/cmake/modules/FindSphinx.cmake
@@ -1,19 +1,19 @@
 # Copyright 2022 Proyectos y Sistemas de Mantenimiento SL (eProsima).
 #
-# This file is part of eProsima DDS Visualizer Plugin.
+# This file is part of eProsima Fast DDS Visualizer Plugin.
 #
-# eProsima DDS Visualizer Plugin is free software: you can redistribute it and/or modify
+# eProsima Fast DDS Visualizer Plugin is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# eProsima DDS Visualizer Plugin is distributed in the hope that it will be useful,
+# eProsima Fast DDS Visualizer Plugin is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with eProsima DDS Visualizer Plugin. If not, see <https://www.gnu.org/licenses/>.
+# along with eProsima Fast DDS Visualizer Plugin. If not, see <https://www.gnu.org/licenses/>.
 
 # Look for an executable called sphinx-build
 find_program(SPHINX_EXECUTABLE

diff --git a/docs/conf.py b/docs/conf.py
@@ -169,7 +169,7 @@ def select_css(html_css_dir):
 master_doc = 'index'
 
 # General information about the project.
-project = u'DDS Visualizer Plugin'
+project = u'Fast DDS Visualizer Plugin'
 copyright = u'2021, eProsima'
 author = u'eProsima'
 
@@ -397,7 +397,7 @@ def select_css(html_css_dir):
 latex_documents = [
     (master_doc,
      'dds_visualizer_plugin.tex',
-     u'DDS Visualizer Plugin Documentation',
+     u'Fast DDS Visualizer Plugin Documentation',
      u'eProsima',
      'manual'),
 ]
@@ -441,8 +441,8 @@ def select_css(html_css_dir):
 # (source start file, name, description, authors, manual section).
 man_pages = [
     (master_doc,
-     'DDS Visualizer Plugin',
-     u'DDS Visualizer Plugin Documentation',
+     'Fast DDS Visualizer Plugin',
+     u'Fast DDS Visualizer Plugin Documentation',
      [author],
      1)
 ]
@@ -459,11 +459,11 @@ def select_css(html_css_dir):
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc,
-     'DDS Visualizer Plugin',
-     u'DDS Visualizer Plugin Documentation',
+     'Fast DDS Visualizer Plugin',
+     u'Fast DDS Visualizer Plugin Documentation',
      author,
-     'DDS Visualizer Plugin',
-     'Documentation of eProsima DDS Visualizer Plugin',
+     'Fast DDS Visualizer Plugin',
+     'Documentation of eProsima Fast DDS Visualizer Plugin',
      'Miscellaneous'),
 ]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,4 @@
-.. eProsima DDS Visualizer Plugin documentation master file.
+.. eProsima Fast DDS Visualizer Plugin documentation master file.
 
 .. include:: titlepage.rst
 

diff --git a/docs/rst/dds_suite/dds_suite.rst b/docs/rst/dds_suite/dds_suite.rst
@@ -3,12 +3,13 @@
 
 .. _dds_suite:
 
-###########################################
-DDS Visualizer Plugin within Fast DDS Suite
-###########################################
+##################################################
+PlotJuggler eProsima Edition within Fast DDS Suite
+##################################################
 
-eProsima provides the eProsima |suite| Docker image for those who want a quick demonstration of Fast DDS running on an Ubuntu
-platform. It can be downloaded from `eProsima's downloads page <https://eprosima.com/index.php/downloads-all>`_.
+eProsima provides the |esuite| Docker image for those who want a quick demonstration of Fast DDS running on an Ubuntu
+platform.
+It can be downloaded from |edownloads|.
 
 #.  This Docker image was built for Ubuntu 20.04 (Focal Fossa).
 
@@ -21,8 +22,7 @@ platform. It can be downloaded from `eProsima's downloads page <https://eprosima
     |br|
 
 
-#.  Download the compressed Docker image in ``.tar`` format from the
-    `eProsima Downloads website <https://www.eprosima.com/index.php/downloads-all>`_.
+#.  Download the compressed Docker image in ``.tar`` format from the |edownloads|.
     It is strongly recommended to download the image corresponding to the latest version of |suite|.
 
     |br|

diff --git a/docs/rst/dds_suite/suite_demo.rst b/docs/rst/dds_suite/suite_demo.rst
@@ -4,14 +4,14 @@
 
 .. _fast_dds_suite_dds_visualizer:
 
-DDS Visualizer Plugin
-=====================
+PlotJuggler eProsima Edition
+============================
 
 To launch the |ddsvisualizer|, from a terminal run
 
 .. code-block:: bash
 
- $ dds_visualization
+ $ plotjuggler
 
 
 Other eProsima applications

diff --git a/docs/rst/developer_manual/installation/sources/linux.rst b/docs/rst/developer_manual/installation/sources/linux.rst
@@ -6,7 +6,7 @@
 Linux installation from sources
 ###############################
 
-The instructions for installing the *eProsima DDS Visualizer Plugin application* from sources and the required
+The instructions for installing the |eplotjuggler| from sources and the required
 `Qt` installation are provided in this page.
 It is organized as follows:
 
@@ -20,8 +20,8 @@ It is organized as follows:
 Dependencies installation
 =========================
 
-*DDS Visualizer Plugin* depends on *eProsima Fast DDS* library, Qt, PlotJuggler, and certain Debian packages.
-This section describes the instructions for installing *eProsima Fast DDS* dependencies and requirements in a Linux
+|eplotjuggler| depends on |efastdds| library, Qt, |plotjuggler|, and certain Debian packages.
+This section describes the instructions for installing |efastdds| dependencies and requirements in a Linux
 environment from sources.
 The following packages will be installed:
 
@@ -39,7 +39,7 @@ Afterwards, the user can choose whether to follow either the :ref:`colcon <colco
 Requirements
 ------------
 
-The installation of *eProsima Fast DDS* in a Linux environment from binaries requires the following tools to be
+The installation of |efastdds| in a Linux environment from binaries requires the following tools to be
 installed in the system:
 
 * :ref:`cmake_gcc_pip_wget_git_sl`
@@ -52,7 +52,7 @@ installed in the system:
 CMake, g++, pip, wget and git
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-These packages provide the tools required to install *eProsima Fast DDS* and its dependencies from command line.
+These packages provide the tools required to install |efastdds| and its dependencies from command line.
 Install CMake_, `g++ <https://gcc.gnu.org/>`_, pip_, wget_ and git_ using the package manager of the appropriate
 Linux distribution. For example, on Ubuntu use the command:
 
@@ -84,7 +84,7 @@ Gtest
 ^^^^^
 
 Gtest is a unit testing library for C++.
-By default, *eProsima DDS Visualizer Plugin* does not compile tests.
+By default, |eplotjuggler| does not compile tests.
 It is possible to activate them with the opportune
 `CMake options <https://colcon.readthedocs.io/en/released/reference/verb/build.html#cmake-options>`_
 when calling colcon_ or CMake_.
@@ -97,7 +97,7 @@ For a detailed description of the Gtest installation process, please refer to th
 Dependencies
 ------------
 
-*eProsima DDS Visualizer Plugin* has the following dependencies, when installed from sources in a Linux environment:
+|eplotjuggler| has the following dependencies, when installed from sources in a Linux environment:
 
 * :ref:`asiotinyxml2_sl`
 * :ref:`openssl_sl`
@@ -137,22 +137,22 @@ For example, on Ubuntu use the command:
 eProsima dependencies
 ^^^^^^^^^^^^^^^^^^^^^
 
-If it already exists in the system an installation of *Fast DDS* library with version greater than `2.7.0`,
-just source this library when building the *DDS Visualizer Plugin* by using the command:
+If it already exists in the system an installation of |fastdds| library,
+just source this library when building the |eplotjuggler| by using the command:
 
 .. code-block:: bash
 
     source <fastdds-installation-path>/install/setup.bash
 
-In other case, just download *Fast DDS* project from sources and build it together with *DDS Visualizer Plugin*
+In other case, just download |fastdds| project from sources and build it together with |eplotjuggler|
 using colcon as it is explained in section :ref:`colcon_installation`.
 
 .. _qt_installation:
 
 Qt 5.15
 ^^^^^^^
 
-Qt 5.15 is needed in order to build *DDS Visualizer Plugin*.
+Qt 5.15 is needed in order to build |eplotjuggler|.
 To install this Qt version, refer to `Qt Downloads <https://www.qt.io/download>`_ website.
 
 .. note::
@@ -166,7 +166,7 @@ Colcon installation
 ===================
 
 #.  Create a :code:`DDS-Visualizer-Plugin` directory and download the :code:`.repos` file that will be used to install
-    *eProsima DDS Visualizer Plugin* and its dependencies:
+    |eplotjuggler| and its dependencies:
 
     .. code-block:: bash
 
@@ -177,11 +177,11 @@ Colcon installation
 
     .. note::
 
-        In case there is an already *Fast DDS* and/or *PlotJuggler* installation in the system, it is
+        In case there is an already |fastdds| and/or *PlotJuggler* installation in the system, it is
         not required to download and build every dependency in the :code:`.repos` file.
-        It is just needed to download and build the *DDS Visualizer Plugin* project having sourced its dependencies.
+        It is just needed to download and build the |eplotjuggler| project having sourced its dependencies.
         Refer to section :ref:`eprosima_dependencies` in order to check how
-        to source *Fast DDS* and *PlotJuggler*, respectively.
+        to source |fastdds| and *PlotJuggler*, respectively.
 
 #.  Build the packages:
 
@@ -208,15 +208,15 @@ Colcon installation
 CMake installation
 ==================
 
-This section explains how to compile *eProsima DDS Visualizer Plugin* with CMake_, either
+This section explains how to compile |eplotjuggler| with CMake_, either
 :ref:`locally <local_installation_sl>` or :ref:`globally <global_installation_sl>`.
 
 .. _local_installation_sl:
 
 Local installation
 ------------------
 
-#.  Create a :code:`Fast-DDS` directory where to download and build *eProsima DDS Visualizer Plugin* and its dependencies:
+#.  Create a :code:`Fast-DDS` directory where to download and build |eplotjuggler| and its dependencies:
 
     .. code-block:: bash
 
@@ -270,7 +270,7 @@ Local installation
 
 
 
-#.  Once all dependencies are installed, install *eProsima DDS Visualizer Plugin*:
+#.  Once all dependencies are installed, install |eplotjuggler|:
 
     .. code-block:: bash
 
@@ -285,7 +285,7 @@ Local installation
 
     .. note::
 
-        By default, *eProsima DDS Visualizer Plugin* does not compile tests.
+        By default, |eplotjuggler| does not compile tests.
         However, they can be activated by downloading and installing `Gtest <https://github.com/google/googletest>`_
         and building with CMake option ``-DBUILD_TESTS=ON``.
 
@@ -307,7 +307,7 @@ Local installation
 Global installation
 -------------------
 
-To install *eProsima Fast DDS* system-wide instead of locally, remove all the flags that
+To install |efastdds| system-wide instead of locally, remove all the flags that
 appear in the configuration steps of :code:`Fast-CDR`, :code:`Fast-DDS`, and
 :code:`DDS-Visualizer-Plugin`, and change the first in the configuration step of :code:`foonathan_memory_vendor` to the
 following:
@@ -322,8 +322,8 @@ following:
 Run an application
 ==================
 
-To run the *eProsima DDS Visualizer Plugin* application, do not forget to source
-the *Fast DDS* libraries if installed from *colcon*, or extend :code:`LD_LIBRARY_PATH`
+To run the |eplotjuggler| application, do not forget to source
+the |fastdds| libraries if installed from *colcon*, or extend :code:`LD_LIBRARY_PATH`
 and :code:`PATH` environment variables if *CMake* installation was used.
 Then execute `plotjuggler`:
 
@@ -346,10 +346,10 @@ Then execute `plotjuggler`:
 Source Plugin
 -------------
 
-In case the |ddsvisualizer| binary compiled :code:`libfastdds_visualizer_plugin_datastream_plugin.so` is not in the same
-folder than the |plotjuggler| executable :code:`plotjuggler`, the plugin will not be automatically loaded.
+In case the |eplotjuggler| binary compiled :code:`libfastdds_visualizer_plugin_datastream_plugin.so` is not in the same
+folder than the |eplotjuggler| executable :code:`plotjuggler`, the plugin will not be automatically loaded.
 For this purpose, the user must add the binary path in the application.
-Once running the |plotjuggler| executable, go to *App -> Preferences -> Plugins* and add the folder path that contains
+Once running the |eplotjuggler| executable, go to *App -> Preferences -> Plugins* and add the folder path that contains
 the binary of the plugin :code:`libfastdds_visualizer_plugin_datastream_plugin.so`.
 In case of colcon installation, this folder is :code:`<workspace_path>/install/fastdds_visualizer_plugin/bin`.
 

diff --git a/docs/rst/exports/alias.include b/docs/rst/exports/alias.include
@@ -1,6 +1,13 @@
-.. |FastDDSDocs| replace:: `Fast DDS Documentation <https://fast-dds.docs.eprosima.com/en/v2.3.0/>`__
-.. |DDSSpecification| replace:: `DDS specification <https://www.omg.org/spec/DDS/1.4/About-DDS/>`__
-.. |ddsvisualizer| replace:: *DDS Visualizer Plugin*
-.. |fastdds| replace:: *Fast DDS*
-.. |plotjuggler| replace:: *PlotJuggler*
-.. |suite| replace:: *Fast DDS Suite*
+.. |FastDDSDocs|        replace:: `Fast DDS Documentation <https://fast-dds.docs.eprosima.com/en/v2.3.0/>`__
+.. |DDSSpecification|   replace:: `DDS specification <https://www.omg.org/spec/DDS/1.4/About-DDS/>`__
+.. |edownloads|         replace:: `eProsima's downloads page <https://eprosima.com/index.php/downloads-all>`__
+
+.. |ddsvisualizer|      replace:: *Fast DDS Visualizer Plugin*
+.. |fastdds|            replace:: *Fast DDS*
+.. |plotjuggler|        replace:: *PlotJuggler*
+.. |suite|              replace:: *Fast DDS Suite*
+
+.. |eddsvisualizer|     replace:: *eProsima Fast DDS Visualizer Plugin*
+.. |efastdds|           replace:: *eProsima Fast DDS*
+.. |eplotjuggler|       replace:: *PlotJuggler eProsima Edition*
+.. |esuite|             replace:: *eProsima Fast DDS Suite*
diff --git a/docs/rst/figures/black_screen_windows.png b/docs/rst/figures/black_screen_windows.png
diff --git a/docs/rst/figures/black_screen_windows_disable_opengl.png b/docs/rst/figures/black_screen_windows_disable_opengl.png
diff --git a/docs/rst/figures/black_screen_windows_preferences.png b/docs/rst/figures/black_screen_windows_preferences.png
diff --git a/docs/rst/figures/linux_installer.png b/docs/rst/figures/linux_installer.png
diff --git a/docs/rst/figures/windows_installer.png b/docs/rst/figures/windows_installer.png
diff --git a/docs/rst/figures/windows_installer_run.png b/docs/rst/figures/windows_installer_run.png