From f1e11184e4199f318ad5257310ac57dd1a62a29a Mon Sep 17 00:00:00 2001 From: Zhi Yuan Yong Date: Thu, 21 Sep 2017 19:40:49 +0800 Subject: [PATCH 1/7] UserGuide: Add EditCommand to Command Summary This was missing. --- docs/UserGuide.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 2d55b9502d63..759a81df37b7 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -238,6 +238,8 @@ e.g. `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 123466 * *Clear* : `clear` * *Delete* : `delete INDEX` + e.g. `delete 3` +* *Edit* : `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]...` + +e.g. `edit 2 n/James Lee e/jameslee@example.com` * *Find* : `find KEYWORD [MORE_KEYWORDS]` + e.g. `find James Jake` * *List* : `list` From cfcebedbfba50afe2b07bdc149ab43b9ef0d06ef Mon Sep 17 00:00:00 2001 From: Zhi Yuan Yong Date: Thu, 21 Sep 2017 20:14:23 +0800 Subject: [PATCH 2/7] UserGuide: Update command headers --- docs/UserGuide.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 759a81df37b7..4df318406051 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -91,7 +91,7 @@ Edits the phone number and email address of the 1st person to be `91234567` and * `edit 2 n/Betsy Crower t/` + Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. -=== Finding all persons containing any keyword in their name: `find` +=== Locating persons by name: `find` Finds persons whose names contain any of the given keywords. + Format: `find KEYWORD [MORE_KEYWORDS]` @@ -131,7 +131,7 @@ Deletes the 2nd person in the address book. `delete 1` + Deletes the 1st person in the results of the `find` command. -=== Select a person : `select` +=== Selecting a person : `select` Selects the person identified by the index number used in the last person listing. + Format: `select INDEX` @@ -162,7 +162,7 @@ Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and ==== // tag::undoredo[] -=== Undo previous command : `undo` +=== Undoing previous command : `undo` Restores the address book to the state before the previous _undoable_ command was executed. + Format: `undo` @@ -188,7 +188,7 @@ The `undo` command fails as there are no undoable commands executed previously. `undo` (reverses the `clear` command) + `undo` (reverses the `delete 1` command) + -=== Redo the previously undone command : `redo` +=== Redoing the previously undone command : `redo` Reverses the most recent `undo` command. + Format: `redo` From 2a4e8fd7a954030367061ae379eb8172542f7b07 Mon Sep 17 00:00:00 2001 From: Zhi Yuan Yong Date: Thu, 21 Sep 2017 20:15:07 +0800 Subject: [PATCH 3/7] UserGuide: Improve clarity and readability --- docs/UserGuide.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 4df318406051..93020602cff3 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -59,7 +59,7 @@ Adds a person to the address book + Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...` [TIP] -Persons can have any number of tags (including 0) +A person can have any number of tags (including 0) Examples: @@ -101,7 +101,7 @@ Format: `find KEYWORD [MORE_KEYWORDS]` * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` * Only the name is searched. * Only full words will be matched e.g. `Han` will not match `Hans` -* Persons matching at least one keyword will be returned (i.e. `OR` search). e.g. `Hans` will match `Hans Bo` +* Persons matching at least one keyword will be returned (i.e. `OR` search). e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` **** Examples: @@ -139,7 +139,7 @@ Format: `select INDEX` **** * Selects the person and loads the Google search page the person at the specified `INDEX`. * The index refers to the index number shown in the most recent listing. -* The index *must be a positive integer* 1, 2, 3, ... +* The index *must be a positive integer* `1, 2, 3, ...` **** Examples: From 1390523cb86b9b6993ea61e2c8b722b628c63dc9 Mon Sep 17 00:00:00 2001 From: Zhi Yuan Yong Date: Thu, 21 Sep 2017 20:18:06 +0800 Subject: [PATCH 4/7] UserGuide: Update Command Format --- docs/UserGuide.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 93020602cff3..f776cd4f86f3 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -43,10 +43,10 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window. ==== *Command Format* -* Words in `UPPER_CASE` are the parameters. -* Items in `SQUARE_BRACKETS` are optional. -* Items with `...` after them can have multiple instances. -* Parameters can be in any order. +* Words in `UPPER_CASE` are the parameters to be supplied by the user e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +* Items in square brackets are optional e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +* Items with `…`​ after them can be used multiple times including zero times e.g. `[t/TAG]...` can be used as `{nbsp}` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +* Parameters can be in any order e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. ==== === Viewing help : `help` From 9cbbf8a9c9a32a4fa76fe581ee2832951ffc7efb Mon Sep 17 00:00:00 2001 From: Zhi Yuan Yong Date: Thu, 21 Sep 2017 20:19:56 +0800 Subject: [PATCH 5/7] UserGuide: Update find command example --- docs/UserGuide.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index f776cd4f86f3..20d6bce9b330 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -107,7 +107,7 @@ Format: `find KEYWORD [MORE_KEYWORDS]` Examples: * `find John` + -Returns `John Doe` but not `john` +Returns `john` and `John Doe` * `find Betsy Tim John` + Returns Any person having names `Betsy`, `Tim`, or `John` From 73c179f703e5d13955ce785c340eeff8152f290b Mon Sep 17 00:00:00 2001 From: Zhi Yuan Yong Date: Thu, 21 Sep 2017 20:20:03 +0800 Subject: [PATCH 6/7] UserGuide: Fix typo --- docs/UserGuide.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 20d6bce9b330..38ba0f729d71 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -109,7 +109,7 @@ Examples: * `find John` + Returns `john` and `John Doe` * `find Betsy Tim John` + -Returns Any person having names `Betsy`, `Tim`, or `John` +Returns any person having names `Betsy`, `Tim`, or `John` === Deleting a person : `delete` From e01838596ae5f036ed8658c4bbd4907dbeb7eefb Mon Sep 17 00:00:00 2001 From: Zhi Yuan Yong Date: Thu, 21 Sep 2017 20:32:14 +0800 Subject: [PATCH 7/7] UserGuide: Update broken link This link breaks on the offline version. --- docs/UserGuide.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 38ba0f729d71..87f4cd6ab596 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -10,6 +10,7 @@ ifdef::env-github[] :tip-caption: :bulb: :note-caption: :information_source: endif::[] +:repoURL: https://github.com/se-edu/addressbook-level4 By: `Team SE-EDU` Since: `Jun 2016` Licence: `MIT` @@ -21,7 +22,7 @@ By: `Team SE-EDU` Since: `Jun 2016` Licence: `MIT` Having any Java 8 version is not enough. + This app will not work with earlier versions of Java 8. + -. Download the latest `addressbook.jar` from the link:../../../releases[releases] tab. +. Download the latest `addressbook.jar` link:{repoURL}/releases[here]. . Copy the file to the folder you want to use as the home folder for your Address Book. . Double-click the file to start the app. The GUI should appear in a few seconds. +