Skip to content

Latest commit

 

History

History
186 lines (126 loc) · 5.83 KB

UserGuide.md

File metadata and controls

186 lines (126 loc) · 5.83 KB
Raw

AddressBook Level 4 - User Guide

By : Team SE-EDU      Since: Jun 2016      Licence: MIT

  1. Quick Start
  2. Features
  3. FAQ
  4. Command Summary

1. Quick Start

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

    Having any Java 8 version is not enough.
    This app will not work with earlier versions of Java 8.

  2. Download the latest addressbook.jar from the releases tab.

  3. Copy the file to the folder you want to use as the home folder for your Address Book.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

  5. 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.

  6. Some example commands you can try:

    • list : lists all contacts
    • add John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01 : adds a contact named John Doe to the Address Book.
    • delete 3 : deletes the 3rd contact shown in the current list
    • exit : exits the app

  7. Refer to the Features section below for details of each command.

2. Features

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.

2.1. Viewing help : help

Format: help

Help is also shown if you enter an incorrect command e.g. abcd

2.2. Adding a person: add

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

Persons can have any number of tags (including 0)

Examples:

2.3. Listing all persons : list

Shows a list of all persons in the address book.
Format: list

2.4. Editing a person : edit

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

  • Edits the person at the specified INDEX. The index refers to the index number shown in the last person listing.
    The index must be a positive integer 1, 2, 3, ...
  • At least one of the optional fields must be provided.
  • Existing values will be updated to the input values.
  • When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
  • You can remove all the person's tags by typing t/ without specifying any tags after it.

Examples:

  • edit 1 p/91234567 e/[email protected]
    Edits the phone number and email address of the 1st person to be 91234567 and [email protected] respectively.

  • edit 2 Betsy Crower t/
    Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

2.5. Finding all persons containing any keyword in their name: find

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

  • The search is case sensitive. e.g hans will not match Hans
  • 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

Examples:

  • find John
    Returns John Doe but not john
  • find Betsy Tim John
    Returns Any person having names Betsy, Tim, or John

2.6. Deleting a person : delete

Deletes the specified person from the address book. Irreversible.
Format: delete INDEX

Deletes 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, ...

Examples:

  • list
    delete 2
    Deletes the 2nd person in the address book.
  • find Betsy
    delete 1
    Deletes the 1st person in the results of the find command.

2.7. Select a person : select

Selects the person identified by the index number used in the last person listing.
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, ...

Examples:

  • list
    select 2
    Selects the 2nd person in the address book.
  • find Betsy
    select 1
    Selects the 1st person in the results of the find command.

2.8. Clearing all entries : clear

Clears all entries from the address book.
Format: clear

2.9. Exiting the program : exit

Exits the program.
Format: exit

2.10. Saving the data

Address book data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.

3. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Address Book folder.

4. Command Summary

  • Add add NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...
    e.g. add James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague

  • Clear : clear

  • Delete : delete INDEX
    e.g. delete 3

  • Find : find KEYWORD [MORE_KEYWORDS]
    e.g. find James Jake

  • List : list
    e.g.

  • Help : help
    e.g.

  • Select : select INDEX
    e.g.select 2