diff --git a/docs/UserGuide.md b/docs/UserGuide.md index bf7a0307fa9..f9b9c6daaad 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -371,8 +371,8 @@ Expected output: The command will display the list of all students, sorted by the specified parameter, in lexicographical order. Examples: -- `/sort_student by/name` -- `/sort_student by/email` +- `/sort_students by/name` +- `/sort_students by/email` [Back to table of contents](#table-of-contents) @@ -539,7 +539,7 @@ Format: `/delete_team module/MODULE tutorial/TUTORIAL team/TEAM_NAME` Examples: -- `/delete_module module/CS2103T tutorial/T09 team/Team 1`
+- `/delete_team module/CS2103T tutorial/T09 team/Team 1`
Explanation: Deletes team `Team 1` from the module `CS2103T` and tutorial `T09` [Back to table of contents](#table-of-contents) @@ -602,8 +602,8 @@ The command will display the list of all students along with their student infor Example: -- `class_list_students module/CS2103T tutorial/T09` -- `class_list_students module/CS2101 tutorial/T01` +- `/class_list_students module/CS2103T tutorial/T09` +- `/class_list_students module/CS2101 tutorial/T01` [Back to table of contents](#table-of-contents) @@ -724,26 +724,26 @@ must be in the team before command execution. --- ## Command summary -| Action | Format, Examples | -|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Add New Students** | `/add_student name/NAME email/EMAIL id/STUDENT_ID`

e.g: `/add_student name/Dohn Joe email/johndoe@gmail.com id/A0123456A` | -| **Delete students** | By ID: `/delete_student id/STUDENT_ID`
By email: `/delete_student email/EMAIL`
By index: `/delete_student index/INDEX`

e.g: `/delete_student id/A0259209B` | -| **Search for students** | By ID: `/search_student id/STUDENT_ID`
By email: `/search_student email/EMAIL`
By name: `/search_student name/NAME`

e.g:`/search_student id/A0123456A` | -| **Edit student contact** | `/edit_student index/INDEX [id/STUDENT_ID] [email/EMAIL] [name/NAME]`

e.g: `/edit_student index/1 name/John` | -| **Sort students** | `/sort_students by/BY`
Supported parameters: id, name, email
e.g:`sort_students by/id` | -| **View all students** | `/list_students` | -| **Add new tutorial class** | `/add_class module/MODULE tutorial/TUTORIAL [description/DESC] [size/SIZE]`

e.g: `/add_class module/CS2109S tutorial/T01 description/Introduction to AI size/10` | -| **Delete tutorial class** | `/delete_class module/MODULE tutorial/TUTORIAL`

e.g: `/delete_class module/CS2103T tutorial/T09` | -| **View all classes** | `/list_classes` | -| **Add New Student to tutorial class** | By ID: `/add_student_to_class id/STUDENT_ID module/MODULE tutorial/TUTORIAL`
By Index: `/add_student_to_class index/INDEX module/MODULE tutorial/TUTORIAL`
By email: `/add_student_to_class email/EMAIL module/MODULE tutorial/TUTORIAL`

e.g: `/add_student_to_class index/1 module/CS2103T tutorial/T09` | -| **Delete students from tutorial class** | By ID: `/delete_student_from_class id/STUDENT_ID module/MODULE tutorial/TUTORIAL`
By index: `/delete_student_from_class index/INDEX module/MODULE tutorial/TUTORIAL`
By email: `/delete_student_from_class email/EMAIL module/MODULE tutorial/TUTORIAL`

e.g: `/delete_student_from_class id/A1234561Z module/CS2103T tutorial/T09` | -| **List students of a tutorial class** | `/class_list_students module/MODULE tutorial/TUTORIAL`

e.g: `/class_list_students module/CS2103T tutorial/T09` | -| **Delete module** | `/delete_module module/MODULE`

e.g: `/delete_module module/CS2103T` | -| **Add new team** | `/add_team module/MODULE tutorial/TUTORIAL team/TEAM_NAME [size/TEAM_SIZE]`

e.g: `/add_team module/CS2103T tutorial/T09 team/Team 1 size/5` | -| **Delete team** | `/delete_team module/MODULE tutorial/TUTORIAL team/TEAM_NAME`

e.g: `/delete_team module/CS2103 tutorial/T09 team/Team 4` | -| **View team** | By name: `/view_teams name/TEAM_NAME module/MODULE tutorial/TUTORIAL`
By index: `/view_teams index/INDEX module/MODULE tutorial/TUTORIAL`

e.g: `/view_teams name/Team 1 module/CS2103T tutorial/T09` | -| **Randomly allocate team** | `/random_teams module/MODULE tutorial/TUTORIAL teams/NUMBER_OF_TEAMS`

e.g: `/random_teams module/CS2103 tutorial/T09 teams/4` | -| **Allocate students to team** | `/allocate_team id/ID module/MODULE tutorial/TUTORIAL team/TEAM_NAME`

e.g: `/allocate_team id/A1234567K module/CS2103 tutorial/T09 team/Team 4` | -| **Delete students from team** | By ID: `/delete_student_from_team id/STUDENT_ID module/MODULE tutorial/TUTORIAL team/TEAM_NAME`
By email: `/delete_student_from_team email/EMAIL module/MODULE tutorial/TUTORIAL team/TEAM_NAME`
By index: `/delete_student_from_team index/INDEX module/MODULE tutorial/TUTORIAL team/TEAM_NAME`

e.g:`/delete_student_from_team id/A1234567K module/CS2103 tutorial/T09 team/Team 4` | +| Action | Format, Examples | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Add New Students** | `/add_student name/NAME email/EMAIL id/STUDENT_ID`

e.g: `/add_student name/Dohn Joe email/johndoe@gmail.com id/A0123456A` | +| **Delete students** | By ID: `/delete_student id/STUDENT_ID`
By email: `/delete_student email/EMAIL`
By index: `/delete_student index/INDEX`

e.g: `/delete_student id/A0259209B` | +| **Search for students** | By ID: `/search_student id/STUDENT_ID`
By email: `/search_student email/EMAIL`
By name: `/search_student name/NAME`

e.g:`/search_student id/A0123456A` | +| **Edit student contact** | `/edit_student index/INDEX [id/STUDENT_ID] [email/EMAIL] [name/NAME]`

e.g: `/edit_student index/1 name/John` | +| **Sort students** | `/sort_students by/BY`
Supported parameters: id, name, email
e.g:`/sort_students by/id` | +| **View all students** | `/list_students` | +| **Add new tutorial class** | `/add_class module/MODULE tutorial/TUTORIAL [description/DESC] [size/SIZE]`

e.g: `/add_class module/CS2109S tutorial/T01 description/Introduction to AI size/10` | +| **Delete tutorial class** | `/delete_class module/MODULE tutorial/TUTORIAL`

e.g: `/delete_class module/CS2103T tutorial/T09` | +| **View all classes** | `/list_classes` | +| **Add New Student to tutorial class** | By ID: `/add_student_to_class id/STUDENT_ID module/MODULE tutorial/TUTORIAL`
By Index: `/add_student_to_class index/INDEX module/MODULE tutorial/TUTORIAL`
By email: `/add_student_to_class email/EMAIL module/MODULE tutorial/TUTORIAL`

e.g: `/add_student_to_class index/1 module/CS2103T tutorial/T09` | +| **Delete students from tutorial class** | By ID: `/delete_student_from_class id/STUDENT_ID module/MODULE tutorial/TUTORIAL`
By index: `/delete_student_from_class index/INDEX module/MODULE tutorial/TUTORIAL`
By email: `/delete_student_from_class email/EMAIL module/MODULE tutorial/TUTORIAL`

e.g: `/delete_student_from_class id/A1234561Z module/CS2103T tutorial/T09` | +| **List students of a tutorial class** | `/class_list_students module/MODULE tutorial/TUTORIAL`

e.g: `/class_list_students module/CS2103T tutorial/T09` | +| **Delete module** | `/delete_module module/MODULE`

e.g: `/delete_module module/CS2103T` | +| **Add new team** | `/add_team module/MODULE tutorial/TUTORIAL team/TEAM_NAME [size/TEAM_SIZE]`

e.g: `/add_team module/CS2103T tutorial/T09 team/Team 1 size/5` | +| **Delete team** | `/delete_team module/MODULE tutorial/TUTORIAL team/TEAM_NAME`

e.g: `/delete_team module/CS2103 tutorial/T09 team/Team 4` | +| **View team** | By name: `/view_teams name/TEAM_NAME module/MODULE tutorial/TUTORIAL`
By index: `/view_teams index/INDEX module/MODULE tutorial/TUTORIAL`

e.g: `/view_teams name/Team 1 module/CS2103T tutorial/T09` | +| **Randomly allocate team** | `/random_teams module/MODULE tutorial/TUTORIAL teams/NUMBER_OF_TEAMS`

e.g: `/random_teams module/CS2103 tutorial/T09 teams/4` | +| **Allocate students to team** | `/allocate_team id/ID module/MODULE tutorial/TUTORIAL team/TEAM_NAME`

e.g: `/allocate_team id/A1234567K module/CS2103 tutorial/T09 team/Team 4` | +| **Delete students from team** | By ID: `/delete_student_from_team id/STUDENT_ID module/MODULE tutorial/TUTORIAL team/TEAM_NAME`
By email: `/delete_student_from_team email/EMAIL module/MODULE tutorial/TUTORIAL team/TEAM_NAME`
By index: `/delete_student_from_team index/INDEX module/MODULE tutorial/TUTORIAL team/TEAM_NAME`

e.g:`/delete_student_from_team id/A1234567K module/CS2103 tutorial/T09 team/Team 4` | [Back to table of contents](#table-of-contents)