From 1f21a55605f3f8d2261f7cbfc2449be761cb9b0e Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 18:38:41 +0800 Subject: [PATCH 01/11] Add page breaks in UG --- docs/UserGuide.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1465e5e360f..5545a86b66d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -10,6 +10,8 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac -------------------------------------------------------------------------------------------------------------------- +
+ ## Quick start 1. Ensure you have Java `11` or above installed in your Computer. @@ -39,6 +41,8 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac -------------------------------------------------------------------------------------------------------------------- +
+ ## Navigability ### Overall UI layout @@ -59,6 +63,8 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac *Note that Persons List Scrollbar will open appear when the number of Persons in the list exceed the amount to be displayed by the view. *Note that the `Exit` button is in the dropdown of the `File` button. +
+ ### Mouse and Keyboard controls Before we get started StaffConnect offers a unique suite of UI controls for users to customise their own unique experience! @@ -90,6 +96,7 @@ Before we get started StaffConnect offers a unique suite of UI controls for user 5. The Command box:
The input can only be scrolled by __[Holding Left Click + Drag Mouse]__ to the edge in the direction to scroll. This is to allow making adjustments on very long commands. +


### Alternative UI arrangements @@ -106,6 +113,7 @@ Before we get started StaffConnect offers a unique suite of UI controls for user -------------------------------------------------------------------------------------------------------------------- +
## Features @@ -139,7 +147,6 @@ Shows a message explaining how to access the help page. Format: `help` - ### Adding a person: `add` Adds a person to the staff book. @@ -267,6 +274,8 @@ Examples: * `sort p/` returns person by ascending phone numbers `87438807`, `91031282` followed by `92492021`
![result for 'sort p/'](images/sortByPhoneNumberResult.png) +
+ ### Adding a meeting to a person: `meeting-add` Add a meeting to a person based on specified description and date. @@ -311,6 +320,8 @@ Examples:
**Result for add meeting:**
`meeting-add 1 d/Meet for finals preparation s/12/04/2024 18:00`
![result for 'meeting-add 1 d/Meet for finals preparation s/12/04/2024 18:00'](images/addMeetingResult.png) +
+ ### Deleting a meeting from a person: `meeting-delete`
:warning: **Caution:** @@ -487,6 +498,8 @@ The application will not prompt the user if the format of the data file is incor
+
+ #### Valid Data Values for `Person` in JSON file All attributes' restrictions except **Favourite** can be found in the [Attribute Summary](#attribute-summary) table. @@ -504,6 +517,8 @@ Availabilitity | `availabilities` | `TUESDAY 12:00 13:00`, `WEDNESDAY 12:00 13:0 Meeting | `meetings` | Refer to the [Valid Data Values in meetings](#valid-data-values-for-meetings-for-each-person-in-json-file) table. Favourite | `favourite` | `Favourite` or `Not favourite` +
+ #### Valid Data Values for `Meetings` (for each `Person`) in JSON file Attribute | Meeting Data Fields | Valid Values @@ -525,6 +540,8 @@ Meeting Start Time | `date` | `30/1/2024 12:12`, `2002-11-15 19:00`, `1-12-2022 +
+ #### Sample Data File Content ```json @@ -563,6 +580,8 @@ Meeting Start Time | `date` | `30/1/2024 12:12`, `2002-11-15 19:00`, `1-12-2022 -------------------------------------------------------------------------------------------------------------------- +
+ ## FAQ **Q**: How do I transfer my data to another Computer?
@@ -574,6 +593,8 @@ Meeting Start Time | `date` | `30/1/2024 12:12`, `2002-11-15 19:00`, `1-12-2022 -------------------------------------------------------------------------------------------------------------------- +
+ ## Known issues 1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. @@ -586,6 +607,8 @@ Meeting Start Time | `date` | `30/1/2024 12:12`, `2002-11-15 19:00`, `1-12-2022 -------------------------------------------------------------------------------------------------------------------- +
+ ## Attribute summary Attribute | Prefix | Restrictions | Examples @@ -603,6 +626,8 @@ Meeting Start Time | s/ | Valid date and time format.
1. Valid date formats: [^1]: These are mandatory attributes when adding a person into the staff book, as these are important information for students to know when/where to consult their professors/TAs. +
+ ### Valid `Faculty` Values Faculty | Other names @@ -626,6 +651,8 @@ Yale-NUS College | Yale-NUS -------------------------------------------------------------------------------------------------------------------- +
+ ## Command summary Action | Format, Examples From 742884fe58c8ad258b57a318edd8441339623c57 Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 18:47:18 +0800 Subject: [PATCH 02/11] Add more pagebreaks in UG --- docs/UserGuide.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 5545a86b66d..3acb4c09767 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -5,6 +5,8 @@ title: User Guide StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contact information and associated meetings, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, SC can get your contact management tasks done faster than traditional GUI apps. +
+ * Table of Contents {:toc} @@ -48,6 +50,8 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac ### Overall UI layout
![UI General](images/UiAnnotationsLayout.png) +
+ #### [UI] Persons Info
![UI General](images/UiAnnotationsAttributes.png) *Note that the availability will not be displayed in sequential order. @@ -55,9 +59,13 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac * The values of [`Faculty`](#valid-faculty-values) will be stored to their full names. * The values of `day` part of `Availability` will be stored as their full form such as `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`. +
+ #### [UI] Meeting List
![UI General](images/UiAnnotationsMeetingList.png) +
+ #### [UI] Scrollbars and Menu
![UI General](images/UiAnnotationsScrollbarsAndMenu.png) *Note that Persons List Scrollbar will open appear when the number of Persons in the list exceed the amount to be displayed by the view. @@ -147,6 +155,8 @@ Shows a message explaining how to access the help page. Format: `help` +
+ ### Adding a person: `add` Adds a person to the staff book. @@ -168,6 +178,8 @@ Examples: ![Effects of an add command](images/AfterAddCommand.png) +
+ ### Listing all persons : `list` Shows a list of all persons in the staff book. @@ -210,6 +222,8 @@ Examples:
**After editing the second person:**
![After editing the second person](images/AfterEditCommand.png) +
+ ### Locating persons by name: `find` Finds persons whose names contain any of the given keywords. @@ -229,6 +243,8 @@ Examples: * `find alex david` returns `Alex Yeoh`, `David Li`
![result for 'find alex david'](images/findAlexDavidResult.png) +
+ ### Filtering persons: `filter` Filters persons whose module, faculty, tags or availabilities match the given filtering criteria. @@ -253,6 +269,7 @@ Examples: * `filter t/tutor` returns `Bernice Yu`, `Irfan Ibrahim`
![result for 'filter t/tutor'](images/filterTutorTagResult.png) +
### Sorting persons: `sort` @@ -355,6 +372,8 @@ The following command was applied: `find Bernice Yu` followed by `meeting-delet

**After `meeting-delete 1 i/1`:**
![result for after `find Bernice Yu` followed by `meeting-delete 1 i/2`](images/meetingDeleteResultAfter2.png) +
+ ### Deleting a person : `delete`
:warning: **Caution:** @@ -382,6 +401,8 @@ Examples:
**List all persons and Bernice is deleted:**
![Result of deletion](images/AfterDeleteCommand2.png) +
+ ### Setting a person as favourite: `fav` Sets the specified person from the list as favourite. @@ -403,6 +424,8 @@ Examples: ![Result of fav command](images/AfterFavCommand.png) +
+ ### Removing a person as favourite: `unfav` Removes the specified person from the staff book as favourite. @@ -422,6 +445,8 @@ Examples: * `sort p/` followed by `fav 1` removes the 1st person as favourite in the staff book in the results of the `sort` command, which should be the person with the smallest phone number. * `find Betsy` followed by `unfav 1` removes the 1st person as favourite in the results of the `find` command. +
+ ### Refreshing and clearing all outdated meetings: `refresh`
:warning: **Caution:** @@ -449,6 +474,8 @@ Examples: Refresh is only used when the user decides to remove clutter in the staff book, and wants to remove outdated meetings. This process is not done automatically as sometimes the user would like to retain old meetings for bookkeeping purposes. +
+ ### Selecting the person to display: `select` Selects the person identified by their current displayed index number to display their attributes and meeting list. @@ -464,6 +491,8 @@ Examples: * `filter t/tutor` followed by `select 1`
Selects the 1st person in the results of the `filter` command. * `sort p/` followed by `select 1`
Selects the 1st person in the results of the `sort` command, which should be the person with the smallest phone number. +
+ ### Clearing all entries : `clear`
:warning: **Caution:** @@ -476,6 +505,8 @@ Format: `clear` ![Effects of clear command](images/AfterClearCommand.png) +
+ ### Exiting the program : `exit` Exits the program. From c98f3088d02e399edbee2a3048de9ce0f9fca88e Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 18:54:17 +0800 Subject: [PATCH 03/11] Add TOC subheader --- docs/UserGuide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3acb4c09767..009667daf14 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -7,6 +7,8 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac
+## Table of Contents + * Table of Contents {:toc} From e20c31aec7a19831a5cb86276e9e5ec5c5a9119e Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 19:01:09 +0800 Subject: [PATCH 04/11] Remove space between TOC and Quick Start of UG --- docs/UserGuide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 009667daf14..2fb9f66a43e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -13,7 +13,6 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac {:toc} -------------------------------------------------------------------------------------------------------------------- -
## Quick start From de866974a45d716e59905db43e71312e213c7686 Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 19:02:55 +0800 Subject: [PATCH 05/11] Edit TOC formatting --- docs/UserGuide.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 2fb9f66a43e..784a24dceac 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -8,10 +8,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac
## Table of Contents - -* Table of Contents {:toc} - --------------------------------------------------------------------------------------------------------------------
From 0519f02da0bda23ead9fbc95bf8a6dde64830b7a Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 19:19:17 +0800 Subject: [PATCH 06/11] Remove divider between TOC and Quick Start in UG --- docs/UserGuide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 784a24dceac..dbcd2d5f020 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -8,8 +8,10 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac
## Table of Contents + +* Table of Contents {:toc} --------------------------------------------------------------------------------------------------------------------- +
## Quick start From 7c3116f0900a96976234c0ed893c566387d66cf8 Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 20:21:12 +0800 Subject: [PATCH 07/11] Remove TOC header --- docs/UserGuide.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index dbcd2d5f020..72f9d8df67b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -7,8 +7,6 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac
-## Table of Contents - * Table of Contents {:toc} From efcc22ed0d6576c2cd9321f88e1622fffae4bfe1 Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 20:44:49 +0800 Subject: [PATCH 08/11] Add more page breaks in UG --- docs/UserGuide.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 72f9d8df67b..8275e50853d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -81,6 +81,7 @@ Before we get started StaffConnect offers a unique suite of UI controls for user
Hovering the selection with mouse or arrow keys would not cause the details panel to switch to the selected person. This is to allow users to browse the persons list panel without switching.
![Region to select the person](images/personPanelRegion.png) +
2. There is a divider that is draggable up and down to hide and show details on the right side and to customise the look of your application.
![Region to select the divider](images/detailsDividerRegion.png) @@ -363,6 +364,7 @@ Examples:
**Results for delete meeting:**
The following command was applied: `find Bernice Yu` followed by `meeting-delete 1 i/2`.
__(Disclaimer: The content shown in the examples may not match what you have added to your own meetings within the staff book).__ +


**After `find Bernice Yu`:**
![result for before `find Bernice Yu` followed by `meeting-delete 1 i/2`](images/meetingDeleteResultBefore.png)

**After `meeting-delete 1 i/2`:**
@@ -390,12 +392,16 @@ Examples: * `list` followed by `delete 2` deletes the 2nd person in the list. * `sort p/` followed by `delete 1` deletes the 1st person in the list in the results of the `sort` command, which should be the person with the smallest phone number. * `find Bernice Yu` followed by `delete 1` deletes the 1st person in the results of the `find` command. +

**Before deletion:**
![All persons listed](images/BeforeDeleteCommand1.png) +

**First find Bernice:**
![Result of finding Bernice](images/BeforeDeleteCommand2.png) +

**Then delete Bernice:**
![Result of deletion](images/AfterDeleteCommand1.png) +

**List all persons and Bernice is deleted:**
![Result of deletion](images/AfterDeleteCommand2.png) @@ -463,10 +469,11 @@ Examples: * If there is a meeting `Avengers Assemble` that happened in `31/08/1939 12:00`, when the user types in `refresh`, it will be deleted. * If there is a meeting `French Revolution` that happened in `14/07/1789 12:00`, when the user types in `refresh`, it will be deleted. * If there is a meeting `Future Meeting` that will happen in `31/12/2999 12:00`, when the user types in `refresh`, it will not be deleted. -
**Before:**
- ![Before refreshing](images/BeforeRefreshCommand.png) -
**After:**
- ![After refreshing](images/AfterRefreshCommand.png) +
+
**Before:**
+![Before refreshing](images/BeforeRefreshCommand.png) +
**After:**
+![After refreshing](images/AfterRefreshCommand.png) **Known limitations:** Refresh is only used when the user decides to remove clutter in the staff book, and wants to remove outdated meetings. From 93ac1b0fdae00c918feff812d653b7c085e1d0dd Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 21:00:54 +0800 Subject: [PATCH 09/11] Add even more page breaks --- docs/UserGuide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8275e50853d..3233346db8a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -24,6 +24,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
__(The data in preview image below may not match with the sample data provided)__
![Ui](images/Ui.png) +
5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
Some example commands you can try: @@ -93,6 +94,8 @@ Before we get started StaffConnect offers a unique suite of UI controls for user - Keyboard arrow keys are able to pan around as well, but the scroll speed may differ on different systems. - There are scroll bars at the vertical and horizontal dividers of the window pane, dragging them in the respective direction will pan around as well. +
+ 4. The Result display:
The scroll bars can only be scrolled by two ways: 1. For mouse pad users, dragging around with two fingers the around would pan around the pane. @@ -211,6 +214,7 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MODULE] [f/FACULTY] [v/VENUE * `PHONE_NUMBER`, `EMAIL`, `MODULE`, `FACULTY`, `VENUE` do not need to be unique and can be duplicated among persons in staff book. * `TAG` and `AVAILABILITY` have to be unique for a person but can be duplicated among persons in staff book. +
Examples: * `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. * `edit 3 m/GEA1000` Edits the module of the 3rd person to be `GEA1000`. @@ -287,6 +291,7 @@ Format: `sort [n/] [p/] [m/] [f/] [v/] [s/] [meet/]` Examples: * `sort m/ p/` returns person by ascending module codes followed by ascending phone numbers `CS2000 80000000`, `CS2000 90000000`, `CS3000 80000000`followed by `CS3000 90000000` * `sort n/` returns person by ascending names `Alex`, `Bernice` followed by `Charlotte` +
* `sort p/` returns person by ascending phone numbers `87438807`, `91031282` followed by `92492021`
![result for 'sort p/'](images/sortByPhoneNumberResult.png) @@ -424,6 +429,8 @@ Format: `fav INDEX` Examples: * `list` followed by `fav 2` sets the 2nd person as favourite in the staff book. * `sort p/` followed by `fav 1` sets the 1st person as favourite in the staff book in the results of the `sort` command, which should be the person with the smallest phone number. + +
* `find Betsy` followed by `fav 1` sets the 1st person as favourite in the results of the `find` command. ![Result of fav command](images/AfterFavCommand.png) From 4905842a47a13eaf4a7a2fa9859d733900d54a15 Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 21:08:08 +0800 Subject: [PATCH 10/11] Adjust page breaks --- docs/UserGuide.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3233346db8a..c89dc1b6521 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -24,7 +24,6 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
__(The data in preview image below may not match with the sample data provided)__
![Ui](images/Ui.png) -
5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
Some example commands you can try: @@ -82,8 +81,6 @@ Before we get started StaffConnect offers a unique suite of UI controls for user
Hovering the selection with mouse or arrow keys would not cause the details panel to switch to the selected person. This is to allow users to browse the persons list panel without switching.
![Region to select the person](images/personPanelRegion.png) -
- 2. There is a divider that is draggable up and down to hide and show details on the right side and to customise the look of your application.
![Region to select the divider](images/detailsDividerRegion.png) @@ -94,8 +91,6 @@ Before we get started StaffConnect offers a unique suite of UI controls for user - Keyboard arrow keys are able to pan around as well, but the scroll speed may differ on different systems. - There are scroll bars at the vertical and horizontal dividers of the window pane, dragging them in the respective direction will pan around as well. -
- 4. The Result display:
The scroll bars can only be scrolled by two ways: 1. For mouse pad users, dragging around with two fingers the around would pan around the pane. From 84c7ad0ee330907a6563a8601e952a380cbe0534 Mon Sep 17 00:00:00 2001 From: iynixil Date: Mon, 15 Apr 2024 21:12:57 +0800 Subject: [PATCH 11/11] Add one page break in UG --- docs/UserGuide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c89dc1b6521..acc7576aff8 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -171,6 +171,8 @@ A person can have any number of tags and availabilities (including 0) Examples: * `add n/John Doe p/98765432 e/johnd@example.com f/Computing v/John street, block 123, #01-01 m/CS2103` * `add n/Chihiro Ogino m/GEC1024 e/spirited@example.com f/FASS v/The Spirit Realm p/20122001 a/tues 21:00 22:00 a/wednesday 00:00 23:59` + +
* `add n/Betsy Crowe t/friend m/CS2103T e/betsycrowe@example.com f/Computing v/Newgate Prison p/1234567 t/criminal a/monday 11:00 12:00 a/wednesday 14:00 16:00` ![Effects of an add command](images/AfterAddCommand.png)