Merge pull request #1170 from risehr/textfiles

Added text files for kml, mscolab, wms, and views tutorials.

docs/tutorials.rst

@@ -81,11 +81,20 @@ This will install all the dependencies required for running of the tutorials.
     $ sudo apt-get install libx11-dev libxext-dev libxfixes-dev libxi-dev
 
 
-Now, just go into the _../MSS/tutorials/_ directory ::
+Now, just go into the **../MSS/tutorials/** directory ::
 
     $ cd ../MSS/tutorials/
 
 
+**Note**
+
+You must go into the tutorials directcory and then run the .py files. And always remember to add the PYTHONPATH to
+........../MSS/ directory.
+You cannot just do like this ::
+
+    $ python MSS/tutorials/sreenrecorder.py     # This will be problematic.
+
+
 In Linux for making the cursor visible as a highlighter, perform the following
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 If you are in Windows, there is no need of this highlighter. It is by default that it also records the mouse-pointer.
@@ -113,7 +122,7 @@ Each python file inside MSS/tutorials can be run directly like ::
 
 (mssdev)~/..MSS/tutorials/ $ python screenrecorder.py
 
-For recording anything on your screen. The videos will be then saved to `MSS/tutorials/Screen Recorders/`
+For recording anything on your screen. The videos will be then saved to `MSS/tutorials/Screen Recordings/`
 
 For all the tutorials, you can do the same, example ::
 
@@ -122,7 +131,7 @@ For all the tutorials, you can do the same, example ::
 (mssdev)~/..MSS/tutorials/ $ python tutorial_hexagoncontrol.py
 
 The `MSS/tutorials/textfiles` contain descriptions of the tutorial videos in text format, these later can be
-converted to audio files by `audio.py` script after adding certain #ToDOs.
+converted to audio files by `audio.py` script after adding certain #ToDOs there.
 
 **Note**
 In  tutorials development, when creating a class of Screen Recorder as ::

tutorials/textfiles/tutorial_kml.txt

@@ -0,0 +1,48 @@
+The MSS software will be maximised automatically and TOP VIEW will be opened. 
+
+After clicking on SELECT TO OPEN CONTROL, click on KML OVERLAY. The UI will look as shown.
+
+The GREEN coloured boundary is the KML file that denotes the geographical boundary which helps in planning the WAY POINTS.
+
+We can put the WAY POINTS along this green line. We will now see how to add, move, select KML files.
+
+We can see two KML files here, one is COLOR.KML ; and the another one is FOLDER.KML.
+
+
+COLOR.KML is in Red colour, FOLDER.KML is denoted by Green colour.
+
+The box is checked that shows that these KML files are shown in the map, if unchecked, it will not show.
+
+
+First of all, we click on SELECT ALL FILES, and then click on REMOVE FILES. Both the KML files will be removed.
+
+Now, we will add KML files by clicking on ADD KML FILES. The dialogue will be opened and it will add the path where the KML file is present. You can also select it through the file dialogue.
+
+When we add a KML file, the default colour is Black and the default linewidth is 5 units.
+
+Now, let's change colour and line width of the KML files. Before that, we add another KML file. Both the KML files will be opened when we will open the GLOBAL map. 
+
+Both the files are in black colour.
+
+Now, we will change colour of FOLDER.KML file by selecting it and clicking on CHANGE COLOUR. We change it from Black to blue followed by blue to green.
+
+Changing it for some time...
+
+Now, we change line width by changing its numerical value whose range is 0 to 10.
+
+We change it to different values to obtain different linewidths.
+
+
+After entering in GLOBAL MAP, we can see COLOR dot KML file which is in black colour.
+
+We change its colour by clicking on CHANGE COLOR option button. 
+
+We change it to Red. 
+
+It's default line width is 5. 
+
+We again change its colour to Maroon. 
+
+We type the line width to 6.53 and then 3.45.
+
+The top view is closed and the tutorial ends.

tutorials/textfiles/tutorial_mscolab.txt

@@ -0,0 +1,199 @@
+Mission Support Collaboration
+
+MSColab stores data in an online server, and can be used to access the data remotely as also working in a team where everyone contributes his part. It is used for collaborating with the users as a team together and working on a shared MScolab project. 
+
+
+to start with, click on Connect to MSColab, 
+
+in the window opened, enter MSColab url and click on connect.
+
+"successfully connected to the MSColab server"
+
+
+we can enter Email id and Password for an existing user, else we can click on Add user to register a new user.
+
+
+Filling new user Details, and clicking OK.
+
+As, the user exists, we go back to cancel and enter the login page again!
+
+logging into my profile by entering my user name and password.
+
+Then clicking on the login button.
+
+Now the user John Doe is logged in to MScolab.
+
+He can now start working on shared project.
+
+go to File  and then  new  and then MSColab Project option.
+
+Add MSColab project
+
+MSS project window opens
+
+
+name the path, give the Description of the project.
+
+
+we can also choose a flight track file or dot FTML file, which is stored on our computer.
+
+Add project by clicking OK.
+
+
+"your project was successfully created"
+
+
+Double click on the shared project name to activate it.
+
+
+while working on a shared file, we can control who can access this project.
+
+go to Project and then, "Manage Users."
+
+Admin Window-MSS pops up.
+
+the left side has list of users without permission, while the right side has a list of those users who have been granted an access to this project.
+
+
+In All Users without permission section, we can select all users at a time or deselect all of them, or we can search for  a user.
+
+We search for the user "test" in the server.
+
+Now we empty the search bar.
+
+After selecting users, we click on Add button, which moves these users to All users with permission section to the right side of the window.
+
+
+for the users who have access permission to the project, we can also change the access roles.
+
+Here for b, we have changed the permission from collaborator to admin.
+
+we can alo delete a user with a permission by selecting user and clicking on delete button.
+
+
+Changing their access roles....
+
+
+we can filter users based on their roles being Collaborator, admin or viewer.
+
+
+Filtering for some time....
+
+
+We can also communicate with fellow users in our project.
+
+
+go to Project and then Chat option.
+
+Click on it.
+
+MSColab chat window pops up.
+
+the left pan shows the list of people who have access to this project.
+
+
+enter the message in the space provided.
+
+Typing the texts.....
+
+click on send button, or press Enter.
+
+
+Typing another message....
+
+
+we can upload files by clicking on upload and browsing for the file.
+
+
+Here, we send the mss logo to all the users to see.
+
+we can also search for a meassage by entering a phrase or complete text and then pressing previous or next as we need to find the message.
+
+
+Next, we close the chat window.
+
+Now, we will see how to manage version history.
+
+We will go to projects and then click version history..
+
+Version history is basically a record in the changes performed in the waypoints of the flight  track.
+
+We can switch to a particular version history and name that version according to our choice or just checkout to that version.
+
+In that case, the current waypoints will be changed to that version of waypoints and their locations.
+
+
+Now we will just surf through all the version history.
+
+
+We change the name of one version history to "Initial Waypoints" by clicking on "Name Version"
+
+Now, we select another waypoint version and then checkout to that version by clicking on checkout button.
+
+It asks for a confirmation.
+
+Now we close the version history window...
+
+We then select work asynchronously checkbox. It means that we are offline at present.
+
+Later, we can save our changes to server or fetch new changes from the server changed by other people or the changes present on the server the last time.
+
+We then open topview and move the waypoints for making changes...
+
+We then open drop down menu of "save to server."
+
+It will open a window.
+
+We can either click overwite server waypoints with local waypoints or local waypoints with server waypoints.
+
+
+We click overwite with local waypoints.
+
+The server waypoint changes with the work we have done locally.
+
+Now it gives a confirmation message. "Added local waypoints to server"
+
+Now we will close the window.
+
+We will again start work synchronously with other users by unchecking "Work Unsynchronously."
+
+We can switch between local flight tracks and shared project by double clicking any one of them.
+
+Remember, at any point only one flight track can be active, either local or shared.
+
+Now we make changes in the topview of local flight track.
+
+Opening topview and making the changes....
+
+Adding waypoints....
+
+
+We can see new waypoints are added here in a different fashion.
+
+It is different from the first set of waypoints we have selected and added.
+
+We now close the topview.
+
+The local flight track got changed.
+
+
+Now for confirming, we open the shared flightrack by activating it.
+
+We open topview and can see it is different form local flightrack.
+
+We now close the topview and answer the confirmation.
+
+
+We now delete the project.
+
+We have to retype its name for the confirmation for deleting it.
+
+Now, we click on John Doe's User profile and we select the Profile of the user.
+
+We can see his email and server its connected to!
+
+Now, we log the user out.
+
+We close the MSColab window and it asks for confirmation.
+
+This is all about MSColab.