From 281ee6ea5b7be8bd8bd31750ccfb4d8333eeab3b Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:25:59 +0800 Subject: [PATCH 01/16] test width --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 625c8aa72ea..44d968ee149 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png) + ![Ui](images/Ui.png) <img src="images/Ui.png" alt="Ui" width="500"> 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.<br> Some example commands you can try: From 4a2c013811983a1d66f49225a73221038aa04be4 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:41:19 +0800 Subject: [PATCH 02/16] test width --- docs/UserGuide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 44d968ee149..23b8c966aa1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,8 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png) <img src="images/Ui.png" alt="Ui" width="500"> + ![Ui](images/Ui.png){: width="50" } + 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.<br> Some example commands you can try: From dfd5f3e2e3de00d2678128699063c94593b8d889 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:44:33 +0800 Subject: [PATCH 03/16] test width 2 --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 23b8c966aa1..8561df71978 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png){: width="50" } + ![Ui](images/Ui.png){: width="200" } 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.<br> From 63bf092ebd66a1d2396c2a61db22851537a33021 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:49:13 +0800 Subject: [PATCH 04/16] test width 3 --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8561df71978..05b0e3c8d0d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png){: width="200" } + ![Ui](images/Ui.png){: width="350" } 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.<br> From 22d2a8ed62749faa2e10e24a413220141afda499 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:51:21 +0800 Subject: [PATCH 05/16] make 450 --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 05b0e3c8d0d..f41ede738a7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png){: width="350" } + ![Ui](images/Ui.png){: width="450" } 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.<br> From 9bcb663d58820eb4cf334cc3ce4bcaf6b72412d8 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:52:17 +0800 Subject: [PATCH 06/16] make 450 --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f41ede738a7..fe769a1caba 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png){: width="450" } + ![Ui](images/Ui.png){: width="550" } 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.<br> From 8c600aa11cdf1d83309f7a4ae58ef808e182d762 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:54:37 +0800 Subject: [PATCH 07/16] make center --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index fe769a1caba..3baaa4b2921 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png){: width="550" } + ![Ui](images/Ui.png){: width="550" :class="center"} 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.<br> From 80aad6fcc40dc692ad2a594dc7961de30a668d59 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 22:55:50 +0800 Subject: [PATCH 08/16] reset image --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3baaa4b2921..74936e1e863 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -22,7 +22,7 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> - ![Ui](images/Ui.png){: width="550" :class="center"} + ![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.<br> From 154d856c3eceb07f64cbb3c667c1ff49347ca811 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:00:06 +0800 Subject: [PATCH 09/16] reset image --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 74936e1e863..a272b822c57 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -439,7 +439,7 @@ Examples: <div style="page-break-after: always;"></div> * `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) +![Result of fav command](images/AfterFavCommand.png){: width="550": style="text-align: center;"} <div style="page-break-after: always;"></div> From a6e99db985425f0e4c90e285289ab03569133ea1 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:11:12 +0800 Subject: [PATCH 10/16] add break --- docs/UserGuide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a272b822c57..f0519a5ac69 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -264,6 +264,7 @@ format: `filter [m/MODULE] [f/FACULTY] [t/TAG]… [a/AVAILABILITY]…` * Persons matching all fields will be returned (i.e. `AND` search). e.g. `filter m/CS2030S f/Computing` will return `Charlotte Oliveiro` +<div style="page-break-after: always;"></div> Examples: * `filter m/CS1101S` returns `Alex Yeoh` <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png) @@ -439,7 +440,7 @@ Examples: <div style="page-break-after: always;"></div> * `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){: width="550": style="text-align: center;"} +![Result of fav command](images/AfterFavCommand.png) <div style="page-break-after: always;"></div> From d23b45df06a38709ca69109d4ecd4443d38d722e Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:14:24 +0800 Subject: [PATCH 11/16] make small --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f0519a5ac69..7f3111c7512 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -267,7 +267,7 @@ format: `filter [m/MODULE] [f/FACULTY] [t/TAG]… [a/AVAILABILITY]…` <div style="page-break-after: always;"></div> Examples: * `filter m/CS1101S` returns `Alex Yeoh` - <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png) + <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png){: width="550": text-align: "center"} * `filter f/Computing t/professor` returns `Alex Yeoh`, `Charlotte Oliveiro`, `David Li` and `Roy Balakrishman` <br>![result of `filter f/Computing t/professor`](images/AfterFilterCommand2.png) * `filter t/tutor` returns `Bernice Yu`, `Irfan Ibrahim`<br> From f2d4e9cd10c2744cfb99d48f7aa47febd915c5d9 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:16:20 +0800 Subject: [PATCH 12/16] make better --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7f3111c7512..4798302c79d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -267,11 +267,11 @@ format: `filter [m/MODULE] [f/FACULTY] [t/TAG]… [a/AVAILABILITY]…` <div style="page-break-after: always;"></div> Examples: * `filter m/CS1101S` returns `Alex Yeoh` - <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png){: width="550": text-align: "center"} + <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png){: width="450": text-align: "center"} * `filter f/Computing t/professor` returns `Alex Yeoh`, `Charlotte Oliveiro`, `David Li` and `Roy Balakrishman` - <br>![result of `filter f/Computing t/professor`](images/AfterFilterCommand2.png) + <br>![result of `filter f/Computing t/professor`](images/AfterFilterCommand2.png){: width="450": text-align: "center"} * `filter t/tutor` returns `Bernice Yu`, `Irfan Ibrahim`<br> - ![result for 'filter t/tutor'](images/AfterFilterCommand3.png) + ![result for 'filter t/tutor'](images/AfterFilterCommand3.png){: width="450": text-align: "center"} * To illustrate the next example, the sample data are edited first to let `Alex Yeoh`, `Charlotte Oliveiro` and `Irfan Ibrahim` have tags `friend`, `professor` and `youtuber`. They are available on `Monday 12:00 13:00` and `Thursday 12:00 13:00`. <br>![results of the above-mentioned edits](images/BeforeFilterCommand1.png) <br>You can see that for `Roy Balakrishnan`, while he is available on `Monday 12:00 13:00` and `Thursday 12:00 13:00`, he does not have tags `friend` and `youtuber`. From 18437ac01c336dcc1b0d14e6bf21fcab07b68d00 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:18:54 +0800 Subject: [PATCH 13/16] make better --- docs/UserGuide.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 4798302c79d..7f2b81c5d54 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -267,11 +267,15 @@ format: `filter [m/MODULE] [f/FACULTY] [t/TAG]… [a/AVAILABILITY]…` <div style="page-break-after: always;"></div> Examples: * `filter m/CS1101S` returns `Alex Yeoh` - <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png){: width="450": text-align: "center"} + <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png) + +<div style="page-break-after: always;"></div> * `filter f/Computing t/professor` returns `Alex Yeoh`, `Charlotte Oliveiro`, `David Li` and `Roy Balakrishman` - <br>![result of `filter f/Computing t/professor`](images/AfterFilterCommand2.png){: width="450": text-align: "center"} + <br>![result of `filter f/Computing t/professor`](images/AfterFilterCommand2.png) + +<div style="page-break-after: always;"></div> * `filter t/tutor` returns `Bernice Yu`, `Irfan Ibrahim`<br> - ![result for 'filter t/tutor'](images/AfterFilterCommand3.png){: width="450": text-align: "center"} + ![result for 'filter t/tutor'](images/AfterFilterCommand3.png) * To illustrate the next example, the sample data are edited first to let `Alex Yeoh`, `Charlotte Oliveiro` and `Irfan Ibrahim` have tags `friend`, `professor` and `youtuber`. They are available on `Monday 12:00 13:00` and `Thursday 12:00 13:00`. <br>![results of the above-mentioned edits](images/BeforeFilterCommand1.png) <br>You can see that for `Roy Balakrishnan`, while he is available on `Monday 12:00 13:00` and `Thursday 12:00 13:00`, he does not have tags `friend` and `youtuber`. From 14014519322286008a3bd05a471e13b5dadf5500 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:21:05 +0800 Subject: [PATCH 14/16] make better --- docs/UserGuide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7f2b81c5d54..10cb66c36c2 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -268,18 +268,19 @@ format: `filter [m/MODULE] [f/FACULTY] [t/TAG]… [a/AVAILABILITY]…` Examples: * `filter m/CS1101S` returns `Alex Yeoh` <br>![result of `filter m/CS1101S`](images/AfterFilterCommand1.png) - <div style="page-break-after: always;"></div> * `filter f/Computing t/professor` returns `Alex Yeoh`, `Charlotte Oliveiro`, `David Li` and `Roy Balakrishman` <br>![result of `filter f/Computing t/professor`](images/AfterFilterCommand2.png) - <div style="page-break-after: always;"></div> * `filter t/tutor` returns `Bernice Yu`, `Irfan Ibrahim`<br> ![result for 'filter t/tutor'](images/AfterFilterCommand3.png) +<div style="page-break-after: always;"></div> * To illustrate the next example, the sample data are edited first to let `Alex Yeoh`, `Charlotte Oliveiro` and `Irfan Ibrahim` have tags `friend`, `professor` and `youtuber`. They are available on `Monday 12:00 13:00` and `Thursday 12:00 13:00`. <br>![results of the above-mentioned edits](images/BeforeFilterCommand1.png) +<div style="page-break-after: always;"></div> <br>You can see that for `Roy Balakrishnan`, while he is available on `Monday 12:00 13:00` and `Thursday 12:00 13:00`, he does not have tags `friend` and `youtuber`. <br>![Roy Balakrishnan not having other tags](images/BeforeFilterCommand2.png) +<div style="page-break-after: always;"></div> <br>`filter f/soc t/professor t/friend t/youtuber a/mon 12:00 13:00 a/thurs 12:00 13:00` returns `Alex Yeoh`, `Charlotte Oliveiro` and `Irfan Ibrahim`. <br>![result of the command](images/AfterFilterCommand4.png) <div style="page-break-after: always;"></div> From b91c08b12240c7509e9b27d793b5829614673d51 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:28:03 +0800 Subject: [PATCH 15/16] make cli --- docs/UserGuide.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 10cb66c36c2..4233749089b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -23,9 +23,8 @@ StaffConnect (SC) is a **desktop app for managing Professors' and Tutors' contac 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br> A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>__(The data in preview image below may not match with the sample data provided)__<br> ![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.<br> +5. Type the command in the Command Line Interface (CLI) and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br> Some example commands you can try: * `list` : Lists all persons. @@ -196,7 +195,7 @@ Edits an existing person in the staff book. * The displayed view in StaffConnect will reset to the default view after the `edit` command is called. -* The changes made are displayed in the result display above the command box. +* The changes made are displayed in the result display above the Command Line Interface (CLI). </div> Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MODULE] [f/FACULTY] [v/VENUE] [t/TAG]… [a/AVAILABILITY]…` From 15308232c6a44907a30048cfd78222fd040b6562 Mon Sep 17 00:00:00 2001 From: whitesnowx <whitesnowx88@gmail.com> Date: Mon, 15 Apr 2024 23:29:42 +0800 Subject: [PATCH 16/16] change --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 4233749089b..163961f420e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -195,7 +195,7 @@ Edits an existing person in the staff book. * The displayed view in StaffConnect will reset to the default view after the `edit` command is called. -* The changes made are displayed in the result display above the Command Line Interface (CLI). +* The changes made are displayed in the Command Output above the Command Line Interface (CLI). </div> Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MODULE] [f/FACULTY] [v/VENUE] [t/TAG]… [a/AVAILABILITY]…`