updated docs (#1677)

* restructured headings

moved some sections

* copyright time adjusted

* none existing image removed

docs/components.rst

@@ -2,7 +2,7 @@ Components
 ==========
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 4
 
    usage
    plugins

docs/conf.py

@@ -108,7 +108,7 @@
 # General information about the project.
 project = 'MSS - Mission Support System'
 copyright = \
-    '2016-2022 see AUTHORS file, ' \
+    '2016-2023 by the MSS team, see AUTHORS, ' \
     '2011-2014 Marc Rautenhaus, ' \
     '2008-2014 Deutsches Zentrum fuer Luft- und Raumfahrt e.V., '
 
@@ -141,7 +141,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

docs/development.rst

@@ -154,7 +154,7 @@ Setup mswms server
 In the mss package is some demodata included. The default where this is stored is $HOME/mss. Your clone of the
 MSS repository needs a different folder, e.g. workspace/mss. Avoid to mix data and source.
 
-:ref:`demodata` is provided by executing::
+:ref:`demodata <demodata>` is provided by executing::
 
    $(mssdev) python mslib/mswms/demodata.py --seed
 
@@ -202,7 +202,7 @@ in a /tmp/mss* folder. If you have installed gitpython a postfix of the revision
 
 
 Setup msui_settings.json for special tests
-+++++++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++++++++
 
 On default all tests use default configuration defined in mslib.msui.MissionSupportSystemDefaultConfig.
 If you want to overwrite this setup and try out a special configuration add an msui_settings.json

docs/gentutorials.rst

@@ -1,4 +1,3 @@
-==============================================================================
 A user guide for tool chain of automated tutorials for the MSUI user interface
 ==============================================================================
 
@@ -39,7 +38,7 @@ Other important files with their functions are as follows:
 * audio.py which translates and converts into speech the texts and saves them as .mp3 files.
 
 System Requirements
-===================
+-------------------
 Keep the following things in mind before running a script
 
 * You should have only an **US keyboard layout**. If you have a different keyboard layout, you just need to change it to
@@ -55,8 +54,8 @@ Keep the following things in mind before running a script
   to run successfully! It has a #ToDo to read.
 
 
-Getting Started..
-=================
+Getting Started
+---------------
 
 On the Anaconda terminal, type the following ::
 
@@ -112,7 +111,7 @@ When you have to stop just open that terminal again and type **CTRL + C**
 For more details in its customization, you can visit https://github.com/swillner/highlight-pointer
 
 The Running of the Scripts
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------
 Each python file inside MSS/tutorials can be run directly like ::
 
 (mssdev)~/..MSS/tutorials/ $ python screenrecorder.py
@@ -146,7 +145,8 @@ record a particular area of screen, just pass the below parameters.
 The top left corner is (0,0) and the width for eg is 1920 and the height for eg is 1080 of my screen.
 
 Knowing MouseInfo()
-~~~~~~~~~~~~~~~~~~~
+...................
+
 For deciding the pixels, or know how  much length or height i should go down or what is the relative distance of one
 point from the other, pyautogui's mouseInfo() comes to the rescue ::
 
@@ -162,7 +162,8 @@ This will open a window which will be very helpful in development and other pixe
   improvement. Kindly report that bug or discrepancies to https://github.com/Open-MSS/MSS/issues/new
 
 Videos post processing via ffmpeg
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.................................
+
 The post processing of the videos can be done using ffmpeg in Command Line Interface.
 
 The generated video size is too large, so if you want to reduce the size, you can ::

docs/installation.rst

@@ -2,9 +2,6 @@ Installation
 =================
 
 
-.. image:: https://anaconda.org/conda-forge/mss/badges/installer/conda.svg
-
-
 `Anaconda <https://www.anaconda.com/>`_ provides an enterprise-ready data analytics
 platform that empowers companies to adopt a modern open data science analytics architecture.
 

docs/mscolab.rst

@@ -7,7 +7,7 @@ chat-messages, keeping track of the made changes, permissions of the collaborato
 .. _mscolab:
 
 Configuring Your MSColab Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------
 The mscolab server comes with a default configuration, built on top of :code:`sqlite3`. One can override these settings by making a copy
 of the following file in a location in :code:`$PYTHONPATH`.
 
@@ -20,109 +20,25 @@ Description of the variables can be found in comments.
 .. _configuration-mscolab:
 
 Protecting Login
-~~~~~~~~~~~~~~~~
+................
 The login to the MSColab server can be protected by an additional auth method.
 
  .. literalinclude:: samples/config/mscolab/mscolab_auth.py.sample
 
 Make a copy of the above file, rename it to mscolab_auth.py, make the necessary changes in the file and add it to your $PYTHONPATH.
 
 Steps to Run MSColab Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------
   - The MSColab server comes included in the MSS python package.
   - Once MSS is installed, if you're running the mscolab server for the first time, run the command :code:`mscolab db --init` to initialise your database.
   - To start the server run :code:`mscolab start`.
   - If you ever want to reset or add dummy data to your database you can use the commands :code:`mscolab db --reset` and :code:`mscolab db --seed` respectively.
 
 
-Steps to Open the MSColab Application Window
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  To open the mscolab window in the application select the `Operation` option from the menu bar of Mission Support System's main window.
-
-
-User based features
-~~~~~~~~~~~~~~~~~~~
-  - A user can register and login.
-  - A user can also delete his/her account.
-
-Operation based features
-~~~~~~~~~~~~~~~~~~~~~~
-  - In MSColab, each flight track is referred to as an operation.
-  - An operation can be created by a user, once he/she has logged in.
-  - The users can either select a starting FTML file while creating the operation or can later import a FTML file to the operation.
-  - All the operations the user has created or has been added to can be found in Mscolab's main window along with the user's access level.
-  - To start working on an operation the user needs to select it which enables all the operation related buttons.
-  - Any change made to an operation by a user will be shared with everyone in real-time unless `Work Locally` is turned on.(More on this later)
-
-Operation Permissions
-~~~~~~~~~~~~~~~~~~~~
-There are 4 different access levels of user:
-
-
-  - **Creator**
-
-    Creator is the user who creates the operation, they have all the rights which ‘admins’ have.
-    Additionally, they can delete the operation, make administrators and revoke administrators’ status.
-
-  - **Admins**
-
-    Admins can add users to the operation and can update their access levels. They can also view the version history of the operation and revert to a previous version if need arises.
-    They have all the capabilities of a collaborator.
-
-  - **Collaborators**
-
-    Collaborators can make changes to the operation and have access to the chat room. Additionally, they can view the version history of the operation.
-
-  - **Viewer**
-
-    Viewers can only view the flight track and have the least amount of access.
-
-All the changes to users’ permission are in real-time.
-
-
-Adding Users To Your Operation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To add users to a operation, you need to be the admin or creator of that operation. Select the desired operation and click on the `Manage Users` button in Mscolab's main window.
-An admin window will open where you can manage the permission of all the users in bulk by selecting multiple users at once and add, updating or deleting their access to the operation.
-If you have another operation and want to have the same users as on that operation you can use the `Clone Permissions` option in the admin window to quickly add all the users of a operation to your selected one.
-
-
-Chatting With Operation Members
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If a user has the permission of collaborator or above, they can use the chat window in Mscolab. You can send normal text messages or use markdown to format them.
-The currently supported markdown syntax is:
-
-- # : Headings
-- \*\*text\*\* : Bold text
-- \*text\* : Italicise Text
-- [text](link) : Add hyper-link to text
-
-You can use the `Preview` button to see how your text is formatted before sending it.
-
-There is also support for image/document upload. You can set the upload size limit in the mscolab_settings.py file. The default limit is 2 MBs.
-
-Right-clicking on a message would open a context-menu giving you options to copy, edit, delete or reply to a message.
-
-
-Managing Operation Versions
-~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have the access level of collaborator or higher to a operation you can view all the change history of the operation by clicking on the `Version History` button in Mscolab's main window.
-A new version history window will be opened where you can view all the changes made to the operation and compare them with the current flight track by selecting a previous version.
-You can also set names to important versions to keep track of all the important milestones.
-
-
-Working Locally on an Operation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you want to try out your changes on a operation without disturbing the common shared file. You can use the `Work Locally` toggle in the Mscolab main window.
-You can turn that toggle on at any time which would send you into local work mode. In this mode you will have a copy of the operation on your system and all your changes will be made to this file.
-Once you're done with all your local work and think you're ready to push your changes to everyone, you can use the `Save to Server` button.
-This would prompt you with a dialog where you can compare your local flight track and the common flight track on the server and select what you would like to keep.
-You can also fetch the common flight track to your local file at any time using the `Fetch from Server` button which prompts you with a similar dialog.
-You can turn the `Work Locally` toggle off at any points and work on the common shared file on the server. All your local changes are saved and you can return to them at any point by toggling the checkbox back on.
-
 
 Notes for server administrators
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------
+
 If you're configuring mscolab server, there is a manage users GUI to add or manage users to a operation.
 There is a command line tool available with the installation of mss, :code:`mscolab`. It can import users to the database
 and can handle joins to operations.
@@ -157,6 +73,7 @@ After executed you get informations to exchange with users.
 
 Further options can be listed by `mscolab db -h`
 
+
 user verification by email
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -291,3 +208,100 @@ The changed entries look like (seperator is a TAB Key) ::
 
 
 For trying an updated version we suggest to use the command `psql -v ON_ERROR_STOP=1 < new_db.sql`
+
+
+Steps to use the MSColab UI features
+------------------------------------
+
+To get access to the mscolab feature click Connect.
+
+
+User based features
+....................
+  - A user can register and login.
+  - A user can also delete his/her account.
+
+Operation based features
+........................
+
+  - In MSColab, each flight track is referred to as an operation.
+  - An operation can be created by a user, once he/she has logged in.
+  - The users can either select a starting FTML file while creating the operation or can later import a FTML file to the operation.
+  - All the operations the user has created or has been added to can be found in Mscolab's main window along with the user's access level.
+  - To start working on an operation the user needs to select it which enables all the operation related buttons.
+  - Any change made to an operation by a user will be shared with everyone in real-time unless `Work Locally` is turned on.(More on this later)
+
+Operation Permissions
+.....................
+
+There are 4 different access levels of user:
+
+
+  - **Creator**
+
+    Creator is the user who creates the operation, they have all the rights which ‘admins’ have.
+    Additionally, they can delete the operation, make administrators and revoke administrators’ status.
+
+  - **Admins**
+
+    Admins can add users to the operation and can update their access levels. They can also view the version history of the operation and revert to a previous version if need arises.
+    They have all the capabilities of a collaborator.
+
+  - **Collaborators**
+
+    Collaborators can make changes to the operation and have access to the chat room. Additionally, they can view the version history of the operation.
+
+  - **Viewer**
+
+    Viewers can only view the flight track and have the least amount of access.
+
+All the changes to users’ permission are in real-time.
+
+
+Adding Users To Your Operation
+..............................
+
+To add users to a operation, you need to be the admin or creator of that operation. Select the desired operation and click on the `Manage Users` button in Mscolab's main window.
+An admin window will open where you can manage the permission of all the users in bulk by selecting multiple users at once and add, updating or deleting their access to the operation.
+If you have another operation and want to have the same users as on that operation you can use the `Clone Permissions` option in the admin window to quickly add all the users of a operation to your selected one.
+
+
+Chatting With Operation Members
+...............................
+
+If a user has the permission of collaborator or above, they can use the chat window in Mscolab. You can send normal text messages or use markdown to format them.
+The currently supported markdown syntax is:
+
+- # : Headings
+- \*\*text\*\* : Bold text
+- \*text\* : Italicise Text
+- [text](link) : Add hyper-link to text
+
+You can use the `Preview` button to see how your text is formatted before sending it.
+
+There is also support for image/document upload. You can set the upload size limit in the mscolab_settings.py file. The default limit is 2 MBs.
+
+Right-clicking on a message would open a context-menu giving you options to copy, edit, delete or reply to a message.
+
+
+Managing Operation Versions
+...........................
+
+If you have the access level of collaborator or higher to a operation you can view all the change history of the operation by clicking on the `Version History` button in Mscolab's main window.
+A new version history window will be opened where you can view all the changes made to the operation and compare them with the current flight track by selecting a previous version.
+You can also set names to important versions to keep track of all the important milestones.
+
+
+Working Locally on an Operation
+...............................
+
+If you want to try out your changes on a operation without disturbing the common shared file. You can use the `Work Locally` toggle in the Mscolab main window.
+You can turn that toggle on at any time which would send you into local work mode. In this mode you will have a copy of the operation on your system and all your changes will be made to this file.
+Once you're done with all your local work and think you're ready to push your changes to everyone, you can use the `Save to Server` button.
+This would prompt you with a dialog where you can compare your local flight track and the common flight track on the server and select what you would like to keep.
+You can also fetch the common flight track to your local file at any time using the `Fetch from Server` button which prompts you with a similar dialog.
+You can turn the `Work Locally` toggle off at any points and work on the common shared file on the server. All your local changes are saved and you can return to them at any point by toggling the checkbox back on.
+
+
+
+