@@ -244,9 +272,6 @@ Examples:
* `edit 1 r/volunteer 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 2 r/befriendee n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
-[//]: # (Page Break:)
-
-
#### 3.1.3 Pairing a befriendee and volunteer : `pair`
Pairs an existing befriendee and volunteer in Elder Scrolls.
@@ -260,6 +285,9 @@ Examples:
* `pair 1 2` Pairs the befriendee at Index 1 of the befriendee list and the volunteer at Index 2 of the volunteer list.
* `pair 3 3` Pairs the befriendee at Index 3 of the befriendee list and the volunteer at Index 3 of the volunteer list.
+[//]: # (Page Break:)
+
+
#### 3.1.4 Unpairing a befriendee and volunteer : `unpair`
Pairs an existing befriendee and volunteer in Elder Scrolls.
@@ -296,6 +324,9 @@ Format: `list`
* Persons are listed in the order they were added, from earliest to latest.
* The list command is commonly used with the `find` command to reset the view after a search.
+[//]: # (Page Break:)
+
+
#### 3.1.6 Locating persons: `find`
Find persons through a variety of filters.
@@ -335,12 +366,15 @@ If the _case-sensitive_ `t/TAG` filter is provided, the search will be limited t
Example: `find t/friend` (finds all persons who have the tag `friend`)
+[//]: # (Page Break:)
+
+
##### By role: `r/ROLE`
The `r/ROLE` filter is provided, the search will be limited to the specified list. The other list remains unaffected.
Only two versions of this filter are allowed: `r/volunteer` and `r/befriendee`.
-
:bulb: **Disclaimer:**
+
:bulb: **Tip:**
The `r/ROLE` filter can only be applied together with another filter. It cannot be used on its own.
@@ -356,6 +390,10 @@ Example: `find r/volunteer David` (finds all volunteers with `David` in their na
Examples:
* `find alex david`
+
+[//]: # (Page Break:)
+
+
* `find r/volunteer t/student --paired Bernice` (finds all paired volunteers with the tag `student` and name containing `Bernice`)
@@ -363,9 +401,6 @@ Examples:
Use the `list` command to reset your view after using the `find` command.
-[//]: # (Page Break:)
-
-
#### 3.1.7 Deleting a person : `delete`
Deletes the specified person from Elder Scrolls.
@@ -466,8 +501,8 @@ Format: `undo`
* Undo history will be erased when you exit the application.
Examples:
-* You have just mistakenly executed a `clear` command and cleared every entry in Elder Scrolls. You can simply execute the command `undo` to revert the changes and all your entries in Elder Scrolls will be restored to their previous state, before the `clear` command was executed.
-* If you've just performed multiple `delete` commands in sequence, and realised you've deleted the wrong entries. You can execute multiple `undo` commands to revert the changes made by the wrongful delete commands.
+* You mistakenly executed a `clear` command and cleared every entry in Elder Scrolls. You can simply execute the command `undo` to revert the changes and all your entries in Elder Scrolls will be restored to their previous state, before the `clear` command was executed.
+* You might have performed multiple `delete` commands in sequence, and realised you've deleted the wrong entries. You can execute multiple `undo` commands to revert the changes made by the wrongful delete commands.
#### 3.3.2 Revert the most recent undo command : `redo`
@@ -485,7 +520,6 @@ Examples:
* Let's say you've just executed a `add`, and mistakenly executed a `undo` command right after. You can then call `redo` to once again execute the `add` that was previously undone.
--------------------------------------------------------------------------------------------------------------------
-[//]: # (Page Break:)
### **3.4 Other Commands: Help, Clear and Exiting**
@@ -497,8 +531,7 @@ Format: `help`
* Any extraneous inputs/parameters (e.g. `help me`) will be ignored.
-
-
+
@@ -507,6 +540,10 @@ Format: `help`
Clears all entries from Elder Scrolls.
Format: `clear`
+
:bulb: **Tip:**
+Be careful when using the `clear` command as it will remove all entries from Elder Scrolls! However, if done accidentally, remember that you can always use the `undo` command to revert the changes made by the `clear` command!
+
+
#### 3.4.3 Exiting the program : `exit`
Exits the program.
@@ -516,6 +553,10 @@ Format: `exit`
Elder Scrolls data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually!
+
:bulb: **Tip:**
+While Elder Scrolls saves automatically, you can also easily make backups and snapshots of your data! To do so, simply copy the `datastore.json` file located in the `data` folder of the Elder Scrolls home directory as a backup file! Making a backup copy is never a bad idea!
+
+
## **5. Editing the data file**
All application data is saved automatically as a JSON file `[JAR file location]/data/datastore.json`. Advanced users are welcome to update data directly by editing that data file.
@@ -526,18 +567,22 @@ Furthermore, certain edits can cause the Elder Scrolls to behave in unexpected w
:bulb: **Tip:**
While Elder Scrolls saves automatically, you can also easily make backups and snapshots of your data! To do so, simply copy the `datastore.json` file located in the `data` folder of the Elder Scrolls home directory as a backup file! Making a backup copy is never a bad idea!
@@ -624,7 +624,7 @@ For additional resources, you can explore online forums, community groups, and v
| Action | Format, Examples |
|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME r/ROLE p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho r/volunteer p/88889999 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` |
-| **Edit** | `edit INDEX r/ROLE [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` |
+| **Edit** | `edit INDEX r/ROLE [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 r/volunteer n/James Lee e/jameslee@example.com` |
| **Pair** | `pair BEFRIENDEE_INDEX VOLUNTEER_INDEX`
e.g., `pair 1 2` |
| **Unpair** | `unpair BEFRIENDEE_INDEX VOLUNTEER_INDEX`
e.g., `unpair 1 2` |
| **List** | `list` |
From 62019defe50803c00776e2c6ba98669ef95f14c5 Mon Sep 17 00:00:00 2001
From: Ger Teck <111064611+gerteck@users.noreply.github.com>
Date: Mon, 15 Apr 2024 21:36:27 +0800
Subject: [PATCH 8/8] Update UG
Add logfind step to quickstart
---
docs/UserGuide.md | 26 ++++++++++++++++++++++----
docs/images/logfindResult.jpeg | Bin 0 -> 42553 bytes
docs/images/logfindResult.png | Bin 0 -> 200307 bytes
3 files changed, 22 insertions(+), 4 deletions(-)
create mode 100644 docs/images/logfindResult.jpeg
create mode 100644 docs/images/logfindResult.png
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 4d861edf997..294230316af 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -90,11 +90,11 @@ After this, you're all set to begin using Elder Scrolls! Let's make managing vol
2. John now needs a volunteer friend! Let's have volunteer Bernice take care of him. From the list, you can see that Bernice has been hard at work befriending Irfan, but sadly, we'll need to reassign her. Let's unpair Bernice and Irfan using the **`unpair` command**, since Irfan sits at the 2nd index in the befriendee list.
```
- unpair 2 1
+ unpair 2 2
```
-
+
Both lists should reset to their original state, and looking at Bernice and Irfan's cards, they are no longer paired.
@@ -136,8 +136,26 @@ After this, you're all set to begin using Elder Scrolls! Let's make managing vol
You should see the log card appear in the Logs list on the right, with the details supplied.
+ 
+
User interface Layout Breakdown of Elder Scrolls
