Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update UG for Practical dry run #88

Merged
merged 1 commit into from
Oct 31, 2019
Merged

Update UG for Practical dry run #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 63 additions & 80 deletions docs/UserGuide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ Format: `help`
Shows a list of all expenses that do not fall into any budgets in expenseList. +
Format: `list`

=== Listing all budgets in the budget list : `listbudgets`
=== Listing all budgets in the budget list : `budgetlist`
Shows a list of all budgets. +
Format: `listbudgets`
Format: `budgetlist`

=== Adding an expense: `add`
Adds an expense to track.* +
Expand Down Expand Up @@ -107,9 +107,13 @@ 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`
=== Viewing a budget : `view`
Views an existing budget in the budget list. +
Format: `view INDEX`

****
* Views the expenses stored in the budget, and shows the amount of money left in the budget.
****

=== Editing an expense : `edit`
Edits an existing expense in the expense list. +
Expand All @@ -133,7 +137,7 @@ Edits the amount of the first expense to be `$20.10`.
Replaces the name of the second expense to `Poets Coffee` and clears all existing tags.

=== Editing a budget : `editBudget`
Edits an existing budget in the budget list.* +
Edits an existing budget in the budget list. +
Format: `editBudget INDEX [n/NAME] [a/AMOUNT] [c/CURRENCY]…`

****
Expand All @@ -151,26 +155,6 @@ Edits the name and the amount of the first budget to `Japan Travel` and `4000` r
* `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]`

****
* Search by name and tag is case insensitive. e.g hans will match Hans
* Search by date must use the date format `dd/MM/yyyy`
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
* Only the fields provided are searched.
* Only whole words will be matched e.g. `Han` will not match `Hans`
****

Examples:

* `find n/Coffee` +
Returns `coffee` and `Starbucks Coffee`.
* `find n/Cheesecake` +
Returns any expense having names `Cheesecake`, eg: `Strawberry Cheesecake`, `Blueberry Cheesecake`.

// tag::delete[]
=== Deleting an item : `delete`
Deletes the item at the specified index.* +
Expand All @@ -194,11 +178,10 @@ Examples:
* `list` +
`delete 2` +
Deletes the second expense in the default expense list in MYMorise.
Deletes the 2nd expense in expenseList.

* `find n/Coffee` +
`delete 1` +
Deletes the 1st expense in the results of the find command.
Deletes the first expense in the results of the find command.

*While viewing list of budgets*

Expand All @@ -207,63 +190,24 @@ Deletes the 1st expense in the results of the find command.
Deletes the second budget in the budget list in MYMorise.
// end::delete[]

=== Automatic currency conversion for foreign currencies
MyMorise is able to automatically display foreign currencies in the default currency set by the user. By default this is set
to Singapore Dollars (SGD). The conversions are done in the following scenarios:

* When an expenses specifies a currency that is not the default currency
* When an expense specifies a currency that is different from that budget it is associated to.

This automatic conversion allows for the computation of budgets and expenses regardless of their underlying currencies to provide
a cleaner experience when viewing budgets and expenses with multiple differing currencies.

The latest Foreign Exchange data for a limited set of supported currencies are updated whenever the application is launched. The list of supported currencies are as follows:
=== Clearing a list : `clear`
Deletes all items in the current list.* +
Format: `clear`

* CAD
* HKD
* ISK
* PHP
* DKK
* HUF
* CZK
* GBP
* RON
* SEK
* IDR
* INR
* BRL
* RUB
* HRK
* JPY
* THB
* CHF
* EUR
* MYR
* BGN
* TRY
* CNY
* NOK
* NZD
* ZAR
* USD
* MXN
* SGD
* AUD
* ILS
* KRW
* PLN
Using `clear` while viewing an expenselist will delete all expenses in that list. +
Using `clear` while viewing the budgetlist will delete all budgets in the list.

=== Autocomplete
Equip with IDE-like autocomplete function for faster input and
enables user to quickly fill in command arguments with an
autocomplete suggestion.
enables users to quickly fill in command arguments with
autocomplete suggestions.

Suggestions include commonly used words in MYMorise and user can customize the suggestion list by changing the
Suggestions include commonly used words in MYMorise and users may customize the suggestion list by changing the
`vocabulary.txt`

When the user type, if there are suggestions for a certain input, user can press kbd:[tab] to autofill the first
suggestion. Or press kbd:[DOWN] or kbd:[UP] to navigate between suggestions and then press kbd:[tab] or kbd:[enter]
to autofill the selected item. You can also just kbd:[click] on an item to autofill.
When the user types, if there are suggestions for a certain input, user can press kbd:[tab] to autofill the first
suggestion or press kbd:[DOWN] and kbd:[UP] to navigate between suggestions and then press kbd:[tab] or kbd:[enter]
to autofill the selected item. User may also just kbd:[click] on an item to autofill.

=== Exiting the program : `exit`
Exits the program. +
Expand All @@ -275,6 +219,44 @@ Expense and Budget data are saved in the hard disk automatically after any comma
There is no need to save manually.
// end::saving[]

=== Automatic currency conversion for foreign currencies `[coming in v1.4]`
MYMorise is able to automatically display foreign currencies in the default currency set by the user. By default this is set
to Singapore Dollars (SGD). The conversions are done in the following scenarios:

* When an expenses specifies a currency that is not the default currency
* When an expense specifies a currency that is different from that budget it is associated to.

This automatic conversion allows for the computation of budgets and expenses regardless of their underlying currencies to provide
a cleaner experience when viewing budgets and expenses with multiple differing currencies.

The latest Foreign Exchange data for a limited set of supported currencies are updated whenever the application is launched. The list of supported currencies are as follows:

[width="80%",cols="10%,10%,10%,10%,10%,10%,10%,10%,10%,10%,10%",options="header",]
|=======================================================================
| CAD | HKD | ISK | PHP | DKK | HUF | CZK | GBP | RON | SEK | IDR
| INR | BRL | RUB | HRK | JPY | THB | CHF | EUR | MYR | BGN | TRY
| CNY | NOK | NZD | ZAR | USD | MXN | SGD | AUD | ILS | KRW | PLN
|=======================================================================

=== Locating expenses by name: `find` `[coming in v1.4]`
Finds all expenses by name, date, tag. +
Format: `find [n/NAME] [d/DATE] [t/TAG]`

****
* Search by name and tag is case insensitive. e.g hans will match Hans
* Search by date must use the date format `dd/MM/yyyy`
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
* Only the fields provided are searched.
* Only whole words will be matched e.g. `Han` will not match `Hans`
****

Examples:

* `find n/Coffee` +
Returns `coffee` and `Starbucks Coffee`.
* `find n/Cheesecake` +
Returns any expense having names `Cheesecake`, eg: `Strawberry Cheesecake`, `Blueberry Cheesecake`.

=== Display expense by tag in chart `[coming in v2.0]`
_{Displays the expense in a pie chart to show breakdown of expenses.}_

Expand All @@ -296,12 +278,12 @@ _{User is able to navigate using up and down keys to cycle through past commands

* *Help* : `help`
* *List* : `list`
* *List Budgets* : `listbudgets`
* *List Budgets* : `budgetlist`
* *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`
* *View Budget* : `view INDEX`
* *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]` +
Expand All @@ -311,5 +293,6 @@ e.g. `find n/Coffee d/13/12/2019 t/nourishment` +
e.g. `find t/nourishment`
* *Delete* : `delete INDEX` +
e.g. `delete 3`
* *Clear* : `clear`
* *Exit* : `exit`