Skip to content
This repository has been archived by the owner on Mar 5, 2023. It is now read-only.

Commit

Permalink
UserGuide: Add command aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
yamgent committed Jan 4, 2018
1 parent f8da5a2 commit 2cb223c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
====
*Command Format*
* Some commands have an alias, which you can also use to execute the command e.g. to add a person to the address book, you can type either `add n/John Doe` or `a n/John Doe`.
* 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.
Expand All @@ -59,6 +60,7 @@ Format: `help`
=== Adding a person: `add`

Adds a person to the address book +
Alias: `a` +
Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...`

[TIP]
Expand All @@ -72,11 +74,13 @@ Examples:
=== Listing all persons : `list`

Shows a list of all persons in the address book. +
Alias: `l` +
Format: `list`

=== Editing a person : `edit`

Edits an existing person in the address book. +
Alias: `e` +
Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...`

****
Expand All @@ -97,6 +101,7 @@ Edits the name of the 2nd person to be `Betsy Crower` and clears all existing ta
=== Locating persons by name: `find`

Finds persons whose names contain any of the given keywords. +
Alias: `f` +
Format: `find KEYWORD [MORE_KEYWORDS]`

****
Expand All @@ -117,6 +122,7 @@ Returns any person having names `Betsy`, `Tim`, or `John`
=== Deleting a person : `delete`

Deletes the specified person from the address book. +
Alias: `d` +
Format: `delete INDEX`

****
Expand All @@ -137,6 +143,7 @@ Deletes the 1st person in the results of the `find` command.
=== Selecting a person : `select`

Selects the person identified by the index number used in the last person listing. +
Alias: `s` +
Format: `select INDEX`

****
Expand All @@ -157,6 +164,7 @@ Selects the 1st person in the results of the `find` command.
=== Listing entered commands : `history`

Lists all the commands that you have entered in reverse chronological order. +
Alias: `h` +
Format: `history`

[NOTE]
Expand All @@ -168,6 +176,7 @@ Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and
=== Undoing previous command : `undo`

Restores the address book to the state before the previous _undoable_ command was executed. +
Alias: `u` +
Format: `undo`

[NOTE]
Expand All @@ -194,6 +203,7 @@ The `undo` command fails as there are no undoable commands executed previously.
=== Redoing the previously undone command : `redo`

Reverses the most recent `undo` command. +
Alias: `r` +
Format: `redo`

Examples:
Expand All @@ -217,6 +227,7 @@ The `redo` command fails as there are no `undo` commands executed previously.
=== Clearing all entries : `clear`

Clears all entries from the address book. +
Alias: `c` +
Format: `clear`

=== Exiting the program : `exit`
Expand Down

0 comments on commit 2cb223c

Please sign in to comment.