Skip to content

Latest commit

 

History

History
372 lines (268 loc) · 11.6 KB

UserGuide.adoc

File metadata and controls

372 lines (268 loc) · 11.6 KB

AddressBook Level 4 - User Guide

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

1. Introduction

Smart Insurance Collection(SIC) is for those who prefer to use a desktop app for managing contacts. More importantly, SIC is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB4 can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the Section 2, “Quick Start” to get started. Enjoy!

2. 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 here.

  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.

    Ui

  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

    • addn/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01 : adds a contact named John Doe to the Address Book.

    • delete3 : deletes the 3rd contact shown in the current list

    • exit : exits the app

  7. Refer to Section 3, “Features” for details of each command.

3. Features

Command Format

  • 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   (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.

3.1. Viewing help : help

Format: help

3.2. Adding a person: add

Adds a person to the address book
Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS i/INCOME b/AGE [t/TAG]…​

💡
 A person can have any number of tags (including 0)

Examples:

  • add n/John Doe p/98765432 e/[email protected] a/John street, i/23000 age/23 block 123, #01-01

  • add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal, i/100000 age/23

3.3. Listing all persons : list

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

3.4. Editing a person : edit

Edits an existing person in the address book.
Format: edit INDEX [n/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 n/Betsy Crower t/
    Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.5. Locating persons by name: find

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

  • The search is case insensitive. e.g hans will 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 Bo will return Hans Gruber, Bo Yang

Examples:

  • find John
    Returns john and John Doe

  • find Betsy Tim John
    Returns any person having names Betsy, Tim, or John

3.6. Deleting a person : delete

Deletes the specified person from the address book.
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.

3.7. Selecting 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.

3.8. Adding an appointment: add_appointment

Adds an appointment to the address book calendar
Format: add_appointment n/NAME S/START DATE TIME E/END DATE TIME

💡
 The date time must be entered in the d/MM/yyyy HH:mm format+ The name given to the appointment as its title must be unique

Examples:

  • add_appointment n/meet John S/11/09/2018 15:00 E/11/09/2018 16:00

3.9. remove existing appointment : remove_appointment

Removes appointment whose title match the given search text
Format: remove_appointment ST/SEARCH TEXT

💡
 only the title is searched, appointment with the title that match the given search text will be removed This works as we enforces unique titles for appointments.

Examples:

  • remove_appointment ST/Title of the appointment

3.10. Editing an appointment: edit_appointment

edit an existing appointment in the address book calendar
Format: edit_appointment ST/SEARCH TEXT n/NEW NAME S/NEW START DATE TIME E/NEW END DATE TIME

💡
 ST/SEARCH TEXT is a mandatory field that must be specified. Make sure the search text matches the title of an existing appointment. At least one of the other field must be specified. If changing the title, ensure the new title do not duplicates with other existing appointments

Examples:

  • edit_appointment ST/meet James n/meet John S/11/09/2018 15:00 E/11/09/2018 16:00

3.11. Look At a Date: look

look at a specific date, the Calendar GUI will focus on the date
Format: look DF/18/03/2018

💡
 Note that the date format must be in d/MM/yyyy

Examples:

  • look DF/11/09/2018

3.12. Back to calendar Month View: back

set the Calendar View to Month View
Format: back

3.13. Listing entered commands : history

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

ℹ️

Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box.

3.14. Undoing previous command : undo

Restores the address book to the state before the previous undoable command was executed.
Format: undo

ℹ️

Undoable commands: those commands that modify the address book’s content (add, delete, edit and clear).

Examples:

  • delete 1
    list
    undo (reverses the delete 1 command)

  • select 1
    list
    undo
    The undo command fails as there are no undoable commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)

3.15. Redoing the previously undone command : redo

Reverses the most recent undo command.
Format: redo

Examples:

  • delete 1
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)

  • delete 1
    redo
    The redo command fails as there are no undo commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)
    redo (reapplies the clear command)

3.16. Predict: predict

Predict the potential spending of the of a new customer.

Examples:

  • Initially
    two customers with actualSpending > 0 while the other with actualSpending == 0(actual spending will actually not be shown if it is zero).

  • After
    The customer with actualSpending == 0 now has expectedSpending shown.

Other Specification:

  • When adding an new Person, the /as(Actual Spending) is optional. if the actual spending is specified, the person is considered as existing customer. Otherwise potential customer. The prediction is to predict the potential customer’s spending based on the information on the existing customers.

3.17. Clearing all entries : clear

Clears all entries from the address book.
Format: clear

3.18. Exiting the program : exit

Exits the program.
Format: exit

3.19. 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.20. Intended Features

  • Enhanced search bar functionality

  • Prediction of purchasing power

  • Enhanced Calendar features

3.21. Encrypting data files [coming in v2.0]

{explain how the user can enable/disable data encryption}

3.22. add task to task pad`[coming in v2.0]`

the user is allowed to use command line to add a task to the task pad GUI specifying the task title , task details

3.23. remove task on task pad`[coming in v2.0]`

the user is allowed to use command line to remove a task to the task pad GUI specifying the task index

3.24. Predict Purchasing Power

  • User is able to type "Predict" get potential customer’s expected spending based on the existing data

  • After new data has been entered, users are able to re-predict and retrain the model

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

5. Command Summary

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

  • Add Appointment add_appointment n/NAME S/START DATE E/End Date
    e.g. add_appointment n/Meet James S/14/08/2018 15:00 S/14/08/2018 16:00

  • Remove Appointment remove_appointment ST/SEARCH TEXT
    e.g. remove_appointment ST/Title of the appointment

  • Edit Appointment edit_appointment ST/SEARCH TEXT n/NEW NAME S/NEW START DATE E/NEW End Date
    e.g. edit_appointment ST/meet John n/Meet James S/14/08/2018 15:00 S/14/08/2018 16:00

  • Look At a Date look DF/DATE TO LOOK
    e.g. look DF/18/03/2018

  • Back to Month View back

  • 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/[email protected]

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

  • List : list

  • Help : help

  • Select : select INDEX
    e.g.select 2

  • History : history

  • Undo : undo

  • Redo : redo