Skip to content

Commit

Permalink
Fix some UG bugs
Browse files Browse the repository at this point in the history 
AY2324S1-CS2103T-F12-1#172, AY2324S1-CS2103T-F12-1#190, AY2324S1-CS2103T-F12-1#191, AY2324S1-CS2103T-F12-1#192, AY2324S1-CS2103T-F12-1#194, AY2324S1-CS2103T-F12-1#196, AY2324S1-CS2103T-F12-1#197, AY2324S1-CS2103T-F12-1#198, AY2324S1-CS2103T-F12-1#201, AY2324S1-CS2103T-F12-1#202
  • Loading branch information
@nikele2001
nikele2001 committed Nov 5, 2023
1 parent 4f59dfd commit 907f0ba
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 22 deletions.
62 changes: 42 additions & 20 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ A person can have any number of tags (including 0)
</div>

Examples:
* `add n/John p/80101010 e/[email protected] a/Punggol Central Blk 444 #15-32 820123 nk/Brennan nkp/82020202 [t/TAG]…​`
* `add n/John p/80101010 e/[email protected] a/Punggol Central Blk 444 #15-32 820123 nk/Brennan nkp/82020202`

Successful Output: `New person added: John;
Phone: 80101010;
Expand All @@ -142,6 +142,21 @@ Tags:`

![result for 'add n/John p/80101010 e/[email protected] a/Punggol Central Blk 444 #15-32 820123 nk/Brennan nkp/82020202'](images/addUi.png)

You can also add a client's contacts with multiple tags.

Examples:
* `add n/John p/80101010 e/[email protected] a/Punggol Central Blk 444 #15-32 820123 nk/Brennan nkp/82020202 t/80yo t/grumpy`

Successful Output: `New person added: John;
Phone: 80101010;
Email: [email protected];
Address: Punggol Central Blk 444 #15-32 820123;
Next-of-kin Name: Brennan;
Next-of-kin Phone: 82020202;
Appointment: No Appointment made!;
Financial Plans: ;
Tags: [80yo][grumpy]`

------------------
### Listing all persons : `list`

Expand All @@ -156,9 +171,9 @@ Successful Output:`Listed all persons`
--------------------------------
### Editing a person : `edit`

Edit clients contact fields using an entry index followed by the updated details.
Edit clients contact fields using an index followed by the updated details.

Format: `edit ENTRY_INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [nk/NEXT_KIN] [nkp/NEXT_KIN_PHONE] [fp/FINANCIAL_PLAN] [t/TAG]…​`
Format: `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [nk/NEXT_KIN] [nkp/NEXT_KIN_PHONE] [fp/FINANCIAL_PLAN] [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.
Expand All @@ -171,7 +186,7 @@ Format: `edit ENTRY_INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [nk/NE
* A person's appointment cannot in edited in this manner. Refer to [Schedule](#scheduling-an-appointment--schedule).

Acceptable Values:
1. ENTRY_INDEX - Number (1 to current size of the contact book)
1. INDEX - Number (1 to current size of the contact book)
2. NAME - any value is possible
3. PHONE_NUMBER - Numbers (0-9) and symbols, no alphabets
4. EMAIL - string in valid email format
Expand Down Expand Up @@ -241,27 +256,34 @@ Successful Output:

Deletes the client contact from the contact book by their index.

Format: `delete ENTRY_INDEX`
Format: `delete INDEX`

* Deletes the person at the specified `INDEX`.
* The index refers to the index number shown in the displayed person list.

Acceptable Values:
1. ENTRY_INDEX - Number (1 to current size of the contact book).
1. INDEX - Number (1 to current size of the contact book).

Examples:
* `list` followed by `delete 1` deletes the 1st person in the contact book.

Successful Output:
`Contact Deleted!
Low Jun Yu is removed.`
`Deleted Person: David;
Phone: 93234567;
Email: [email protected];
Address: Bishan Blk 999 #08-15 569874;
Next-of-kin Name: Olivia;
Next-of-kin Phone: 56981234;
Appointment: Meeting, 15-12-2023 17:30;
Financial Plans: [Financial Plan A][Financial Plan B];
Tags: `

----------
### Scheduling an Appointment : `schedule`

Schedules an appointment for a client using an entry index followed by the appointment details.
Schedules an appointment for a client using an index followed by the appointment details.

Format: `schedule ENTRY_INDEX [ap/APPOINTMENT_NAME] [d/APPOINTMENT_DATE]`
Format: `schedule INDEX ap/APPOINTMENT_NAME d/APPOINTMENT_DATE`

- Schedules appointment with the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list.
- Both appointment name and date must be provided.
Expand All @@ -278,12 +300,12 @@ Successful Output:`Appointment updated!`
----------
### Completing an Appointment : `complete`

Completes an appointment with clients. User can input an entry index to complete an appointment with a specific client. User can also input a specific date to complete all appointments with the matching date.
Completes an appointment with clients. User can input an index to complete an appointment with a specific client. User can also input a specific date to complete all appointments with the matching date.

Format: `complete [ENTRY_INDEX] [d/APPOINTMENT_DATE]`
Format: `complete [INDEX] [d/APPOINTMENT_DATE]`

- Completes appointment with the person at the specified INDEX. The index refers to the index number shown in the displayed person list.
- **Either an entry index or appointment date must be provided** for command to execute.
- **Either an index or appointment date must be provided** for command to execute.

Examples:
- `complete 1`
Expand All @@ -307,7 +329,7 @@ Example:
![confirm clear window](images/confirmClear.png)

----------------------------
### Sorting of data: `sort`
### Sorting of data : `sort`

Sorts all the entries with predefined sorting functionalities. After sorting the list, the ordering of the entries
will be changed. As a result, performing delete operations that require indexing will reference the new ordering
Expand All @@ -318,13 +340,13 @@ that is currently displayed on the screen.
* `name` : sorts list by lexicographical ordering of name (case-insensitive).
* `appointment`: sorts list by appointment timing in order of the earliest appointment first.

Format: `sort` + `keyword`
Format: `sort keyword`

* Calling this command after a Find command will preserve the results filtered by the Find command.

Example: `sort name` performs sorting by lexicographical ordering

Successful Output:`4 persons listed!`
Successful Output: `4 persons listed!`

![result for`sort name'](images/sortUi.png)

Expand Down Expand Up @@ -370,14 +392,14 @@ _Details coming soon ..._

| Action | Format, Examples |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS nk/NEXT_KIN nkp/NEXT_KIN_PHONE [t/TAG]…​` <br> e.g., `add n/John p/80101010 e/[email protected] a/Punggol Central Blk 444 #15-32 820123 nk/Brennan nkp/82020202 [t/TAG]…​` |
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS nk/NEXT_KIN nkp/NEXT_KIN_PHONE [fp/FINANCIAL_PLAN] [t/TAG]…​` <br> e.g., `add n/John p/80101010 e/[email protected] a/Punggol Central Blk 444 #15-32 820123 nk/Brennan nkp/82020202 [t/TAG]…​` |
| **Clear** | `clear` |
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Edit** | `edit ENTRY_INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [nk/NEXT_KIN] [nkp/NEXT_KIN_PHONE] [t/TAG]…​`<br> e.g.,`edit 1 n/john doe a/23 woodlands ave 123` |
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [nk/NEXT_KIN] [nkp/NEXT_KIN_PHONE] [fp/FINANCIAL_PLAN] [t/TAG]…​`<br> e.g.,`edit 1 n/john doe a/23 woodlands ave 123` |
| **Find** | `find [n/NAME]…​ [fp/FINANCIAL_PLAN]…​ [t/TAG]…​`<br> e.g., `find n/James n/Jake` |
| **Gather** | `gather [fp/FINANCIAL PLAN]` or `gather [t/TAG]` <br> e.g., `gather fp/Basic Insurance Plan` |
| **Schedule** | `schedule ENTRY_INDEX ap/APPOINTMENT_NAME d/APPOINTMENT_DATE`<br> e.g. `schedule 1 ap/Annual review of financial goals d/20-11-2023 15:00` |
| **Complete** | `complete [ENTRY_INDEX] [d/APPOINTMENT_DATE]` <br> e.g `complete 1` <br> e.g `complete 01-05-2023` | |
| **Schedule** | `schedule INDEX ap/APPOINTMENT_NAME d/APPOINTMENT_DATE`<br> e.g. `schedule 1 ap/Annual review of financial goals d/20-11-2023 15:00` |
| **Complete** | `complete [INDEX] [d/APPOINTMENT_DATE]` <br> e.g `complete 1` <br> e.g `complete 01-05-2023` | |
| **List** | `list` |
| **Help** | `help` |
| **Sort** | `sort SORTING_FUNCTION` <br> e.g., `sort appointment` |
Expand Down
Binary file modified docs/images/helpMessage.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/main/java/seedu/address/ui/OverrideWindow.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
*/
public class OverrideWindow extends UiPart<Stage> {

public static final String CONFIRM_OVERRIDE_MESSAGE = "There is an appointment found under this persons name"
+ "are you sure you want to override this appointment? \n";
public static final String CONFIRM_OVERRIDE_MESSAGE = "There is an appointment found under this person's name. "
+ "Are you sure you want to override this appointment? \n";

private static String message;
private static Appointment appointment = null;
Expand Down

0 comments on commit 907f0ba

Please sign in to comment.