Skip to content

Latest commit

 

History

History
620 lines (457 loc) · 17.4 KB

UserGuide.adoc

File metadata and controls

620 lines (457 loc) · 17.4 KB

AcquaiNote - User Guide

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

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 AcquaiNote.jar here.

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

  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 the Features section below for details of each command.

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

2.1. Viewing help : help

Format: help

2.2. Adding a person: add

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

💡
 A person 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 [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.

2.5. Locating persons : find

2.5.1. Default

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

2.5.2. Option1

Conducts fuzzy search for persons whose any detail contain the given keywords.
Format: find -u KEYWORD

  • The search is case insensitive. e.g hans will match Hans

  • All details are searched, including name, phone, email, address, tag and so on

Examples:

  • find -u jo
    Returns john and John Doe

  • find -u 999
    Returns any person containing number 999

2.5.3. Option2

Finds by the specific details.
Format: find -d [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

  • The search is case insensitive. e.g hans will match Hans

  • At lease one argument must be given. e.g find -d will not work

  • Returns any person whose name contains the given name if name is specified, phone number contains
    the given phone number if it is specified and so on to all details

Examples:

  • find -d n/jo
    Returns john and John Doe

  • find -d p/999 e/nus
    Returns any person whose phone number contains number 999 and email address contains nus

2.6. Deleting a person by index: delete

Deletes the specified person from the address book using his/her corresponding index.
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. Selecting a person : select

Selects the person identified by the index number used in the last person listing.
Format: select OPTION INDEX

Options:

  • -n search name on browser

  • -p search phone on browser

  • -e search email on browser

  • -a show address on google map

Tips

  • 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 -n 2
    Selects the 2nd person in the address book.

  • find Betsy
    select -a 1
    Selects the address of 1st person in the results of the find command.

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

2.9. 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)

2.10. 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)

2.11. Clearing all entries : clear

Clears all entries from the address book.
Format: clear

2.12. Exiting the program : exit

Exits the program.
Format: exit

2.13. 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. Since v1.2

3.1. Deleting a person by name: del

Deletes the specified person from the address book using his/her name.
Format: del NAME [MORE_NAMES]

  • Deletes the person with the specified NAME.

  • Shortlist all persons with specified NAMES before deletion.

  • The name refers to the name shown in the contact list (case insensitive).

  • The name must be the entire first/last/full name

Examples:

  • del Alex
    Deletes the person named Alex in the address book if it is unique in the contact list.
    Otherwise, shows all persons with the name Alex for further operation.

  • del Ben Alex John
    Shows all persons with the name Ben or Alex or John for further operation.

3.2. Sorting all persons : sort

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

  • Sorts all persons by specified OPTION.

  • The OPTION refers to a contact’s field, e.g. 'name', 'phone', 'email', …​

  • The OPTION must be a hyphen followed by a single lower case alphabet -n, -p, -e, …​

  • Available options: '-n': sort by name; '-p': sort by phone number; -e': sort by email address; '-a': sort by address; '-t': sort by tag.

Examples:

  • sort -n
    Sorts the address book alphabetically by name.

3.3. Locking the address book : lock

Locks the address book by a password.
Format: lock PASSWORD

  • Password should be longer than 4 characters.

  • After locking, user cannot input any commands except unlock.

  • Data file will be encrypted after locking.

  • Person contact list will be cleared.

3.4. Unlocking the address book: unlock

Unlocks the address book after entering correct password.
Format: unlock PASSWORD

  • Password should be longer than 4 characters.

  • Encrypted data file will be decrypted after locking.

  • Person contact list will reload.

3.5. Favouriting a person : favourite

Favourites the person identified by the index number used in the last person listing.
If person identified by the index is already a favourite, the person will be removed from your favourites and shifted below your list of favourite contacts. Format: favourite INDEX

  • Adds a star beside the contact identified by the index.

  • Shifts the person up to the top of the list.

  • 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
    favourite 2
    Favourites the 2nd person in the address book.

  • find Betsy
    favourite 1
    Favourites the 1st person in the results of the find command.

  • list
    favourite 1
    Favourites the 1st person in the address book.
    favourite 1
    Unfavourite the 1st person in the address book.

Tips

  • If you already have some favourite contacts, the next favourite contact will be added below them.

  • You can use the favourite command together with the todo command so that you do not miss out on any tasks assigned.

  • Using the sort command will still place your favourite contacts at the top of your contact list, but your favourite contacts will be sorted as a separate list.

3.6. Exporting address book : export

Exports a copy of the address book.
Format: export FILEPATH

  • Exports the address book into specified FILEPATH.

  • The filepath refers to a local directory in the computer.

  • The filepath must be suffixed with .xml e.g. 'D:\', 'docs/', …​

  • If specified directory is missing, it will be automatically created when exporting.

Examples:

  • export D:\exported\AcquaiNote.xml
    Exports the address book into exported folder in D drive in xml file format.

3.7. To-do list: todo

Attach a To-do list to a specified person to manage schedule with that person.

3.7.1. Option1

Add a new todo item to the given person with INDEX
Format: todo INDEX -a f/dd-MM-yyyy HH:mm [t/dd-MM-yyyy HH:mm] d/TASK_TO_DO

Example:

  • todo 1 -a f/01-11-2017 20:40 d/Meeting

3.7.2. Option2

Delete a todo item with INDEX2 from the given person with INDEX1
Format: todo INDEX1 -d INDEX2

Example:

  • todo 1 -d 1

3.7.3. Option3

Delete all todo items from the given person with INDEX
Format: todo INDEX -c

Example:

  • todo INDEX -l

3.7.4. Option4

List all todo items from the given person with INDEX
Format: todo INDEX -l

3.7.5. Option5

List all todo items from all person
Format: todo

3.8. Switch between Browser and Todo list: switch

Switch between Todo list and browser.
Format: switch NUMBER (1 for Todo list, 2 for browser)

3.9. Undoing multiple commands : undo

Restores the address book to the state before the previous specified number of undoable commands
were executed. If the number entered is more than the available commands to undo, all the
undoable commands will be undone. If no number is specified, only the most recent command will be undone.
Format: undo 1 or undo

The index must be a positive integer 1, 2, 3, …​

ℹ️

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

Examples:

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

  • delete 1
    list
    undo 1 (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 2 (reverses the clear command, followed by delete 1 command)

Tips

  • You can undo all commands by keying in a ridiculously large index eg. undo 1000

3.10. Redoing multiple undone commands : redo

Reverses the N most recent undo commands, where N refers to the number entered. If the number entered is greater than
the number of undo commands, all the undo commands will be reversed. If no number is given, only the most recent undo
command will be reversed.

Format: redo 2 or redo

The index must be a positive integer 1, 2, 3, …​

Examples:

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

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

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

  • delete 1
    clear
    undo 2 (reverses the clear command, followed by the delete 1 command)
    redo 2 (reapplies the delete 1 command, followed by clear command)

Tips

  • Similar to undo, you can redo all undo commands by keying in a ridiculously large index eg. redo 1000

3.11. Adding a person with empty fields: add

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

💡
 A person can have any number of tags (including 0)
If email, phone number and/or address is not entered, it will appear as a dash.
Name cannot be empty.

Examples:

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

  • add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal

  • add n/Betsy Crowe t/friend a/Newgate Prison p/1234567 t/criminal

  • add n/Thomas Barker

4. Coming in v2.0

4.1. Popup dialog window during editing

A dialog window pops up during contact editing.

4.2. Real time highlight

Real time highlight when input command is not correct.

4.3. Using todo command sets contact as a favourite.

Person with todo tasks automatically becomes a favourite and shifts to top of list.

4.4. Undo/redo all commands

Entering undo all or redo all now undo and redo all commands respectively.

4.5. Import address book

Import address book into the application.

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

6. 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 or
    add n/James Ho e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague or
    add n/James Ho p/22224444 a/123, Clementi Rd, 1234665 t/friend t/colleague or
    add n/James Ho

  • Clear : clear

  • Delete : delete INDEX or del NAME
    e.g. delete 3, del john

  • Edit : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
    e.g. edit 2 n/James Lee e/[email protected]

  • Favourite : favourite INDEX
    e.g. favourite 1

  • Find : find KEYWORD [MORE_KEYWORDS] or
    find -u KEYWORD or
    find -d [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
    e.g. find James Jake

  • List : list

  • Help : help

  • Select : select INDEX
    e.g.select 2

  • Sort : sort OPTION
    e.g. sort -n

  • History : history

  • Undo : undo or undo 2

  • Redo : redo or redo 2

  • Lock : lock PASSWORD

  • Todo : todo INDEX -a f/dd-MM-yyyy HH:mm [t/dd-MM-yyyy HH:mm] d/TASK_TO_DO or
    todo INDEX1 -d INDEX2 or
    todo INDEX -c or
    todo INDEX -l or
    todo

  • Switch : switch NUMBER

  • Unlock : unlock PASSWORD

  • export : export FILEPATH
    e.g. export C:\exported\MyAddressBook.xml