diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 41ea758ccc4..dd4b253bf4a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -17,11 +17,11 @@ Here’s an overview of what you can do with TutorConnect: Sounds good, right? On top of these functionalities, we believe in bringing you the most efficient scheduling tool. TutorConnect is **optimised for users who can type fast** and utilise the [Command Line Interface (CLI)](#glossary) to complete tasks using the keyboard faster than using the mouse. --------------------------------------------------------------------------------------------------------------------- +
## Table of Contents * Table of Contents {:toc} --------------------------------------------------------------------------------------------------------------------- +
## Usage of the User Guide @@ -31,9 +31,9 @@ enjoyable experience tracking and scheduling tuition classes. A warm welcome to TutorConnect! Before we dive into the details, let's get you started with a quick overview of how to navigate and use this User Guide successfully. -For **Beginner Users**, we're thrilled to have you onboard! Get started with a [Tutorial](#tutorconnect-tutorial-for-new-users) here. +For :star: **First time users**, we're thrilled to have you onboard! Get started with a [Tutorial](#tutorconnect-tutorial-for-new-users) here. -For **Experienced Users**, thank you for choosing TutorConnect! You may refer to the [Command Summary](#command-summary) here. +For :star::star::star: **Experienced users**, thank you for choosing TutorConnect! You may refer to the [Command Summary](#command-summary) here. ### Navigating the User Guide TutorConnect's User Guide is made with you in mind. It is designed to be user-friendly and easy to navigate. Here are a @@ -44,8 +44,7 @@ few tips for smooth navigation: you to the Table of Contents. ### Common Notation -Throughout this User Guide, you will also find some common notations, to provide you with extra information you may -need. Look out for these coloured boxes! +Throughout this User Guide, you will also find some extra information provided. Look out for these coloured boxes!
@@ -55,6 +54,8 @@ need. Look out for these coloured boxes!
+
+
**:warning: Warning**
@@ -73,7 +74,7 @@ need. Look out for these coloured boxes! [Back To Top](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +
## Quick Start @@ -113,8 +114,7 @@ If the jar file cannot launch on double-click: 2. Type the following command in the terminal: `java -jar TutorConnect.jar` and hit enter. 3. The command should run and launch the application.
- - +
### Navigating the Interface TutorConnect comes equipped with a [GUI](#glossary) interface that provides visual feedback to you. @@ -133,25 +133,27 @@ Below is a quick overview of the various components of our interface. [Back To Top](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +
## TutorConnect Tutorial (for new users) -Hello and welcome to TutorConnect! We're delighted you've chosen our platform to manage your tuition center's tutors and schedules. +Hello and welcome to TutorConnect! We're delighted you've chosen our platform to manage your tuition centre's tutors and schedules. Before we begin, please ensure that you have viewed the following sections of the guide: * [Quick Start](#quick-start) to help you get TutorConnect up and running. -* [Navigating the Interface](#navigating-the-interface) to get you familiarised on how to navigate TutorConnect. +* [Navigating the Interface](#navigating-the-interface) to get you familiarised with navigating TutorConnect. This tutorial aims to guide you through the essential features and functionalities of TutorConnect that you will use on a day-to-day basis. You will be adding your first tutor and corresponding schedule! -Click on any of these below to jump to the respective sections of the guide! +Click on any of these below to jump to the respective sections of the tutorial! * [Start](#start) * [Adding your first tutor](#adding-your-first-tutor) * [Adding your first schedule](#adding-your-first-schedule) * [Marking your schedule as completed](#marking-your-schedule-as-completed) +
+ ### Start ![start](images/tutorial/start.png) @@ -164,9 +166,11 @@ Once you're ready to start using TutorConnect for your tuition centre, you can e Yay! Now it's time to get started with TutorConnect! +
+ ### Adding your first tutor -![add-t](images/tutorial/add-t.png) + Let's say you have a tutor named **John Doe**. He has provided you with his phone number: **9123 4567** and his email address: **johndoe@example.com**. @@ -176,9 +180,11 @@ Here is how you would use the [**add-t**](#adding-a-tutor-add-t) command to add 2. Hit enter 3. Voila! John Doe is now in TutorConnect +
+ ### Adding your first schedule -![add-s](images/tutorial/add-s.png) + Now that your tutors are in TutorConnect, it's time to start scheduling classes for them! @@ -187,20 +193,22 @@ Let's say you have a class on **1 October 2023** from **9AM to 11AM**. Let's assign the class to **John Doe**. Here is how to use the [**add-s**](#adding-a-schedule-add-s) command to assign the schedule to John Doe: -1. Get the **TUTOR_INDEX** of the tutor you wish to assign the schedule to +1. Get the **`TUTOR_INDEX`** of the tutor you wish to assign the schedule to ![tutor-index](images/tutorial/tutor-index.png) 2. Simply type `add-s 1 st/2023-10-01T09:00 et/2023-10-01T11:00` into the command box 3. Hit enter -4. Tada! John Doe now has a schedule on **1 October 2023** from **9AM to 11AM** +4. Tada! John Doe now has a class scheduled on **1 October 2023** from **9AM to 11AM** + +
### Marking your schedule as completed -![mark](images/tutorial/mark.png) + Now that class is over, it is time to mark the schedule as completed! Here is how to use the [**mark**](#marking-a-schedule-mark) command to mark the schedule as completed: -1. Get the **SCHEDULE_INDEX** of the schedule you wish to mark as completed +1. Get the **`SCHEDULE_INDEX`** of the schedule you wish to mark as completed ![schedule-index](images/tutorial/schedule-index.png) 2. Simply type `mark 1 m/1` into the command box 3. Hit enter @@ -209,11 +217,11 @@ Here is how to use the [**mark**](#marking-a-schedule-mark) command to mark the **Congratulations!** You have successfully added your first tutor and schedule, and also marked a schedule as completed in TutorConnect. We hope that this tutorial has helped guide you through the basic features of TutorConnect. Please refer to the [**Features Section**](#features) to see what else TutorConnect can do. -Alternatively, visit the [**FAQ Section**](#faq) to view some frequently asked questions. +Alternatively, you can visit the [**FAQ Section**](#frequently-asked-questions). [Back To Top](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +
## Features From pairing classes with tutors to managing your tuition centre schedules, TutorConnect provides you with a @@ -243,6 +251,8 @@ Let’s add him into TutorConnect. Type in `add-t n/John Doe p/98765432 e/johnd@example.com` and press enter. +
+ **What you can expect to see** Amazing! Tutor John Doe has now been added to the bottom of the displayed list. @@ -257,6 +267,8 @@ Amazing! Tutor John Doe has now been added to the bottom of the displayed list. ![add tutor command](images/addTutorCommandSyntax.png) +
+
**:information_source: Tutor's name**
@@ -312,6 +324,8 @@ Voila! His phone number has now been updated to **87654321**. ![edit tutor](images/editTutor.png) +
+ ##### :star::star::star: Experienced users {:.no_toc} @@ -325,8 +339,8 @@ Here is a list of the error messages you may encounter, when the command is ente | Error Message | Reason | |--------------------------------------------------------------------------------------------|----------------------------------------------------------------------| -| `Invalid command format!` | Invalid or missing TUTOR_INDEX. | -| `The person index provided is invalid` | TUTOR_INDEX entered is not in the range of number of tutors. | +| `Invalid command format!` | Invalid or missing `TUTOR_INDEX`. | +| `The person index provided is invalid` | `TUTOR_INDEX` entered is not in the range of number of tutors. | | `Names should only contain alphanumeric characters and spaces, and it should not be blank` | Tutor name input was either invalid or blank. | | `Phone numbers should only contain numbers, and it should be at least 3 digits long` | Tutor phone number input was either invalid or blank. | | `Emails should be of the format local-part@domain and adhere to the following constraints` | Tutor email input was either invalid or blank[2](#note2). | @@ -360,6 +374,8 @@ Let's use the list tutor command to view the most updated list of tutors! 2. Let's say you have successfully found one tutor named John Doe. 3. Type in `list-t` and press enter to go back to view the full updated list of tutors. +
+ **What you can expect to see** Great job! You have found the full updated list of tutors. @@ -392,11 +408,13 @@ If this has happened to you before, fret not! The find tutor command is here to Type in `find-t john` and press enter. +
+ **What you can expect to see** Tada! You have found tutor **John Doe** (and any other tutors whose name contains John). -![find tutor](images/findTutor.png) + ##### :star::star::star: Experienced users {:.no_toc} @@ -409,9 +427,9 @@ Tada! You have found tutor **John Doe** (and any other tutors whose name contain This command is relatively straight forward to use and has only 1 possible error: -| Error Message | Reason | -|---------------------------|---------------------------------| -| `Invalid command format!` | No search keyword was provided. | +| Error Message | Reason | +|---------------------------|----------------------------| +| `Invalid command format!` | No `KEYWORD` was provided. | Learn more about the [search behaviour1](#note1) and supercharge your search now! @@ -451,19 +469,23 @@ Well done! You have deleted tutor **John Doe**. **Command format** ![delete tutor command](images/deleteTutorCommandSyntax.png) +
+ **Errors you might encounter** Here is a list of the error messages you may encounter, when the command is entered incorrectly: -| Error Message | Reason | -|----------------------------------------|--------------------------------------------------------------| -| `Invalid command format!` | Invalid or missing TUTOR_INDEX. | -| `The person index provided is invalid` | TUTOR_INDEX entered is not in the range of number of tutors. | +| Error Message | Reason | +|----------------------------------------|----------------------------------------------------------------| +| `Invalid command format!` | Invalid or missing `TUTOR_INDEX`. | +| `The person index provided is invalid` | `TUTOR_INDEX` entered is not in the range of number of tutors. | You can also refer to [input information](#input-examples) for details about valid inputs. [Back To Top](#table-of-contents) +
+ ### Schedule Related Features As busy tuition centre coordinators, creating conflict-free schedules is no easy feat. Don't worry! TutorConnect has you covered with our extensive list of features, all about creating and managing scheduling issues. @@ -489,7 +511,16 @@ Type in `add-s 1 st/2023-12-01T09:00 et/2023-12-01T11:00` and press enter. Wow! The new schedule for Bernice Yu has now been added to the list of schedules. -![add schedule](images/addSchedule.png) + + +
+ +**:information_source: Position of new schedule**
+ +Too many schedules? Don’t worry! Upcoming and past schedules are displayed as separate lists. Schedules are also sorted +with those closest to the current date on top. + +
##### :star::star::star: Experienced users {:.no_toc} @@ -500,7 +531,6 @@ Wow! The new schedule for Bernice Yu has now been added to the list of schedules Here is a list of the error messages you may encounter, when the command is entered incorrectly: - | Error Message | Reason | |--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| | `Invalid command format!` | Invalid `TUTOR_INDEX` or some of the tags `st/`, `et/` is missing. | @@ -525,8 +555,8 @@ Edits an existing schedule in TutorConnect. **Scenario** -One day, tutor Bernice Yu requested to change the timing of a class on 15th September, so that it starts at 8am -instead of 9am. +One day, tutor **Bernice Yu** requested to change the timing of a class on **15th September**, so that it starts at **8am** +instead of **9am**. The edit schedule function is here for that! @@ -536,13 +566,14 @@ The edit schedule function is here for that! 2. Let's say the schedule to be updated is in position 1. 3. Type in `edit-s 1 st/2023-09-15T08:00` and press enter. +
+ **What you can expect to see** Tada! The schedule has now been updated to 8am. ![edit schedule](images/editSchedule.png) - ##### :star::star::star: Experienced users {:.no_toc} @@ -556,8 +587,8 @@ Here is a list of the error messages you may encounter, when the command is ente | Error Message | Reason | |--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| -| `Invalid command format!` | Invalid or missing SCHEDULE_INDEX. | -| `The schedule index provided is invalid` | SCHEDULE_INDEX entered is not in the range of number of schedules. | +| `Invalid command format!` | Invalid or missing `SCHEDULE_INDEX`. | +| `The schedule index provided is invalid` | `SCHEDULE_INDEX` entered is not in the range of number of schedules. | | `EndTime should only contain a valid date and time in the format "yyyy-MM-ddTHH:mm", and it should not be blank` | The end time entered is not in the correct datetime format[3](#note3). | | `StartTime should only contain a valid date and time in the format "yyyy-MM-ddTHH:mm", and it should not be blank` | The start time entered is not in the correct datetime format[3](#note3). | | `Multiple values specified for the following single-valued field(s): st/` | More than 1 `st/` was given in the command. | @@ -572,6 +603,8 @@ You can also refer to [input information](#input-examples) for details about val [Back To Top](#table-of-contents) +
+ #### Listing all schedules: `list-s` Displays a list of all schedules in TutorConnect. List can be filtered by tutors assigned or status. @@ -581,7 +614,7 @@ Displays a list of all schedules in TutorConnect. List can be filtered by tutors **Scenario** -You wish to view schedules assigned to tutor **Irfan Ibrahim** that have been marked as `COMPLETED`. +You wish to view schedules assigned to tutor **Irfan Ibrahim** that have been marked as COMPLETED. Use the list schedule function! @@ -593,21 +626,23 @@ Use the list schedule function! **What you can expect to see** Tada! For step 2, the schedule list has now been updated to show schedules assigned to tutor Irfan Ibrahim that are -marked as `COMPLETED`. +marked as COMPLETED. + + -![list schedule tutor completed](images/list-schedules/list-s-tutor-completed.png) +
-**:bulb: Tip**
+**:bulb: `list-s` usage**
Good news! `list-s` command is equipped with various options to view a list of schedules that covers the following scenarios: - `list-s` : To show all schedules. - `list-s TUTOR_INDEX` : To show schedules assigned to the tutor with index `TUTOR_INDEX`. -- `list-s m/0` : To show all schedules marked as `MISSED`. -- `list-s m/1` : To show all schedules marked as `COMPLETED`. -- `list-s TUTOR_INDEX m/0` : To show schedules assigned to the tutor with index `TUTOR_INDEX` marked as `MISSED`. +- `list-s m/0` : To show all schedules marked as MISSED. +- `list-s m/1` : To show all schedules marked as COMPLETED. +- `list-s TUTOR_INDEX m/0` : To show schedules assigned to the tutor with index `TUTOR_INDEX` marked as MISSED.
@@ -616,11 +651,11 @@ scenarios: **Command format** -![list schedule command](images/list-schedules/list-s-syntax.png) +
-**:warning: Optional inputs**
+**:information_source: Optional inputs**
`TUTOR_INDEX` and `m/` are optional fields. You don't need to include them. If you do, make sure that the input is valid! @@ -662,7 +697,7 @@ The find schedule function is here for that! **What you can expect to see** -Tada! The schedule list has now been updated to show schedules assign to tutors whose names contain the word "Bernice". +Tada! The schedule list has now been updated to show schedules assigned to tutors whose names contain the word "Bernice". ![find schedule tutor](images/find-schedules/find-s.png) @@ -680,9 +715,9 @@ Learn more about the [search behaviour1](#note1) and supercharge your Here is a list of the error messages you may encounter, when the command is entered incorrectly: -| Error Message | Reason | -|---------------------------|-----------------------------| -| `Invalid command format!` | No search keyword provided. | +| Error Message | Reason | +|---------------------------|------------------------| +| `Invalid command format!` | No `KEYWORD` provided. | You can also refer to [input information](#input-examples) for details about valid inputs. @@ -709,6 +744,8 @@ Fret not, as you can do just that with the mark command. 2. Let's say the schedule is at position 1. 3. Type in `mark 1 m/1` and press enter. +
+ **What you can expect to see** Yay! The schedule has been marked as COMPLETED. @@ -729,20 +766,22 @@ Yay! The schedule has been marked as COMPLETED. * There are only two types of schedule status: MISSED or COMPLETED. * To set the status of the specified schedule to MISSED, use `m/0` as 0 indicates the MISSED status. * To set the status of the specified schedule to COMPLETED, use `m/1` as 1 indicates the COMPLETED status. -* Any inputs other than 0 or 1 will result in an invalid status message displayed. +* You can provide multiple values for the status field, e.g. `mark 1 m/0 m/0 m/1`. Only the last status field will be + used. In the example earlier, it will use m/1 and set the schedule status to be COMPLETED.
+
+ **Errors you might encounter** Here is a list of the error messages you may encounter, when the command is entered incorrectly: -| Error Message | Reason | -|--------------------------------------------------------------------------|--------------------------------------------------------------------| -| `Invalid command format!` | Invalid or missing SCHEDULE_INDEX or missing schedule status. | -| `The schedule index provided is invalid` | SCHEDULE_INDEX entered is not in the range of number of schedules. | -| `Status has to be either MISSED (m/0) or COMPLETED (m/1)` | Schedule status entered is not 0 or 1. | -| `Multiple values specified for the following single-valued field(s): m/` | More than 1 `m/` was given in the command. | +| Error Message | Reason | +|-----------------------------------------------------------|----------------------------------------------------------------------| +| `Invalid command format!` | Invalid or missing `SCHEDULE_INDEX` or missing schedule status. | +| `The schedule index provided is invalid` | `SCHEDULE_INDEX` entered is not in the range of number of schedules. | +| `Status has to be either MISSED (m/0) or COMPLETED (m/1)` | Schedule status entered is not 0 or 1. | You can also refer to [input information](#input-examples) for details about valid inputs. @@ -768,6 +807,8 @@ Don't worry, as you can do just that with the unmark command. 2. Let's say the schedule to be unmarked is at position 1. 3. Type in `unmark 1` and press enter. +
+ **What you can expect to see** Phew! The schedule has now been unmarked. @@ -785,15 +826,17 @@ Phew! The schedule has now been unmarked. Here is a list of the error messages you may encounter, when the command is entered incorrectly: -| Error Message | Reason | -|------------------------------------------|--------------------------------------------------------------------| -| `Invalid command format!` | Invalid or missing SCHEDULE_INDEX. | -| `The schedule index provided is invalid` | SCHEDULE_INDEX entered is not in the range of number of schedules. | +| Error Message | Reason | +|------------------------------------------|----------------------------------------------------------------------| +| `Invalid command format!` | Invalid or missing `SCHEDULE_INDEX`. | +| `The schedule index provided is invalid` | `SCHEDULE_INDEX` entered is not in the range of number of schedules. | You can also refer to [input information](#input-examples) for details about valid inputs. [Back To Top](#table-of-contents) +
+ #### Deleting a schedule: `delete-s` Deletes a schedule from TutorConnect. @@ -819,6 +862,8 @@ Well done! You have deleted the schedule assigned to **Bernice Yu**. ![delete schedule](images/delete-schedules/delete-s.png) +
+ ##### :star::star::star: Experienced users {:.no_toc} @@ -829,10 +874,10 @@ Well done! You have deleted the schedule assigned to **Bernice Yu**. Here is a list of the error messages you may encounter, when the command is entered incorrectly: -| Error Message | Reason | -|------------------------------------------|-----------------------------------------------------------------| -| `Invalid command format!` | Invalid or missing SCHEDULE_INDEX. | -| `The schedule index provided is invalid` | SCHEDULE_INDEX entered is not in the range of number of tutors. | +| Error Message | Reason | +|------------------------------------------|-------------------------------------------------------------------| +| `Invalid command format!` | Invalid or missing `SCHEDULE_INDEX`. | +| `The schedule index provided is invalid` | `SCHEDULE_INDEX` entered is not in the range of number of tutors. | You can also refer to [input information](#input-examples) for details about valid inputs. @@ -847,7 +892,7 @@ Displays schedules on a specified day as a calendar view. **Scenario** -After adding all your tutor's schedules, you would like to view the schedules on a given day as a calendar. +After adding all your tutors' schedules, you would like to view the schedules on a given day as a calendar. You're in luck with the calendar view command! @@ -864,18 +909,19 @@ Woah look at that! The schedules are now being displayed in a calendar form.
**:bulb: Worried about having too many schedules to view?**
-* The calendar can show schedules for selected tutors only! + 1. Simply use [`find-t`](#locating-tutors-by-name-find-t) to show the tutors first (e.g. `find-t John` to show all tutors with the name John). 2. Now, just use the [`show`](#viewing-calendar-show) command to view their schedules in calendar view on a given date. It's that simple! -**Note**: -* Use [`list-t`](#listing-all-tutors-list-t) before [`show`](#viewing-calendar-show) to view the schedules for all +**Note**: Use [`list-t`](#listing-all-tutors-list-t) before [`show`](#viewing-calendar-show) to view the schedules for all tutors again.
+
+ ##### :star::star::star: Experienced users {:.no_toc} @@ -887,14 +933,14 @@ Woah look at that! The schedules are now being displayed in a calendar form. This command might seem complicated, but it is easy to use with only 1 possible error: -| Error Message | Reason | -|---------------------------|--------------------------| -| `Invalid command format!` | Invalid or missing DATE. | +| Error Message | Reason | +|---------------------------|----------------------------| +| `Invalid command format!` | Invalid or missing `DATE`. |
**:warning: Calendar limitations**
-* Schedules with very short duration will be truncated (only the schedule's index will be displayed). +* Schedules with very short duration may not be displayed correctly (the schedule's information will not be readable). * Using any other commands will hide the calendar view. Use the `show` command to view calendar again.
@@ -903,6 +949,8 @@ You can also refer to [input information](#input-examples) for details about val [Back To Top](#table-of-contents) +
+ ### System Feature Beyond just providing you with powerful features related to tutors and schedule tracking, TutorConnect offers some @@ -928,7 +976,9 @@ Type in `theme blue`. Wow! A whole new colour scheme. -![change theme](images/changeTheme.png) + + +
##### :star::star::star: Experienced users {:.no_toc} @@ -937,19 +987,34 @@ Wow! A whole new colour scheme. ![theme command](images/themeCommandSyntax.png) +
+ +**:information_source: Extra `NEW_THEME` inputs are ignored**
+ +The theme command is a lenient one! Only the first input you provide is used. Any additional inputs thereafter will be +ignored. + +For example: +- `theme blue white`, is equivalent to `theme blue`. +- `theme white blue`, is equivalent to `theme white` and will encounter an error message. + +
+ **Errors you might encounter** Here is a list of the error messages you may encounter, when the command is entered incorrectly: -| Error Message | Reason | -|---------------------------------|-----------------------------------------------------| -| `Invalid command format!` | New theme field was left blank and not specified. | -| `Theme provided does not exist` | New theme field was not `dark`, `light` or `blue`. | +| Error Message | Reason | +|---------------------------------|------------------------------------------------------| +| `Invalid command format!` | `NEW_THEME` field was left blank and not specified. | +| `Theme provided does not exist` | `NEW_THEME` field was not `dark`, `light` or `blue`. | You can also refer to [input information](#input-examples) for details about valid inputs. [Back To Top](#table-of-contents) +
+ #### Clearing all data: `clear` Clears all data in TutorConnect. @@ -983,6 +1048,8 @@ That's it. It's all gone. TutorConnect should now display an empty address book. ![clear addressbook](images/clearAddressBook.png) +
+ ##### :star::star::star: Experienced users {:.no_toc} @@ -998,7 +1065,7 @@ Opens a window with instructions for getting help. **Scenario** -Unsure on how to use a command? Encountered an unknown error? +Unsure of how to use a command? Encountered an unknown error? Get help from within the app by using the help command! @@ -1011,7 +1078,7 @@ Type in `help` and press enter. Is that a bird? Is that a plane? Nope, it's the help window! -![help window](images/helpWindow.png) +
@@ -1023,6 +1090,7 @@ The help window can also be accessed by the button in the menu bar (above the co [Back To Top](#table-of-contents) +
#### Exiting the program: `exit` @@ -1042,7 +1110,50 @@ TutorConnect closes and the program stops, going into deep slumber, disappearing [Back To Top](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +#### Saving the data + +All your data in TutorConnect is automatically saved in your computer. No more worrying about losing your unsaved data! + +##### :star::star::star: Experienced users +{:.no_toc} + +
+ +**:warning: Exiting the app**
+ +To prevent any unexpected behaviour in TutorConnect, exit the app using only the [`exit command`](#exiting-the-program-exit) or +the close window button. + +Do not stop the app from the command terminal (using [Windows](https://www.lifewire.com/open-command-prompt-in-a-folder-5185505) or [Mac](https://support.apple.com/en-sg/guide/terminal/trmlb20c7888/mac#:~:text=On%20your%20Mac%2C%20open%20a,window%3A%20Choose%20Open%20in%20Terminal)). + +
+ +[Back To Top](#table-of-contents) + +
+ +#### Editing the data + +##### :star::star::star: Experienced users +{:.no_toc} + +TutorConnect supports manual edits to the data file created locally in your computer. +Advanced users are welcome to update data directly by editing that data file. + +
+ +**:warning: Invalid edits to data file**
+ +If your changes make the data file invalid, TutorConnect will discard all data at the next run. This data +cannot be recovered so proceed with caution! + +As such, TutorConnect highly recommends you to make a backup of the file before you edit it. + +
+ +[Back To Top](#table-of-contents) + +
## Frequently Asked Questions Have some burning questions you want answered? Check out this FAQ section to find out if others have had the same @@ -1068,9 +1179,9 @@ question! [Back To Top](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +
-## Known issues +## Known Issues TutorConnect is always looking to improve. Currently, there are a few known issues within the app that our development team is working round the clock to solve. Don't worry, every version of TutorConnect released for you to @@ -1085,7 +1196,7 @@ use is sure to solve your scheduling needs. [Back To Top](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- +
## Glossary @@ -1100,32 +1211,32 @@ Here are some descriptions of the words you might come across in the User Guide: ### Input Examples -| Input Fields | ✅ | ❌ | -|------------------------------------|--------------------------------------------------|-----------------------------------------------| -| `n/NAME` | John Doe, John Doe123 | John@Doe | -| `p/PHONE NUMBER` | 98765432, 987 | abc, 98 | -| `e/EMAIL` | johnd@example.com,
jo@example123-example.com | johnd, johnd@p | -| `st/START_TIME`
`et/END_TIME` | 2023-09-15T09:00,
2023-09-15T11:00 | 2023-09-15 09:00,
2023-09-15T09 | -| `m/SCHEDULE STATUS` | 0, 1 | 3, abc | -| `TUTOR_INDEX`
`SCHEDULE_INDEX` | 1 | 0, abc | -| `DATE` | 2023-09-15 | 2023-09-15T09:00 | -| `NEW_THEME` | dark, light, blue | white, brown, black | +| Input Fields | :heavy_check_mark: | :x: | +|------------------------------------|--------------------------------------------------|-------------------------------------| +| `n/NAME` | John Doe, John Doe123 | John@Doe | +| `p/PHONE NUMBER` | 98765432, 987 | abc, 98 | +| `e/EMAIL` | johnd@example.com,
jo@example123-example.com | johnd, johnd@p | +| `st/START_TIME`
`et/END_TIME` | 2023-09-15T09:00,
2023-09-15T11:00 | 2023-09-15 09:00,
2023-09-15T09 | +| `m/SCHEDULE STATUS` | 0, 1 | 3, abc | +| `TUTOR_INDEX`
`SCHEDULE_INDEX` | 1 | 0, abc | +| `DATE` | 2023-09-15 | 2023-09-15T09:00 | +| `NEW_THEME` | dark, light, blue | white, brown, black | ### Input Information Here are some inputs you might come across in the User Guide: -| Input | Description | Limitations | -|---------------------|---------------------------------------------------|----------------------------------------------------------------------------------------------| -| `n/NAME` | Refers to the name of the tutor. | Only contain alphanumeric characters and spaces, and
should
not be blank. | -| `p/PHONE NUMBER` | Refers to the phone number of the tutor. | Only contain numbers, and should be at least 3
digits long. | -| `e/EMAIL` | Refers to the email address of the tutor. | Of the format local-part@domain[2](#note2). | -| `st/START_TIME` | Refers to the start time of the schedule. | Only datetime in `yyyy-MM-ddTHH:mm`[3](#note3) format is accepted. | -| `et/END_TIME` | Refers to the end time of the schedule. | Only datetime in `yyyy-MM-ddTHH:mm`[3](#note3) format is accepted. | -| `m/SCHEDULE STATUS` | Refers to the status of schedule in the list. | Only numerical inputs of 0 for MISSED status and 1 for COMPLETED status is accepted | -| `TUTOR_INDEX` | Refers to the position of tutor in the list. | Only numerical input that ranges from 1 to the last tutor shown in the list of tutors. | -| `SCHEDULE_INDEX` | Refers to the position of schedule in the list. | Only numerical input that ranges from 1 to the last schedule shown in the list of schedules. | -| `DATE` | Refers to the date to view schedules for. | Only date in `yyyy-MM-dd` format is accepted. | -| `NEW_THEME` | Refers to the name of the new theme to switch to. | Only `dark`, `light` and `blue` themes are supported. | +| Input | Description | Limitations | +|---------------------|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `n/NAME` | Refers to the name of the tutor. | Only contain alphanumeric characters and spaces, and should not be blank. | +| `p/PHONE NUMBER` | Refers to the phone number of the tutor. | Only contain numbers, and should be at least 3 digits long. | +| `e/EMAIL` | Refers to the email address of the tutor. | Of the format local-part@domain[2](#note2). | +| `st/START_TIME` | Refers to the start time of the schedule. | Only datetime in `yyyy-MM-ddTHH:mm`[3](#note3) format is accepted. | +| `et/END_TIME` | Refers to the end time of the schedule. | Only datetime in `yyyy-MM-ddTHH:mm`[3](#note3) format is accepted. | +| `m/SCHEDULE STATUS` | Refers to the status of schedule in the list. | Only numerical inputs of 0 for MISSED status and 1 for COMPLETED status is accepted | +| `TUTOR_INDEX` | Refers to the position of tutor in the list. | Only numerical input that ranges from 1 to the last tutor shown in the list of tutors.
Additionally, the input cannot be greater than 2147483647. | +| `SCHEDULE_INDEX` | Refers to the position of schedule in the list. | Only numerical input that ranges from 1 to the last schedule shown in the list of schedules.
Additionally, the input cannot be greater than 2147483647. | +| `DATE` | Refers to the date to view schedules for. | Only date in `yyyy-MM-dd` format is accepted. | +| `NEW_THEME` | Refers to the name of the new theme to switch to. | Only `dark`, `light` and `blue` themes are supported. | **1 `KEYWORD` Search Format and Behaviour** @@ -1145,8 +1256,8 @@ Commands reference: [add-t](#adding-a-tutor-add-t), [edit-t](#editing-a-tutor-ed 2. This is followed by a '@' and then a domain name. The domain name is made up of domain labels separated by periods. The domain name must: -* end with a domain label at least 2 characters long -* have each domain label start and end with alphanumeric characters +* end with a domain label at least 2 characters long. +* have each domain label start and end with alphanumeric characters. * have each domain label consist of alphanumeric characters, separated only by hyphens, if any. @@ -1162,9 +1273,10 @@ Commands reference: [add-s](#adding-a-schedule-add-s), [edit-s](#editing-a-sched [Back To Top](#table-of-contents) --------------------------------------------------------------------------------------------------------------------- -## Command summary +
+ +## Command Summary | Action | Format, Examples | |---------------------------------------------------------|------------------------------------------------------------------------------------------------------------| diff --git a/docs/images/editTutor.png b/docs/images/editTutor.png index f28d4c1dda7..bb764db5a3d 100644 Binary files a/docs/images/editTutor.png and b/docs/images/editTutor.png differ