Skip to content

Commit

Permalink
Merge pull request #264 from Pluiexo/branch-BugFixMeeting
Browse files Browse the repository at this point in the history
Update Documentation on the limitations of meetings
  • Loading branch information
iynixil authored Apr 15, 2024
2 parents c879a23 + 4d22c29 commit 362e171
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Format: `meeting-add INDEX d/DESCRIPTION s/DATETIME`

* Adds a meeting to the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3,…​ and tally within range index of the displayed list.
* Both of the fields must be provided and valid values.
* A valid `DESCRIPTION` of the meeting can only contain latin alphanumeric characters.
* A valid `DESCRIPTION` of the meeting can only contain latin alphanumeric characters and is case-sensitive.
* A valid `DATETIME` of the meeting can only contain valid date and 24 hour time values with a single space to separate the date and time. Multiple formats are allowed.
* Date Formats
- Separators: `-`
Expand All @@ -286,8 +286,9 @@ Format: `meeting-add INDEX d/DESCRIPTION s/DATETIME`
1. `HH:mm`
2. `H:mm`
3. `HHmm`
* Duplicate meetings with the same `DESCRIPTION` and `DATETIME` in the same person is not allowed.
* Duplicate meetings with the same `DESCRIPTION` and `DATETIME` for the same person is not allowed. `DESCRIPTION` only matches its duplicate when both case sensitivity matches.
* Meetings with the same `DESCRIPTION` and `DATETIME` does not need to be unique among persons in staff book.
* StaffConnect does not limit the flexibility for users, hence the user is able to add any meeting at any point of time and even meetings of different topics at the same time.

Examples:
* `meeting-add 1 d/Meet for finals preparation s/12/04/2024 18:00` adds a meeting to the first person with the description of `Meet for finals preparation` and the date and time of `12/04/2024 18:00`
Expand All @@ -313,10 +314,12 @@ Format: `meeting-delete INDEX i/MEETING-INDEX `
* The meeting-index refers to the index number shown in the displayed meeting list.
* The meeting-index **must be a positive integer** 1, 2, 3,…​ and tally within range index of the displayed meeting list.
* The meeting from the person must exist before it can be deleted otherwise an error will be displayed.

Examples:
* The following commands assumes that meetings have been added prior to the command. Otherwise, an error will be thrown. <br> **(Refer to the section above on how to add a meeting)**
* `list` followed by `meeting-delete 1 i/1` deletes the 1st meeting from the 1st person in the list.
* `find Bernice Yu` followed by `meeting-delete 1 i/2` deletes the 1st meeting form the 1st person in the results of the `find` command.
<br>The following commands assumes that meetings have been added prior to the command. Otherwise, an error will be thrown. <br> **(Refer to the section above on how to add a meeting)**
* `list` followed by `meeting-delete 1 i/1` deletes the 1st meeting from the 1st person in the list.
* `meeting-delete 1 i/3` deletes the 3rd meeting from the 1st person in the current displayed contacts list.
* `find Bernice Yu` followed by `meeting-delete 1 i/2` deletes the 1st meeting from the 1st person in the results of the `find` command.

<br>**Results for delete meeting:**<br>
The following command was applied: `find Bernice Yu` followed by `meeting-delete 1 i/2`.
Expand Down Expand Up @@ -550,7 +553,11 @@ 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?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous StaffConnect home folder.
**A**: Install the app in the other computer and overwrite the generated data file with the file that contains the data from your current StaffConnect device.<br>
**Q**: Why are concurrent or past meetings allowed? <br>
**A**: This is to allow greater flexibility for users who wish to segregate meetings of different topics happening concurrently or users who wish to store meetings in the past for bookkeeping purposes etc..
**Q**: Why are meeting's description with the same content but different case-sensitivity allowed?
**A**: Sometimes the user would like to have finer control over how they want to differentiate between topics, and a single capital letter could make that difference.

--------------------------------------------------------------------------------------------------------------------

Expand All @@ -563,6 +570,7 @@ Meeting Start Time | `date` | `30/1/2024 12:12`, `2002-11-15 19:00`, `1-12-2022
5. **When adding/editing venues containing space with an attribute prefix**, If you try to add a venue such as `Room 12 t/r`, the application will add a person with a venue `Room 12` and a tag `r` instead of the intended venue `Room 12 t/r`. The venue is not intended to store venues that contains a space followed by an attribute prefix but users can consider omitting the space or replace with a hyphen such as `Room 12t/r` or `Room 12-t/r` as a workaround.
6. **When generating the default file and exiting via the `Exit` button**, If you try to generate the default JSON file `[JAR file location]/data/staffconnect.json` by running the JAR file, without manipulating any data and exiting via the `Exit` button, the JSON file would not be generated. You may consider using the `exit` command via the command line interface to generate the default JSON file instead.


--------------------------------------------------------------------------------------------------------------------

## Attribute summary
Expand Down

0 comments on commit 362e171

Please sign in to comment.