Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Edit features related to Student class and general information in the UG #14

Merged
merged 1 commit into from
Oct 3, 2023
Merged

Edit features related to Student class and general information in the UG #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 41 additions & 53 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
pageNav: 3
---

# AB-3 User Guide
# LumiNUS User Guide

AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
LumiNUS is a **desktop app for managing students' grades, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, LumiNUS can get your contact management tasks done faster than traditional GUI apps.

<!-- * Table of Contents -->
<page-nav-print />
Expand All @@ -17,7 +17,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo

1. Ensure you have Java `11` or above installed in your Computer.

1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
1. Download the latest `luminus.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).

1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.

Expand Down Expand Up @@ -74,44 +74,40 @@ Shows a message explaning how to access the help page.

Format: `help`

### Add a student: `addStu`
Adds a student to the database. Throws error if student with same student number already exists. If it succeeds, an acknowledgement message (“Student was added successfully”) is shown to the user and data is saved. If it fails, show an error message instead. (“Something went wrong while adding student”)
Valid student numbers start and end with an upper-case alphabet, and have 7 numeric symbols in between.

### Adding a person: `add`
Format: `addStu s/STUDENT_NO [n/NAME] [e/EMAIL] [t/TUTORIAL_GRP]…​`

Adds a person to the address book.
Examples:
* `addStu s/A1234567Y n/Andy t/03` Adds a student with student number A1234567Y, name Andy, belonging to tutorial group 03 to the database.

Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
### Edit a student : `editStu`
Edit student information. If it succeeds, it shows an acknowledgement message and saves the edited information (“Student information edited successfully”). Throws an error if student does not exist (“Something went wrong while editing student information”). Note that the student number cannot be edited as it is a unique identifier. In such a case, the student should be deleted.
0 or more optional fields should be provided, and all the optional fields will be edited concurrently. Valid student numbers start and end with an upper-case alphabet, and have 7 numeric symbols in between.

<box type="tip" seamless>
Format: `editStu s/STUDENT_NO [t/TUTORIAL_GRP][n/NAME][e/EMAIL]…​`

**Tip:** A person can have any number of tags (including 0)
</box>

Examples:
* `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01`
* `add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal`
Examples:
* `editStu n/Megan Chan t/03` Edits a student to have name Megan Chan and be in tutorial group 03.

### Listing all persons : `list`
### Delete a student : `deleteStu`
Delete a student in the database. If it succeeds, it shows an acknowledgement message and deletes the student from the database (“Student information deleted successfully”). Throws an error if student does not exist (“Something went wrong while deleting the student”). All associated student marks will also be deleted.
Valid student numbers start and end with an upper-case alphabet, and have 7 numeric symbols in between.

Shows a list of all persons in the address book.
Format: `deleteStu s/STUDENT_NO`

Format: `list`
Examples:
* `deleteStu s/A1234567Y`

### Editing a person : `edit`
### List all students : `listStudents`
Shows a list of all students and associated student marks in separate panels respectively. The lists may be additionally filtered by optional arguments tutorial group. (can have more than 1)

Edits an existing person in the address book.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`

* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
* At least one of the optional fields must be provided.
* Existing values will be updated to the input values.
* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
* You can remove all the person’s tags by typing `t/` without
specifying any tags after it.
Format: `listStudents [t/TUTORIAL_GRP …]`

Examples:
* `edit 1 p/91234567 e/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
* `listStudents t/02 03`

### Locating persons by name: `find`

Expand All @@ -131,20 +127,6 @@ Examples:
* `find alex david` returns `Alex Yeoh`, `David Li`<br>
![result for 'find alex david'](images/findAlexDavidResult.png)

### Deleting a person : `delete`

Deletes the specified person from the address book.

Format: `delete INDEX`

* Deletes the person at the specified `INDEX`.
* The index refers to the index number shown in the displayed person list.
* The index **must be a positive integer** 1, 2, 3, …​

Examples:
* `list` followed by `delete 2` deletes the 2nd person in the address book.
* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.

### Clearing all entries : `clear`

Clears all entries from the address book.
Expand Down Expand Up @@ -180,7 +162,7 @@ _Details coming soon ..._
## FAQ

**Q**: How do I transfer my data to another Computer?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder.
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous LumiNUS home folder.

--------------------------------------------------------------------------------------------------------------------

Expand All @@ -192,12 +174,18 @@ _Details coming soon ..._

## Command summary

Action | Format, Examples
-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
| Action | Format, Examples |
|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add a student** | `addStu s/STUDENT_NO [n/NAME] [e/EMAIL] [t/TUTORIAL_GRP]…` <br> e.g., `addStu s/A1234567Y n/Andy t/03` |
| **Add a graded component** | `addComp c/COMP_NAME w/WEIGHTAGE m/MAX_MARKS…` <br> e.g., `addComp c/Midterm w/30 m/70` |
| **Add a student mark** | `addStuMark s/STUDENT_NO c/COMP_NAME m/MARKS [x/comments]…` <br> e.g., `addStuMark s/A1234567Y c/Midterm m/57 ` |
| **Edit a student** | `editStu s/STUDENT_NO [t/TUTORIAL_GRP][n/NAME][e/EMAIL]…​` <br> e.g., `editStu n/Megan Chan t/03` |
| **Edit a graded component** | `editComp c/COMP_NAME [w/WEIGHTAGE] [m/MAX_MARKS]` <br> e.g., `editComp c/Midterm w/25 ` |
| **Edit a student mark** | `editStuMark s/STUDENT_NO c/COMP_NAME [m/MARKS] [x/comments]` <br> e.g., `editComp s/A1234567Y c/Midterm x/Q4 answer is debatable. Discuss in next staff meeting.` |
| **Delete a student** | `deleteStu s/STUDENT_NO` <br> e.g., `deleteStu s/A1234567Y` |
| **Delete a graded component** | `deleteComp s/Optional Project` <br> e.g., `deleteComp s/Optional Project` |
| **Clear** | `clear` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
| **List all students** | ` listStudents [t/TUTORIAL_GRP …]` <br> e.g., `listStudents t/02 03` |
| **List all graded components** | ` listComps [c/COMP_NAME …]` <br> e.g., `listComps c/CA1 CA2` |
| **Help** | `help` |
Comment on lines +177 to +191
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like how you updated the command summary

Binary file modified docs/images/Ui.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading