Skip to content

Commit

Permalink
Update screenshots for some commands in user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
SwaminathanViswa committed Nov 5, 2024
1 parent 258e440 commit 885a3fd
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ konTActs is a **desktop app for managing contacts, optimized for use via a Comma

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.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>
![Ui](images/Ui.png)
![Ui](images/loadingPageOfUi.png)

1. 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:
Expand Down Expand Up @@ -227,8 +227,8 @@ Find all persons whose names contains any of the given keywords.

<md>**Examples:**</md>
* `find John` returns `john` and `John Doe`
* `find alex david` returns `Alex Yeoh`, `David Li`<br>
![result for 'find alex david'](images/findAlexDavidResult.png)
* `find alex charlotte` returns `Alex Yeoh`, `Charlotte`<br>
![result for 'find alex david'](images/findAlexCharlotte.png)
</box>

--------------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -256,8 +256,8 @@ Finds persons whose names contain any of the given tag keywords.
<box type="definition" icon=":fa-solid-book:" light>

<md>**Examples:**</md>
* `filter t/friend t/family` returns any contact tagged with `friend` or `family`<br>
![result for 'filter t/friend t/family'](images/findAlexDavidResult.png)
* `filter t/friends` returns any contact tagged with `friends`<br>
![result for 'filter t/friend t/family'](images/findFriendsTagByFilter.png)
</box>

--------------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -351,17 +351,23 @@ Marks a student as present for a particular week.
<box type="warning" icon=":fa-solid-circle-exclamation:" light>

* Marks the particular student as present in that week.
* The name and week number is compulsory.
* The full name and week number is compulsory.
* The name is case-sensitive.
* The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 weeks per semester.
</box>

<box type="info" seamless>

The update of the attendance will only be seen when [`view`](#viewing-a-contact-s-full-details-view) command is executed.

</box>

<box type="definition" icon=":fa-solid-book:" light>

<md>**Examples:**</md>

* `mark n/Viswa w/1` marks the student named `Viswa` as present for week 1.
![result for mark](images/markPresent.png)
* `mark n/Alex Yeoh w/1` marks the student named `Alex Yeoh` as present for week 1.
![result for mark](images/markAlexPresent.png)
</box>

--------------------------------------------------------------------------------------------------------------------
Expand All @@ -378,17 +384,23 @@ Unmarks a student as present for a particular week.
<box type="warning" icon=":fa-solid-circle-exclamation:" light>

* Unmarks the particular student as present in that week.
* The name and week number is compulsory.
* The full name and week number is compulsory.
* The name is case-sensitive.
* The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 weeks per semester.
</box>

<box type="info" seamless>

The update of the attendance will only be seen when [`view`](#viewing-a-contact-s-full-details-view) command is executed.

</box>

<box type="definition" icon=":fa-solid-book:" light>

<md>**Examples:**</md>

* `unmarks n/John Doe w/1` unmarks the student named `JohnDoe` as present for week 1.
![result for unmark](images/unmarkStudent.png)
![result for unmark](images/markAlexAbsent.png)
</box>

--------------------------------------------------------------------------------------------------------------------
Expand All @@ -414,7 +426,8 @@ Sorts the displayed list based on the given field and order.

<md>**Examples:**</md>

* `sort name order/asc` will sort the displayed list based on their name in ascending order.
* `sort github order/asc` will sort the displayed list based on their name in ascending order.
![result_for_sorting](images/sortExample.png)
</box>

--------------------------------------------------------------------------------------------------------------------
Expand Down
Binary file added docs/images/findAlexCharlotte.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/findFriendsTagByFilter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/loadingPageOfUi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/markAlexAbsent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/markAlexPresent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/sortExample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 885a3fd

Please sign in to comment.