diff --git a/docs/source/contact.md b/docs/source/contact.md index eebe583d4b8df2d21638761816c05dfe83795e6e..add8a01427a12a3a31dbbf755c4e478524d5336e 100644 --- a/docs/source/contact.md +++ b/docs/source/contact.md @@ -14,4 +14,4 @@ Please feel free to contact us if you have any questions. | Carl Schönfelder | carsc272@student.liu.se | Utvecklingsledare | Backend | Databas | | Emil Wahlqvist | emiwa210@student.liu.se | Analysansvarig | Frontend | Presentationseditor | -[comment]: # (Should this really be in swedish?) \ No newline at end of file +[comment]: # 'Should this really be in swedish?' diff --git a/docs/source/development/external.md b/docs/source/development/external.md index ee8c3b358bf0c8bea21575bf161d4450ae05f39e..83d02ad542760b90d0aa48145e816adc98065e0a 100644 --- a/docs/source/development/external.md +++ b/docs/source/development/external.md @@ -12,5 +12,3 @@ It's very helpful when developing APIs. [DB Browser for SQlite](https://sqlitebrowser.org/) is used to see what is currently stored in the database. You can even edit values. - -[comment]: # (Add VS CODE?) \ No newline at end of file diff --git a/docs/source/installation/client.md b/docs/source/installation/client.md index e5768e9c7a1eb0c658b3ecc4e66d2f5122ec776e..f7a886525bad9cf6655b8a972f013b235455a4d9 100644 --- a/docs/source/installation/client.md +++ b/docs/source/installation/client.md @@ -19,5 +19,4 @@ npm install You should now be ready to start the client. Try it by running `npm run start`. A web page should open where you can see the [login page](../user_manual/login.md). - -[comment]: # (Should we mention the task for starting the client?) +If you are using VS Code you can also start the client with the [task](../development/vscode.md) `start client`. diff --git a/docs/source/installation/server.md b/docs/source/installation/server.md index 3c867f43d7a90f49ea21720df224770d2372c27c..889c2465904a75dd53e19c1c5e83b149b3d05eb6 100644 --- a/docs/source/installation/server.md +++ b/docs/source/installation/server.md @@ -41,5 +41,4 @@ pip install -r requirements.txt You should now be ready to start the server. Try it by running `python main.py` and navigate to `localhost:5000`. If everything worked as it should you should see a list of all available API calls. - -[comment]: # (Should we mention the task for starting the server?) +If you are using VS Code you can also start the server with the [task](../development/vscode.md) `start server`. diff --git a/docs/source/overview/overview.md b/docs/source/overview/overview.md index 5a46ed1975d8835380c5dc403edefe0bd6caf9c1..fec1ff24ffe7eb9c11e7fee42e46484f4b9ef264 100644 --- a/docs/source/overview/overview.md +++ b/docs/source/overview/overview.md @@ -16,10 +16,8 @@ This is to make sure that whoever tries to communicate has the correct level of ### API -[comment]: # (What does "that will proxy the request to the main Python server" mean?) - API calls are used for simple functions that the client wants to perform, such as getting, editing, and saving data. -These are sent from the client to the backend Node server that will proxy the request to the main Python server. +These are sent from the client to the backend Node server that will forward the request to the main Python server. The request will then be handled there and the response will be sent back. The Node server will then send them back to the client. diff --git a/docs/source/overview/server.md b/docs/source/overview/server.md index 8c7277b9e4de6add1a938872e9e085b1ef5c2944..73b56dbaad7ee5c7fb174172bc9e2d1dfd997ca6 100644 --- a/docs/source/overview/server.md +++ b/docs/source/overview/server.md @@ -95,11 +95,9 @@ The server can see what is stored in the JWT and do different things depending o ### Syncing between clients -[comment]: # "What does `sync` mean? It isn't explained" - There are two other events that is used. -The operator will emit the `sync` event to sync some values to all other clients connected to the same competition. +The operator will emit the `sync` event to syncronise some values to all other clients connected to the same competition. The server will then send `sync` to all connected clients with the values that was updated. -The server will also store these values and will sync these when a client joins a competition. -The operator can also emit `end_presentation` to disconnect all clients from its competition. +The server will also store these values and will syncronise these when a client joins a presentation. +The operator can also emit `end_presentation` to disconnect all clients from its presentation. This will also end the presentation. diff --git a/docs/source/user_manual/editor.md b/docs/source/user_manual/editor.md index 7091cce61b74daabd5bbdc476d3dce7fc6186aa2..c0ab94086c555d6b0a45764314627d4ea0b4b9ac 100644 --- a/docs/source/user_manual/editor.md +++ b/docs/source/user_manual/editor.md @@ -9,6 +9,7 @@ Switch to a different slide by clicking on it. In the bottom left corner you will be able to add a new slide using the "Ny sida" button. Delete or copy a slide simply by right clicking on it and choosing the appropriate option. In the top right corner you will be able to change which view you see and edit. +By right clicking on a component you will be able to delete it or copy it to the same or a different view.  @@ -31,5 +32,3 @@ Below that you will be able to add and remove text and image components as well The background image for the competition can be overridden by explicitly setting it on a specific page.  - -[comment]: # 'Perhaps mention right clicking a component to make a copy to another view?' diff --git a/docs/source/user_manual/presentation.md b/docs/source/user_manual/presentation.md index 2bb125a59fafad25d5787524a4212e4377b0e789..aeac5265b8d96b60be7ada94bf563df8b48614b5 100644 --- a/docs/source/user_manual/presentation.md +++ b/docs/source/user_manual/presentation.md @@ -1,13 +1,12 @@ -[comment]: # "Why is this file named 'presentation' but the main headline is 'Active competitions'?" +# Presentations -# Active competitions - -There are many different views during a competition. -Below it is described how to start a competition, how to join a competition, and how the different kinds of views work. +An active (i.e. started) competition is for simplicity's sake called a presentation. +There are many different views during a presentation. +Below it is described how to start a competition, how to join a presentation, and how the different kinds of views work. ## Competition codes -You can join a competition with codes. +You can join a presentation with codes. This can either be done by pasting the link that can be copied when listing the codes or can be typed by hand in the login page. All the views have different purposes and therefore looks a little bit different from one another. @@ -16,17 +15,16 @@ All the views have different purposes and therefore looks a little bit different There are two ways to start a competition. The first way is to navigate to the competition manager, press the three dots "..." and press "Starta". You will then enter the operator view. -From there you will be able to go between slides with the "<" and ">" buttons or start the timer, both will be synced between all clients connected to that competition. -You will also be able to view the scores for the teams and view all codes to the competition. +From there you will be able to go between slides with the "<" and ">" buttons and start the timer, both will be synced between all clients connected to that presentation. +You will also be able to view all codes to the competition. +You can also show the current score for all teams to the audience.  ## Team -[comment]: # 'What is meant with "(or the code for one of the teams)"? Doesnt a team have to log in using a code?' - -The team view (or the code for one of the teams) will be used by teams. -It shows the current slide (that the operator has decided) and allows the user to answer questions on the slide that will be saved. +The team view will be used by teams. +It shows the current slide (that the operator has decided) and allows the user to answer questions on the slide, which will be saved.  @@ -41,7 +39,7 @@ The audience view will look like the operator view but without the buttons. [comment]: # 'Update image to show that the current slide is highlighted.' The judge view will show show the same slide as team view. -To the left you will be able to move between different slides without affecting the other clients and will be shown och which slide the operator currently is. +To the left you will be able to move between different slides without affecting the other clients and will be shown on which slide the operator currently is. To the right you will see what the teams have answered on every question, what score each team got on each question, their total score and be able to set the score of a team on any and all questions. In the bottom right you will see instructions for how to grade the current question.