update ug

docs/UserGuide.adoc

@@ -59,52 +59,99 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
 Displays all CLI commands available. +
 Format: `help`
 
-=== Adding an expense: `add`
+=== Listing all expenses in the default expense list : `list`
+Shows a list of all expenses that do not fall into any budgets in MYMorise. +
+Format: `list`
 
-Adds an expense to track. +
-Format: `add n/NAME a/AMOUNT [t/TAG]…​`
+=== Listing all budgets in the budget list : `listbudgets`
+Shows a list of all budgets in MYMorise. +
+Format: `listbudgets`
+
+=== Adding an expense: `add`
+Adds an expense to track.* +
+Format: `add n/NAME a/AMOUNT [c/CURRENCY] [d/DATE] [t/TAG]…​`
 
 [TIP]
-An expense can have any number of tags (including no tags)
+An expense with no currency specified will have the default currency set.
+[TIP]
+An expense with no date specified will default to current date of addition.
+[TIP]
+An expense can have any number of tags (including no tags).
 
 Examples:
 
 * `add n/Coffee a/1.80 t/food`
 * `add n/Textbook a/23.50 t/education t/school`
 
-=== Listing all expenses : `list`
+*An added expense may automatically fall into a budget if the date of expense
+falls into a budget period. Otherwise it will fall into the default expense list.
 
-Shows a list of all expenses with optional matching criterion in MYMorise. +
-Format: `list`
+=== Adding a budget : `budget`
+Specifies a budget for a period beginning from the specified start date to an end date. +
+Format: `budget n/NAME a/AMOUNT [c/CURRENCY] d/STARTDATE ed/ENDDATE`
 
-=== Viewing expenses in a period : `view`
+****
+* Sets a budget for a period beginning from STARTDATE to ENDDATE (inclusive). All expenses made during
+that period after the budget is set, will be included into the budget and the budget will deduct the expense
+to indicate how much funds are left available to spend.
+* Only expenses made that fall into the budget period after the budget is set will
+be included into the budget. Expenses created before the budget is set but falls into the budget period
+will not be included into the budget. They will remain in the default expense list.
+****
+[TIP]
+A budget with no currency specified will have the default currency set.
+
+Examples:
 
+* `budget n/Japan Travel a/4000 c/USD d/9/10/19 ed/19/10/19` +
+Sets a budget of SGD4000 for the period from Wed, 9th Oct 19 to Sat, 19th Oct 19.
+* `budget n/January 2019 Budget a/800 c/SGD d/1/1/19 ed/31/1/19` +
+Sets a budget of SGD800 for the period from Tue, 1st Jan 19 to Thu, 31st Jan 19.
+
+=== Viewing expenses in a period : `view`
 View daily or monthly expenses. +
 Format: `view`
 
 === Editing an expense : `edit`
-
 Edits an existing expense in the expense list. +
-Format: `edit INDEX [n/NAME] [a/AMOUNT] [t/TAG]…`
+Format: `edit INDEX [n/NAME] [a/AMOUNT] [c/CURRENCY] [t/TAG]…`
 
 ****
 * Edits the expense at the specified `INDEX`. The index refers to the index number shown in the displayed expense list. The index *must be a positive integer* 1, 2, 3, …​ The index is relative to what is displayed on the GUI rather than the actual index of the expense in MYMorise.
 * 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 expense will be removed i.e adding of tags is not cumulative.
 * You can remove all the expense’s tags by typing `t/`  without specifying any tags after it.
-
 ****
 
 Examples:
 
 * `edit 1 a/20.10` +
-Edits the amount of the 1st expense to be `$20.10`.
+Edits the amount of the first expense to be `$20.10`.
 * `edit 2 n/Poets Coffee t/` +
-Replaces the name of the 2nd expense to `Poets Coffee` and clears all existing tags.
+Replaces the name of the second expense to `Poets Coffee` and clears all existing tags.
 
-=== Locating expenses by name: `find`
+=== Editing a budget : `editBudget`
+Edits an existing budget in the budget list.* +
+Format: `editBudget INDEX [n/NAME] [a/AMOUNT] [c/CURRENCY]…`
+
+****
+* Edits the budget at the specified `INDEX`. The index refers to the index number shown in the displayed budget list.
+The index *must be a positive integer* 1, 2, 3, …​ The index is relative to what is displayed on the GUI rather than
+the actual index of the budget in MYMorise.
+* At least one of the optional fields must be provided.
+* Existing values will be updated to the input values.
+****
+
+Examples:
+
+* `editBudget 1 n/Japan Travel a/4000` +
+Edits the name and the amount of the first budget to `Japan Travel` and `4000` respectively.
+* `editBudget 2 c/USD` +
+Edits the currency of the second budget to `USD` only. Other fields remain unchanged.
 
+
+=== Locating expenses by name: `find`
 Finds all expenses by name, date, tag. +
 Format: `find [n/NAME] [d/DATE] [t/TAG]`
 
@@ -124,83 +171,69 @@ Returns `coffee` and `Starbucks Coffee`.
 Returns any expense having names `Cheesecake`, eg: `Strawberry Cheesecake`, `Blueberry Cheesecake`.
 
 // tag::delete[]
-=== Deleting an expense : `delete`
-
-Deletes the specified expense from MYMorise. +
+=== Deleting an item : `delete`
+Deletes the item on the specified index from MYMorise.* +
 Format: `delete INDEX`
 
 ****
-* Deletes the expense at the specified INDEX.
-* The index refers to the index number shown in the displayed expense list.
+* Deletes the item at the specified INDEX.
+* The index refers to the index number shown in the displayed list.
 * The index *must be a positive integer* 1, 2, 3, …​
- The index is relative to what is displayed on the GUI rather than the actual index of the stored expenses.
+ The index is relative to what is displayed on the GUI rather than the actual index of the stored items.
 ****
 
+*The item to be deleted depends on the current view state. If the user is currently viewing
+a list of expenses, then delete will delete the expense specified by index. If the user
+is currently viewing a list of budgets, then delete will delete the budget specified by index.
+
 Examples:
 
+*While viewing list of expenses*
+
 * `list` +
 `delete 2` +
-Deletes the 2nd expense in MYMorise.
+Deletes the second expense in the default expense list in MYMorise.
 * `find n/Coffee` +
 `delete 1` +
 Deletes the 1st expense in the results of the find command.
 
+*While viewing list of budgets*
 
+* `listbudgets` +
+`delete 2`
+Deletes the second budget in the budget list in MYMorise.
 // end::delete[]
 
-=== Exiting the program : `exit`
+=== Setting a default currency for MYMorise
+todo
+
+=== Convert butgets or expenses to a different currency
+{Shows the current list of expenses in a certain currency}
 
+=== Autocomplete
+{Enables user to quickly fill in command arguments with an autocomplete suggestion by pressing tab on the selected suggestion.}
+
+=== Exiting the program : `exit`
 Exits the program. +
 Format: `exit`
 
 // tag::saving[]
 === Saving data
-
-Expense data are saved in the hard disk automatically after any command that changes the data.
+Expense and Budget data are saved in the hard disk automatically after any command that changes the data.
 There is no need to save manually.
 // end::saving[]
 
-// tag::budget[]
-=== Set a budget for a period : `budget`
-
-Specifies a budget for a period beginning from the specified start date to an end date. +
-Format: `budget n/NAME a/AMOUNT d/STARTDATE ed/ENDDATE `
-
-****
-* Sets a budget for a period beginning from STARTDATE to ENDDATE (inclusive). All expenses made during
-  that period will be included into the budget and the budget will deduct the expense
-  to indicate how much funds are left available to spend.
-* The NAME refers to a name description to be given to the budget.
-* The STARTDATE and ENDDATE refers to a specific date.
-* The AMOUNT refers to the amount set for the budget.
-****
-
-Examples:
-
-* `budget n/Japan Travel a/SGD4000 d/9/10/19 ed/19/10/19` +
-Sets a budget of SGD4000 for the period from Wed, 9th Oct 19 to Sat, 19th Oct 19.
-* `budget n/January 2019 Budget a/SGD800 d/1/1/19 ed/31/1/19` +
-Sets a budget of SGD800 for the period from Tue, 1st Jan 19 to Thu, 31st Jan 19.
-
-// end::budget[]
-
 === Display expense by tag in chart `[coming in v2.0]`
-{Displays the expense in a pie chart to show breakdown of expenses.}
+_{Displays the expense in a pie chart to show breakdown of expenses.}_
 
 === Set a Recurring Expense `[coming in v2.0]`
-{Sets a recurring expense for a specific duration and frequency.}
-
-=== Convert expenses to a specific currency `[coming in v2.0]`
-{Shows the current list of expenses in a certain currency}
+_{Sets a recurring expense for a specific duration and frequency.}_
 
 === Undo/Redo commands `[coming in v2.0]`
-{Allows user to undo and redo commands.}
-
-=== Autocomplete `[coming in v2.0]`
-{Enables user to quickly fill in command arguments with an autocomplete suggestion by pressing tab on the selected suggestion.}
+_{Allows user to undo and redo commands.}_
 
 === Show command history `[coming in v2.0]`
-{User is able to navigate using up and down keys to cycle through past commands typed during the session.}
+_{User is able to navigate using up and down keys to cycle through past commands typed during the session.}_
 
 === FAQ
 
@@ -210,16 +243,21 @@ Sets a budget of SGD800 for the period from Tue, 1st Jan 19 to Thu, 31st Jan 19.
 == Command Summary
 
 * *Help* : `help`
-* *Add* `add n/NAME a/AMOUNT [t/TAG]…` +
-e.g. `add n/Coffee a/2.00 t/nourishment t/school`
 * *List* : `list`
+* *List Budgets* : `listbudgets`
+* *Add* : `add n/NAME a/AMOUNT [c/CURRENCY] [d/DATE] [t/TAG]…` +
+e.g. `add n/Coffee a/2.00 c/SGD t/nourishment t/school`
+* *Add Budget* : `budget n/NAME a/AMOUNT [c/CURRENCY] d/STARTDATE ed/ENDDATE`
+e.g. `budget n/Japan Travel a/4000 c/USD d/9/10/19 ed/19/10/19`
 * *View* : `view`
-* *Edit* : `edit INDEX [n/NAME] [a/AMOUNT] [t/TAG]…​` +
+* *Edit* : `edit INDEX [n/NAME] [a/AMOUNT] [c/CURRENCY] [t/TAG]…​` +
 e.g. `edit 2 n/Starbucks Coffee t/nourishment`
+* *Edit Budget* : `editBudget INDEX [n/NAME] [a/AMOUNT] [c/CURRENCY]` +
+e.g. `editBudget 3 n/Korea Travel c/KRW`
 * *Find* : `find [n/NAME] [d/DATE] [t/TAG]` +
 e.g. `find n/Coffee d/13/12/2019 t/nourishment` +
 e.g. `find t/nourishment`
 * *Delete* : `delete INDEX` +
 e.g. `delete 3`
-* *Budget* : `budget n/NAME a/AMOUNT d/STARTDATE ed/ENDDATE` +
-e.g. `budget n/Japan Travel a/SGD4000 d/9/10/19 ed/19/10/19`
+* *Exit* : `exit`
+