Skip to content

Latest commit

 

History

History
551 lines (405 loc) · 16.8 KB

UserGuide.adoc

File metadata and controls

551 lines (405 loc) · 16.8 KB

TravelBanker- User Guide

By: CS2103JAN18-T11-B4 Since: Jun 2016 Licence: MIT

1. Introduction

TravelBanker (TB) is for those who prefer to use a desktop app for managing the money owed by your fellow travellers *. More importantly, TB 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, TB 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 TravelBanker.jar here.

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

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

    UIMockup

  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 accounting book.

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

    • exit : exits the app

    • Except for exit, you can also use the first letter of each command to type faster (e.g. l for list).

  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 or h

Format: help

3.2. Adding a person: add or a

Adds a person to the accounting book.
Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS m/BALANCE [t/TAG]…​ Format: a n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS m/BALANCE [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, block 123, #01-01 m/23.78

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

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

3.3. Listing all persons : list or l

Shows a list of all persons in the accounting book.
Format: list or l

3.4. Editing a person : edit or e

Edits an existing person in the accounting book.
Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [m/MONEY] [t/TAG]…​ Format: e INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [m/MONEY] [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/ or e 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 or f

Finds persons whose names contain any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS] or f 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 or d

Deletes the specified person from the accounting book.
Format: delete INDEX or d 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 accounting book.

  • find Betsy
    delete 1
    Deletes the 1st person in the results of the find command. d 1
    Deletes the 1st person in the results of the find command.

3.7. Selecting a person : select or s

Selects the person identified by the index number used in the last person listing and address displayed.
Format: select INDEX or s INDEX

  • Selects 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 accounting book.

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

3.8. Listing entered commands : history or hi

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

ℹ️

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

3.9. Undoing previous command : undo or u

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

ℹ️

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

Examples:

  • delete 1
    list
    undo or u (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.10. Redoing the previously undone command : redo or r

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.11. Clearing all entries : clear or c

Clears all entries from the accounting book.
Format: clear or c

3.12. Exiting the program : exit

Exits the program.
Format: exit

3.13. Saving the data

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

3.14. Checking overall balance: balance or b [Since v1.2]

Calculates your total balance. This value shows you the overall state of your finances: how much you owe minus how much you’re owed.
Format: balance or b

3.15. Seeing all the contacts that owe you money: debt or de [Since v1.2]

Lists all the contacts that owe you an amount. Format: debt or de

3.16. Seeing all the contacts to which you owe money: lend or le [Since v1.2]

Lists all the contacts that owe you an amount. Format: lend or le

3.17. Remove Tags: removetag or rt [Since v1.2]

Remove Tags from a specific person in the TravelBanker.
Format: removetag INDEX [t/TAG]…​
Format: rt INDEX [t/TAG]…​

Examples:

  • removetag 1 t/owesMoney t/friends
    Remove the tags owesMoney and friends from the first person.

3.18. Seeing which contact owes you the most: max or mx [Since v1.2]

Lists the contact which owes you the most money.
Format: max

3.19. Seeing which contact owes you the least: min or mi[Since v1.2]

Lists the contact to which you owe the most money.
Format: min

3.20. Sorting all persons: sort or so [Since v1.2]

Sorts all persons in ascendingly or descendingly, ordering by the specified keywords.
Format: sort KEYWORD_PREFIX/ORDER
Format: so KEYWORD_PREFIX/ORDER

  • ORDER can only be asc or desc.

  • KERWORD_PREFIX can be n/ p/ e/ a/ t/ m/

  • When KEYWORD_PREFIX is specified as n/ p/ e/ or a/, corresponding filed will be sorted alphabetically.

  • When KEYWORD_PREFIX is specified as t/, people will be sorted according to the number of tags.

  • When KEYWORD_PREFIX is specified as m/, people will be sorted according to the value of money filed.

Examples:

  • sort n/asc

  • so m/desc

3.21. Splitting a bill: split or sp [Since v1.3]

Splits a bill among multiple people, specified by their indices.
Format: split INDEX1 [INDEX2…​] m/MONEY
Format: sp INDEX1 [INDEX2…​] m/MONEY

Examples:

  • split 1 2 m/200

  • sp 1 2 3 m/400.00

3.22. Clear up everyone’s balance: wipe or w [Since v1.3]

Wipes everyone’s balances to 0.0
Format: wipe
Format: w

3.23. Settling up your balance with a contact: settle or stl[Since v1.3]

Sets the balance of the specified contact to 0.
Format: settle INDEX === Searching for the nearest ATM : map or mp [Since v1.3]

Displays a search for the nearest ATM in the browser panel. Format: map or mp

3.24. Showing items related to a person : itemshow or is [Since v1.4]

Show all items related to a person (specified by INDEX).
Format: itemshow INDEX or is 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
    itemshow 2
    Shows items related to the 2nd person in the accounting book.

  • find Betsy
    itemshow 1
    Shows item related to the 1st person in the results of the find command.

3.25. Add a New Item : itemadd or ia [Since v1.4]

Attaching a new item to a specified person.
Format: itemadd INDEX n/ITEM_NAME m/MONEY or ia INDEX n/ITEM_NAME m/MONEY

  • To view the newly added item, please use the itemshow command!

  • The index refers to the index number shown in the most recent listing.

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

Examples:

  • itemadd 2 n/taxiFare m/10.0

3.26. Delete an Existing Item : itemdelete or id [Since v1.5rc]

Deleting an item from a specified person.
Format: itemdelete PERSON_INDEX ITEM_INDEX or id PERSON_INDEX ITEM_INDEX

  • The index of person refers to the one shown in the most recent listing.

  • The index of item refers to the one shown in the itemshow result.

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

Examples:

  • itemdelete 1 2

  • This deletes the second item from the first person in the contact list.

3.27. Settling up your balance with a contact: settle or stl[Since v1.3]

Sets the balance of the specified contact to 0.
Format: settle INDEX

3.28. Remind a contact to pay their balance: remind or rm[Since v1.4]

Opens the default email client with a generated email to the contact with the balance in the message. Format: remind INDEX === View a contact’s address on the map with select [Since v1.4]

Searches for the contact’s address in the map displayed once that contact is selected. Format : select INDEX === Converts your balance in a desired currency: convert or cv [Since v1.4]

Converts an entries certain balance in a currency of your choice. Format: convert INDEX FROM_CURRENCY TO_CURRENCY` or cv INDEX FROM_CURRENCY TO_CURRENCY

Example: convert 2 USD JPY Example: convert 1 SGD USD

3.29. Delete an Existing Item : itemdelete or id [Since v1.5rc]

Deleting an item from a specified person.
Format: itemdelete PERSON_INDEX ITEM_INDEX or id PERSON_INDEX ITEM_INDEX

  • The index of person refers to the one shown in the most recent listing.

  • The index of item refers to the one shown in the itemshow result.

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

Examples:

  • itemdelete 1 2

  • This deletes the second item from the first person in the contact list. === All similar tags now have a unique color [Since v1.5rc]

All similar tags found in TravelBanker now have a color specific to it.

3.30. List of all contacts with a specific tag [Since v1.5rc]

User can have a list of all contacts that contain the specified tags. Example: searchtag t/friends Example: st t/colleagues t/friends

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

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

3.32. Applies an interest rate to your balance: interest FACTOR or i FACTOR [Coming in v2.0]

Displays your balance with an applied interest rate. Format: interest FACTOR or i FACTOR

3.33. Lists a description of the debts someone owes you: describe or db [Coming in v2.0]

Lists the description consisting of keywords that explain why someone owes you an amount. This facilitates understanding of the debt. Format: describe INDEX

3.34. Report a transaction and automatically update a contact’s balance accordingly: transaction or t [Since v1.5rc]

Updates the contacts balance with the correct new balance after the transaction. For TRANSACTION_AMOUNT, a positive number represents money received from the contact and a negative number represents money paid to the contact. Format : transaction INDEX TRANSACTION_AMOUNT

3.35. Shows on which trip a balance was established from user and contact : trip [DESTINATION] or t [Coming in v2.0]

Each contact will have a [DESTINATION] field to keep track of where a transaction between the user and the contact took place. Format: trip [DESTINATION]

3.36. Change the color of a specific tag in the address book [Coming in V2.0]

The user can select the color he wants a specific tag to be. Format: colortag c/COLOR t/TAGS or ct c/COLOR t/TAGS

== 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 accounting book folder.

== 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

  • Clear : clear

  • Delete : delete INDEX
    e.g. delete 3

  • Balance : balance

  • 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

  • Map: map

  • Undo : undo

  • Redo : redo

  • RemoveTag : removetag INDEX [t/TAG]…​

  • SearchTag : searchtag t/TAG e.g. searchtag t/classmates t/friends

  • Sort : sort KEYWORD_PREFIX/ORDER

  • Split : split INDEX1 [INDEX2…​] m/MONEY

  • ItemShow : itemshow INDEX

  • ItemAdd : itemadd INDEX n/ITEM_NAME m/MONEY

  • ItemDelete : itemdelete PERSON_INDEX ITEM_INDEX

  • Max : max

  • Min : min

  • Currency : currency c/ e.g. currency c/USD