diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 08d772890fb..fb0a893d83b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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.
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
- ![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.
Some example commands you can try: @@ -227,8 +227,8 @@ Find all persons whose names contains any of the given keywords. **Examples:** * `find John` returns `john` and `John Doe` -* `find alex david` returns `Alex Yeoh`, `David Li`
- ![result for 'find alex david'](images/findAlexDavidResult.png) +* `find alex charlotte` returns `Alex Yeoh`, `Charlotte`
+ ![result for 'find alex david'](images/findAlexCharlotte.png) -------------------------------------------------------------------------------------------------------------------- @@ -256,8 +256,8 @@ Finds persons whose names contain any of the given tag keywords. **Examples:** -* `filter t/friend t/family` returns any contact tagged with `friend` or `family`
- ![result for 'filter t/friend t/family'](images/findAlexDavidResult.png) +* `filter t/friends` returns any contact tagged with `friends`
+ ![result for 'filter t/friend t/family'](images/findFriendsTagByFilter.png) -------------------------------------------------------------------------------------------------------------------- @@ -351,17 +351,23 @@ Marks a student as present for a particular week. * 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. + + +The update of the attendance will only be seen when [`view`](#viewing-a-contact-s-full-details-view) command is executed. + + + **Examples:** -* `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) -------------------------------------------------------------------------------------------------------------------- @@ -378,17 +384,23 @@ Unmarks a student as present for a particular week. * 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. + + +The update of the attendance will only be seen when [`view`](#viewing-a-contact-s-full-details-view) command is executed. + + + **Examples:** * `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) -------------------------------------------------------------------------------------------------------------------- @@ -414,7 +426,8 @@ Sorts the displayed list based on the given field and order. **Examples:** -* `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) -------------------------------------------------------------------------------------------------------------------- diff --git a/docs/images/findAlexCharlotte.png b/docs/images/findAlexCharlotte.png new file mode 100644 index 00000000000..d83feddcdb0 Binary files /dev/null and b/docs/images/findAlexCharlotte.png differ diff --git a/docs/images/findFriendsTagByFilter.png b/docs/images/findFriendsTagByFilter.png new file mode 100644 index 00000000000..5fcf2745ced Binary files /dev/null and b/docs/images/findFriendsTagByFilter.png differ diff --git a/docs/images/loadingPageOfUi.png b/docs/images/loadingPageOfUi.png new file mode 100644 index 00000000000..b546ffb2c01 Binary files /dev/null and b/docs/images/loadingPageOfUi.png differ diff --git a/docs/images/markAlexAbsent.png b/docs/images/markAlexAbsent.png new file mode 100644 index 00000000000..9ef332dc343 Binary files /dev/null and b/docs/images/markAlexAbsent.png differ diff --git a/docs/images/markAlexPresent.png b/docs/images/markAlexPresent.png new file mode 100644 index 00000000000..bc7db54bd8f Binary files /dev/null and b/docs/images/markAlexPresent.png differ diff --git a/docs/images/sortExample.png b/docs/images/sortExample.png new file mode 100644 index 00000000000..c9c433ae17a Binary files /dev/null and b/docs/images/sortExample.png differ