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).__
+
@@ -351,6 +382,8 @@ The following command was applied: `find Bernice Yu` followed by `meeting-delet
+
:warning: **Caution:**
@@ -369,15 +402,21 @@ 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:**
+
**First find Bernice:**
+
**Then delete Bernice:**
+
**List all persons and Bernice is deleted:**
+
+
### Setting a person as favourite: `fav`
Sets the specified person from the list as favourite.
@@ -395,10 +434,14 @@ 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.
+
+
### Removing a person as favourite: `unfav`
Removes the specified person from the staff book as favourite.
@@ -418,6 +461,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:**
@@ -437,15 +482,18 @@ 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:**
- 
-
**After:**
- 
+
+
**Before:**
+
+
**After:**
+
**Known limitations:**
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.
@@ -461,6 +509,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:**
@@ -473,6 +523,8 @@ Format: `clear`
+
+
### Exiting the program : `exit`
Exits the program.
@@ -496,6 +548,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.
@@ -513,6 +567,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
@@ -534,6 +590,8 @@ Meeting Start Time | `date` | `30/1/2024 12:12`, `2002-11-15 19:00`, `1-12-2022
+
+
#### Sample Data File Content
```json
@@ -572,6 +630,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?
@@ -583,6 +643,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.
@@ -595,6 +657,8 @@ Meeting Start Time | `date` | `30/1/2024 12:12`, `2002-11-15 19:00`, `1-12-2022
--------------------------------------------------------------------------------------------------------------------
+
+
## Attribute summary
Attribute | Prefix | Restrictions | Examples
@@ -612,6 +676,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
@@ -635,6 +701,8 @@ Yale-NUS College | Yale-NUS
--------------------------------------------------------------------------------------------------------------------
+
+
## Command summary
Action | Format, Examples
diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss
index 23c118ec27d..ed4ceda5e0c 100644
--- a/docs/_sass/minima/_base.scss
+++ b/docs/_sass/minima/_base.scss
@@ -68,6 +68,12 @@ img {
vertical-align: middle;
}
+img:not([class]) {
+ margin-left: auto;
+ margin-right: auto;
+ display: block;
+}
+
/**
diff --git a/docs/diagrams/FavActivityDiagram.puml b/docs/diagrams/FavActivityDiagram.puml
index 6639206ecc6..6038a62ba30 100644
--- a/docs/diagrams/FavActivityDiagram.puml
+++ b/docs/diagrams/FavActivityDiagram.puml
@@ -2,6 +2,8 @@
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12
+skinparam DefaultTextAlignment center
+
start
:User executes fav command;
@@ -10,14 +12,14 @@ start
if () then ([index is valid])
if () then ([Person is favourite])
- :Create new Person with same values but is a favourite;
- :Replace the original Person with the new one;
+ :Create new Person with same\n values but is a favourite;
+ :Replace the original Person\n with the new one;
:Refresh the list of Persons;
else ([else])
- :Show error message to user that person is already a favourite;
+ :Show error message to user\n that person is already a favourite;
endif
else ([else])
- :Show error message to user that index is invalid;
+ :Show error message to user\n that index is invalid;
endif
stop
@enduml
diff --git a/docs/diagrams/UnfavActivityDiagram.puml b/docs/diagrams/UnfavActivityDiagram.puml
index 5ea7049ad97..8ccfd7c3f07 100644
--- a/docs/diagrams/UnfavActivityDiagram.puml
+++ b/docs/diagrams/UnfavActivityDiagram.puml
@@ -2,6 +2,8 @@
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12
+skinparam DefaultTextAlignment center
+
start
:User executes unfav command;
@@ -10,14 +12,14 @@ start
if () then ([index is valid])
if () then ([Person is favourite])
- :Create new Person with same values but is not a favourite;
- :Replace the original Person with the new one;
+ :Create new Person with same\n values but is not a favourite;
+ :Replace the original Person\n with the new one;
:Refresh the list of Persons;
else ([else])
- :Show error message to user that person is already not a favourite;
+ :Show error message to user\n that person is already not a favourite;
endif
else ([else])
- :Show error message to user that index is invalid;
+ :Show error message to user\n that index is invalid;
endif
stop
@enduml
diff --git a/docs/images/FavActivityDiagram.png b/docs/images/FavActivityDiagram.png
index 0e31b079903..b55487b8fe4 100644
Binary files a/docs/images/FavActivityDiagram.png and b/docs/images/FavActivityDiagram.png differ
diff --git a/docs/images/UnfavActivityDiagram.png b/docs/images/UnfavActivityDiagram.png
index cf546759ff8..50529106e46 100644
Binary files a/docs/images/UnfavActivityDiagram.png and b/docs/images/UnfavActivityDiagram.png differ
+
+
+
+