Skip to content

Commit

Permalink
Merge pull request AY2425S1-CS2103T-F15-2#79 from btbrandon/update-he…
Browse files Browse the repository at this point in the history
…lp-page

Update HelpWindow
  • Loading branch information
ethan-goh authored Oct 24, 2024
2 parents 1d7567d + 72816b4 commit 3654024
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 48 deletions.
Binary file modified docs/images/helpMessage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 15 additions & 48 deletions src/main/java/seedu/address/ui/HelpWindow.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,57 +21,24 @@ public class HelpWindow extends UiPart<Stage> {
+ " H E L P M E N U\n"
+ "============================================================================================\n"
+ "\n1. Add Student\n"
+ " - Purpose: Adds a student and their details to the address book.\n"
+ " - Command Format:\n"
+ " add id/ [STUDENT_ID] n/ [STUDENT_NAME] p/ [PHONE_NUMBER] a/ [ADDRESS] c/ [COURSE] t/ [TAGS]\n"
+ " - Example:\n"
+ " add id/ 12345678 n/ John Doe p/ 99999999 a/ 123 Jane Doe Road "
+ "c/ Computer Science t/ Student\n"
+ " - add [ID] n/ [STUDENT_NAME] p/ [PHONE_NUMBER] a/ [ADDRESS] c/ [COURSE] t/ [TAGS]\n"
+ "\n2. Add a Student Grade\n"
+ " - Purpose: Adds a grade for a student in a module.\n"
+ " - Command Format:\n"
+ " grade id/ [STUDENT_ID] m/ [MODULE] g/ [GRADE]\n"
+ " - Example:\n"
+ " grade id/ 12345678 m/ CS2103T g/ A\n"
+ " - grade id/ [ID] m/ [MODULE] g/ [GRADE]\n"
+ "\n3. Add Module\n"
+ " - Purpose: Adds a module for a student.\n"
+ " - Command Format:\n"
+ " module id/ [STUDENT_ID] m/ [MODULE]\n"
+ " - Example:\n"
+ " module id/ 12345678 m/ CS2103T\n"
+ " - module id/ [STUDENT_ID] m/ [MODULE]\n"
+ "\n4. Edit Student\n"
+ " - Purpose: Edits a student's details according to the fields specified.\n"
+ " - Command Format:\n"
+ " edit [STUDENT_ID] [FIELD_TO_EDIT_PREFIX] [NEW_VALUE]\n"
+ " - Editable Fields:\n"
+ " n/ [STUDENT_NAME], p/ [PHONE_NUMBER], e/ [EMAIL], a/ [ADDRESS], c/ [COURSE], t/ [TAG]\n"
+ " - Example:\n"
+ " edit 12345678 n/ Jane Doe p/ 88888888 e/ [email protected] "
+ "a/ 456 John Doe Road c/ Physics t/ Student\n"
+ "\n5. Delete Student\n"
+ " - Purpose: Removes a student from the address book.\n"
+ " - Command Format:\n"
+ " delete id/ [STUDENT_ID]\n"
+ " - Example:\n"
+ " delete id/ 12345678\n"
+ "\n6. List Students\n"
+ " - Purpose: Displays all students currently stored in the address book.\n"
+ " - Command Format:\n"
+ " list\n"
+ " - Example:\n"
+ " list\n"
+ "\n7. Clear Data\n"
+ " - Purpose: Clears all student data from the address book.\n"
+ " - Command Format:\n"
+ " clear\n"
+ " - Example:\n"
+ " clear\n"
+ "\n8. Exit Application\n"
+ " - Purpose: Exits the application.\n"
+ " - Command Format:\n"
+ " exit\n"
+ " - Example:\n"
+ " exit\n"
+ " - edit [ID] [FIELD_TO_EDIT_PREFIX] [NEW_VALUE]\n"
+ " - edit [ID] m/ [OLD_MODULE] [NEW_MODULE]\n"
+ "\n5. Find Student\n"
+ " - find [ID]\n"
+ "\n6. Delete Student\n"
+ " - delete id/ [ID]\n"
+ "\n7. List Students\n"
+ " - list\n"
+ "\n8. Clear Data\n"
+ " - clear\n"
+ "\n9. Exit Application\n"
+ " - exit\n"
+ "\n============================================================================================\n"
+ "For more details, refer to the user guide: \n" + USERGUIDE_URL;

Expand Down

0 comments on commit 3654024

Please sign in to comment.