Skip to content

Commit

Permalink
Update UG
Browse files Browse the repository at this point in the history
  • Loading branch information
qinxutan committed Apr 4, 2024
1 parent 88dda60 commit 11c3cf9
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,21 +430,23 @@ Explanation: This randomly allocates all the students in the tutorial class `T01

## Command summary

| Action | Format, Examples |
|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add New Students** | `add_student name/ <student_name> id/ <student_id> email/ <student_email> tag/<tag>` <br> e.g., `/add_student name/Dohn Joe id/A0123456A email/[email protected] id/A0123456A` |
| **Delete students** | `delete_student <id/, email/> <id or email>`<br> e.g., `delete_student id/A0259209B` or `/delete_student email/[email protected]` |
| **Search for students** | `search_student <id/, email/, tc/, name/> <id or email or tutorial or name>`<br> e.g.,`search_student id/A0123456A` |
| **Sort students** | `sort_students by/<name or email or id> `<br> e.g.,`search_student by/id` or `search_student by/name` |
| **View all students** | `list_students` |
| **Add new tutorial class** | `add_class module/<module_code> tutorial/<tutorial_class>` <br> e.g., `add_class module/CS2103T tutorial/T09` |
| **Delete tutorial class** | `delete_class module/<module_code> tutorial/<tutorial_class>` <br> e.g., `delete_class module/CS2103T tutorial/T09` |
| **View all classes** | `list_classes` |
| **Add New Student to tutorial class** | `add_student_to_class <index/, email/ , id/> <index or email or id> module/ <module> tutorial/ <class>` <br> e.g., `add_student_to_class index/1 module/CS2103T tutorial/T09` |
| **Delete students from tutorial class** | `delete_student_from_class email/<email> module/ <module> tutorial/ <class>` or `delete_student_from_class id/<id> module/ <module> tutorial/ <class>` <br> e.g., `delete_student_from_class id/A1234561Z module/CS2103T tutorial/T09` |
| **List students of a tutorial class** | `class_list_student module/ <module> tutorial/ <class>` <br> e.g., `class_list_students module/CS2103T tutorial/T09` |
| **Delete module** | `delete_module module/<module_code>` <br> e.g., `delete_class module/CS2103T` |
| **Add new team** | `add_team module/<moduleCode> tutorial/<tutorialClass> name/<team_name> size/<team_size>` <br> e.g., `add_team module/CS2103T tutorial/T09 name/Team 1 size/5` |
| **Delete team** | `delete_team module/<moduleCode> tutorial/<tutorialClass> name/<team_name>` <br> e.g., `delete_team module/CS2103 tutorial/T09 name/Team 4` |
| **View team** | `view_teams <index/, name/> <index or name> module/<moduleCode> tutorial/<tutorialClass>` <br> e.g., `view_teams name/Team 1 module/CS2103T tutorial/T09` |
| **Randomly allocate team** | `/random_teams module/<module> tutorial/<tutorialClass> teams/<number_of_teams>` <br> e.g., `random_teams module/CS2103 tutorial/T09 teams/4` |
| Action | Format, Examples |
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add New Students** | `/add_student name/ <student_name> id/ <student_id> email/ <student_email> tag/<tag>` <br> e.g., `/add_student name/Dohn Joe id/A0123456A email/[email protected] id/A0123456A` |
| **Delete students** | `/delete_student <id/, email/> <id or email>`<br> e.g., `delete_student id/A0259209B` or `/delete_student email/[email protected]` |
| **Search for students** | `/search_student <id/, email/, tc/, name/> <id or email or tutorial or name>`<br> e.g.,`/search_student id/A0123456A` |
| **Sort students** | `/sort_students by/<name or email or id> `<br> e.g.,`search_student by/id` or `/search_student by/name` |
| **View all students** | `/list_students` |
| **Add new tutorial class** | `/add_class module/<module_code> tutorial/<tutorial_class>` <br> e.g., `/add_class module/CS2103T tutorial/T09` |
| **Delete tutorial class** | `/delete_class module/<module_code> tutorial/<tutorial_class>` <br> e.g., `/delete_class module/CS2103T tutorial/T09` |
| **View all classes** | `/list_classes` |
| **Add New Student to tutorial class** | `/add_student_to_class <index/, email/ , id/> <index or email or id> module/ <module> tutorial/ <class>` <br> e.g., `/add_student_to_class index/1 module/CS2103T tutorial/T09` |
| **Delete students from tutorial class** | `/delete_student_from_class email/<email> module/ <module> tutorial/ <class>` or `delete_student_from_class id/<id> module/ <module> tutorial/ <class>` <br> e.g., `/delete_student_from_class id/A1234561Z module/CS2103T tutorial/T09` |
| **List students of a tutorial class** | `/class_list_student module/ <module> tutorial/ <class>` <br> e.g., `class_list_students module/CS2103T tutorial/T09` |
| **Delete module** | `/delete_module module/<module_code>` <br> e.g., `delete_class module/CS2103T` |
| **Add new team** | `/add_team module/<moduleCode> tutorial/<tutorialClass> name/<team_name> size/<team_size>` <br> e.g., `/add_team module/CS2103T tutorial/T09 name/Team 1 size/5` |
| **Delete team** | `/delete_team module/<moduleCode> tutorial/<tutorialClass> name/<team_name>` <br> e.g., `/delete_team module/CS2103 tutorial/T09 name/Team 4` |
| **View team** | `/view_teams <index/, name/> <index or name> module/<moduleCode> tutorial/<tutorialClass>` <br> e.g., `/view_teams name/Team 1 module/CS2103T tutorial/T09` |
| **Randomly allocate team** | `/random_teams module/<module> tutorial/<tutorialClass> teams/<number_of_teams>` <br> e.g., `/random_teams module/CS2103 tutorial/T09 teams/4` |
| **Allocate students to team** | `/allocate_team <id/, email/, index/> <student_id or email or index> module/<moduleCode> tutorial/<tutorial_class> name/<team_name>` <br> e.g., `/allocate_team id/A1234567K module/CS2103 tutorial/T09 name/4` |
| **Delete students from team** | `/delete_from_team id/<student_id> module/<moduleCode> tutorial/<tutorialClass> name/<team_name>` <br> e.g., `/delete_from_team id/A1234567K module/CS2103 tutorial/T09 name/4` |

0 comments on commit 11c3cf9

Please sign in to comment.