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.

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

fix formatting issues in ug #214

Merged
merged 2 commits into from
Apr 8, 2023
Merged
Changes from all commits
Commits
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
31 changes: 26 additions & 5 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ title: FastTrack User Guide
8. [Saving the data](#saving-the-data)
9. [Editing the data file (For Advanced Users)](#editing-the-data-file)
10. [Frequently Asked Questions](#frequently-asked-questions)


--------------------------------------------------------------------------------------------------------------------
# Introduction to FastTrack

Expand Down Expand Up @@ -271,7 +273,7 @@ FastTrack offers a variety of commands that you can use to take advantage of its
| [**Add Expense**](#adding-an-expense-add) | `add c/CATEGORY_NAME n/ITEM_NAME p/PRICE [d/DATE]` | `add c/Food p/20 n/Mac d/14/2/23` |
| [**Delete Expense**](#deleting-an-expense-delete) | `delete INDEX` | `delete 1` |
| [**Edit Expense**](#editing-an-expense-edexp) | `edexp INDEX [c/CATEGORY_NAME] [n/EXPENSE_NAME] [d/DATE] [p/PRICE]` | `edexp 1 c/Food n/Mac d/20/4/23 p/10` |
| [**Find Expense**](#search-for-an-expense-by-keyword-find) | `find KEYWORD [MORE_KEYWORDS]` | `find KFC chicken` || [**List Recurring Expense**](#listing-recurring-expense-lrec) | `lrec` | `lrec` |
| [**Find Expense**](#search-for-an-expense-by-keyword-find) | `find KEYWORD [MORE_KEYWORDS]` | `find KFC chicken` |
| [**List Recurring Expense**](#listing-recurring-expenses-lrec) | `lrec` | `lrec` |
| [**Add Recurring Expense**](#adding-a-recurring-expense-addrec) | `addrec c/CATEGORY_NAME n/ITEM_NAME p/PRICE t/INTERVAL sd/START_DATE [ed/END_DATE]` | `addrec c/Shows n/Netflix p/10 t/month sd/10/3/23 ed/10/03/24` |
| [**Delete Recurring Expense**](#deleting-a-recurring-expense-delrec) | `delrec INDEX` | `delrec 1` |
Expand Down Expand Up @@ -361,15 +363,15 @@ Format: `delcat INDEX`
|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `INDEX` | The index number shown in the displayed category list.<br/><br/>It must be a positive integer i.e. 1, 2, 3, ...<br/><br/>Expenses previously categorised under the specified category will be automatically re-categorized under the `Misc` category.<br/> |

<div>
**:information_source: Info**<br>

<div markdown="block" class="alert alert-info">
**:information_source: Info:**<br>

If you delete a category that has existing expenses associated with it, those expenses will be automatically reassigned to the default internal `Misc` category. But don't worry! You can still re-assign them later with the [edit expense command](#editing-an-expense-edexp). To avoid losing track of expenses, we recommend that you review and update your categories periodically, rather than deleting them altogether.

</div>



### Examples
* `lcat` followed by `delcat 2` deletes the second category in the category list
* `lcat` followed by `delcat 1` deletes the first category in the category list
Expand Down Expand Up @@ -625,6 +627,15 @@ Note that once a recurring expense is added, it automatically adds a series of e
</div>


<div markdown="block" class="alert alert-primary">:bulb: Tip:

FastTrack's recurring expense feature is designed to help you keep track of regular expenses that occur at a fixed interval, such as monthly subscription fees or cloud storage bills.
By setting up a recurring expense, you save precious time and effort by automating the process of adding these expenses to FastTrack.

</div>



<div markdown="block" class="alert alert-warning">

**:exclamation: Caution**<br>
Expand Down Expand Up @@ -743,7 +754,9 @@ Format `set p/AMOUNT`
<div markdown="block" class="alert alert-warning">

**:exclamation: Caution**<br>

FastTrack does not allow setting a budget of $0

</div>


Expand All @@ -770,6 +783,13 @@ Give it a try and see how much time you can save with this feature!
- If the category you're looking for is conveniently at the bottom of the list, simply press `TAB` to autocomplete the first suggested category without having to navigate through the list manually!
- If you decide not to use any of the suggested categories, just continue typing your own category name as per normal.

<div markdown="block" class="alert alert-primary">:bulb: Tip:

Want to use `TAB` directly without navigating inside the suggestion list?
Narrow down the list of suggested categories by typing the first few words of your desired category name. Once the option appears at the bottom of the list, simply press `TAB` for autocompletion.

</div>


<div markdown="block" class="alert alert-warning">
**:exclamation: Caution**<br>
Expand All @@ -783,8 +803,9 @@ If there's any other text in front of `c/`, the autocompletion feature will be d

1. Enter `list c/` into the command box
2. A list of suggested categories appear in a popup above the command box
3. Navigate into the suggestion list and press `ENTER` on the desired category `Transportation`.
3. Navigate into the suggestion list using the `UP` arrow key and press `ENTER` on the desired category `Transportation`.
4. This autocompletes the category name
5. If you need to navigate out of the suggestion list, press the `DOWN` arrow key until the cursor returns to the command box

![FastTrack autocomplete_a1](images/demo/general/autocomplete_a1.png)
![FastTrack autocomplete_a2](images/demo/general/autocomplete_a2.png)
Expand Down