Skip to content

UserGuide.adoc

Latest commit

 

History

History
184 lines (126 loc) · 4.6 KB

UserGuide.adoc

File metadata and controls

184 lines (126 loc) · 4.6 KB
Raw

User Guide

This product is not meant for end-users and therefore there is no user-friendly installer. Please refer to the Setting up section to learn how to set up the project.

Starting the program

  1. Find the project pane (usually located at the left side)

  2. Open up src/seedu.addressbook folder

  3. Right click on Main

  4. Click Run Main.main()

  5. The GUI should appear in a few seconds

    Ui

Viewing help : help

Format: help

💡

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

Login to the system : login

Allow the user to login to the system
Format: login username password

ℹ️

Login is required in order to use the address book

Examples:

  • login guanlong 12345
    Logged in as guanlong if the account and password are correct.

Adding a person: add

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

Words in UPPER_CASE are the parameters, items in SQUARE_BRACKETS are optional, items with …​ after them can have multiple instances. Order of parameters are fixed.

Put a p before the phone / email / address prefixes to mark it as private. private details can only be seen using the viewall command.

Persons can have any number of tags (including 0)

Examples:

  • add John Doe p/98765432 e/johnd@gmail.com a/John street, block 123, #01-01 m/30November

  • add Betsy Crowe pp/1234567 e/betsycrowe@gmail.com pa/Newgate Prison m/1 January 2009 t/criminal t/friend

Finding out the current length of the address book : length

Shows the number of entries in the address book.
Format: length

Listing all persons : list

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

Listing all persons in sorted order : sort

Shows a list of all persons sorted by desired attribute in alphabetical order in the address book.
Desired attribute could be name, appointment or status.
Format: sort DESIRED_ATTRIBUTE

Examples:

  • sort name
    Shows a list of all persons sorted by name in alphabetical order in the address book.

  • sort status
    Shows a list of all persons sorted by status in alphabetical order in the address book.

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, the order of the keywords does not matter, only the name is searched, and persons matching at least one keyword will be returned (i.e. OR search).

Examples:

  • find John
    Returns John Doe but not john.

  • find Betsy Tim John
    Returns Any person having names Betsy, Tim, or John.

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.

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.

View non-private details of a person : view

Displays the non-private details of the specified person.
Format: view INDEX

Views the person at the specified INDEX. The index refers to the index number shown in the most recent listing.

Examples:

  • list
    view 2
    Views the 2nd person in the address book.

  • find Betsy
    view 1
    Views the 1st person in the results of the find command.

View all details of a person : viewall

Displays all details (including private details) of the specified person.
Format: viewall INDEX

Views all details of the person at the specified INDEX. The index refers to the index number shown in the most recent listing.

Examples:

  • list
    viewall 2
    Views all details of the 2nd person in the address book.

  • find Betsy
    viewall 1
    Views all details of the 1st person in the results of the find command.

Clearing all entries : clear

Clears all entries from the address book.
Format: clear

Exiting the program : exit

Exits the program.
Format: exit

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. Address book data are saved in a file called addressbook.txt in the project root folder.