From 8716c89857b8d42f3322a68c5f5c1bb3503a0e39 Mon Sep 17 00:00:00 2001 From: random689 Date: Wed, 27 Oct 2021 20:28:24 +0800 Subject: [PATCH 1/7] Update UserGuide Link for some meeting command --- docs/UserGuide.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a695e822e5b..b1f1f8e3a9d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,18 +3,16 @@ layout: page title: User Guide --- -* Table of Contents - {:toc} - --------------------------------------------------------------------------------------------------------------------- - ## Introduction -NewAddressBook is a **desktop app built for secondary school teachers** handling large classes +NewAddressBook is a **desktop app built for secondary school teachers** handling large classes to help **manage their contacts of their students and colleagues** efficiently. NewAddressBook also supports other features such as keeping track of upcoming meetings, recording the medical histories of your students. --------------------------------------------------------------------------------------------------------------------- +* Table of Contents + {:toc} + +--------------------------------------------------------------------------------------------------------------- ## Quick start @@ -187,10 +185,10 @@ The commands offered are: 3. [Managing Meetings](#managing-meetings) - [Add a meeting](#add-a-meeting--meet) - - [Delete a meeting](#delete-a-meeting) - - [Clear all meetings](#clear-meeting) + - [Delete a meeting](#delete-a-meeting--deletemeeting) + - [Clear all meetings](#clear-meetings--clearmeeting) - [Show meetings window](#show-meetings-window--showmeeting) - - [Quit meetings window](#quit-meetings-window) + - [Quit meetings window](#quit-meetings-window--quitmeeting) 4. [General](#general) - [Exiting the program](#exiting-the-program--exit) @@ -610,7 +608,6 @@ Closes the meeting window. Format: `quitMeeting` - ### General #### Exiting the program : `exit` @@ -648,8 +645,6 @@ empty data file at the next run. In the event that the modification you make cau properly, please manually remove the data file and launch the app again. - - -------------------------------------------------------------------------------------------------------------------- ## FAQ From fe5d15bbdd027acd3567f39a6dbc8fa2b15e36a1 Mon Sep 17 00:00:00 2001 From: Ng Yong Chuan <80570422+random689@users.noreply.github.com> Date: Wed, 27 Oct 2021 20:33:38 +0800 Subject: [PATCH 2/7] Update UserGuide.md --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b1f1f8e3a9d..98387d8b20c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -10,7 +10,7 @@ to help **manage their contacts of their students and colleagues** efficiently. features such as keeping track of upcoming meetings, recording the medical histories of your students. * Table of Contents - {:toc} +{:toc} --------------------------------------------------------------------------------------------------------------- From db20c47bf0dfbfafcae8d0e64497a039fee17a9c Mon Sep 17 00:00:00 2001 From: Ng Yong Chuan <80570422+random689@users.noreply.github.com> Date: Wed, 27 Oct 2021 20:35:24 +0800 Subject: [PATCH 3/7] Update UserGuide.md --- docs/UserGuide.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 98387d8b20c..8f1fb10aa62 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,8 +3,6 @@ layout: page title: User Guide --- -## Introduction - NewAddressBook is a **desktop app built for secondary school teachers** handling large classes to help **manage their contacts of their students and colleagues** efficiently. NewAddressBook also supports other features such as keeping track of upcoming meetings, recording the medical histories of your students. From fcd52a66b5c4ed1949a20973fc2065a8d671977f Mon Sep 17 00:00:00 2001 From: Ng Yong Chuan <80570422+random689@users.noreply.github.com> Date: Wed, 27 Oct 2021 20:42:31 +0800 Subject: [PATCH 4/7] Update UserGuide.md --- docs/UserGuide.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8f1fb10aa62..d61880a0711 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,6 +3,8 @@ layout: page title: User Guide --- +## Introduction + NewAddressBook is a **desktop app built for secondary school teachers** handling large classes to help **manage their contacts of their students and colleagues** efficiently. NewAddressBook also supports other features such as keeping track of upcoming meetings, recording the medical histories of your students. @@ -11,7 +13,6 @@ features such as keeping track of upcoming meetings, recording the medical histo {:toc} --------------------------------------------------------------------------------------------------------------- - ## Quick start 1. Ensure you have Java `11` or above installed in your Computer. @@ -130,7 +131,6 @@ Action | Format | Window **Undo**| `undo` | Both -------------------------------------------------------------------------------------------------------------------- - ## Features
@@ -287,7 +287,6 @@ Edits an existing student in NewAddressBook. Format: `editStudent [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [f/FORM_CLASS] [g/GENDER] [i/INVOLVEMENT] [em/EMERGENCY_NUMBER] [t/TAG]…​` - * Edits the student at the specified `INDEX`. * `INDEX` refers to the index number shown in the displayed student list. The index **must be a positive integer** 1, 2, 3, …​ not exceeding the size of the displayed student list. * At least one of the optional fields must be provided. @@ -483,8 +482,6 @@ Examples: * `editTeacher 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st teacher to be `91234567` and `johndoe@example.com` respectively. * `editTeacher 2 n/Betsy Crower t/` Edits the name of the 2nd teacher to be `Betsy Crower` and clears all existing tags. - - #### Find teachers by name : `findTeacher` Finds teachers whose names contain any of the given keywords. @@ -534,7 +531,6 @@ Shows a list of all teachers stored in NewAddressBook. Format: `listTeachers` - ### Managing Meetings NewAddressBook also allows you to keep track of upcoming meetings with parents, teachers or students. @@ -573,7 +569,6 @@ For example, "2022-02-29" is an invalid date since 2022 is not a leap year. Example: * `meet r/Meeting with Ms.Lee d/2040-07-12 14:30 v/Seminar room 3 w/P` - #### Delete a meeting : `deleteMeeting` Deletes the specified meeting from NewAddressBook. @@ -644,7 +639,6 @@ properly, please manually remove the data file and launch the app again.
-------------------------------------------------------------------------------------------------------------------- - ## FAQ **Q**: How do I transfer my data to another Computer?
From fe32af6e2b262e553a3406e12d8562534833423b Mon Sep 17 00:00:00 2001 From: Ng Yong Chuan <80570422+random689@users.noreply.github.com> Date: Wed, 27 Oct 2021 20:47:16 +0800 Subject: [PATCH 5/7] Update UserGuide.md --- docs/UserGuide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d61880a0711..f08de99e1f1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -622,13 +622,14 @@ Shows a message explaining how to access the help page. Format: `help` -### NewAddressBook Data File +-------------------------------------------------------------------------------------------------------------------- +## NewAddressBook Data File -#### Saving the data +### Saving the data NewAddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. -#### Editing the data file +### Editing the data file NewAddressBook data are saved as a JSON file `[JAR file location]/data/newaddressbook.json`. Advanced users are welcome to update data directly by editing the data file. From 1786f97c54f36f8f0d350854d5402a4132ddddd8 Mon Sep 17 00:00:00 2001 From: Ng Yong Chuan <80570422+random689@users.noreply.github.com> Date: Wed, 27 Oct 2021 20:47:37 +0800 Subject: [PATCH 6/7] Update UserGuide.md --- docs/UserGuide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f08de99e1f1..d00a5f2c1e8 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -2,7 +2,6 @@ layout: page title: User Guide --- - ## Introduction NewAddressBook is a **desktop app built for secondary school teachers** handling large classes From ec69fe2e355c23e5ac3a66883886c68aa2800f8e Mon Sep 17 00:00:00 2001 From: Ng Yong Chuan <80570422+random689@users.noreply.github.com> Date: Wed, 27 Oct 2021 20:53:50 +0800 Subject: [PATCH 7/7] Update UserGuide.md --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d00a5f2c1e8..ca6e17e307e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -568,7 +568,7 @@ For example, "2022-02-29" is an invalid date since 2022 is not a leap year. Example: * `meet r/Meeting with Ms.Lee d/2040-07-12 14:30 v/Seminar room 3 w/P` -#### Delete a meeting : `deleteMeeting` +#### Delete a meeting : `deleteMeeting` Deletes the specified meeting from NewAddressBook. @@ -582,7 +582,7 @@ Examples: * `deleteMeeting 2` deletes the 2nd meeting in the address book. * `deleteMeeting 0` will return an error since the index is not positive. -#### Clear meetings : `clearMeeting` +#### Clear meetings : `clearMeeting` Clears all meetings in NewAddressBook.