mirror of
https://github.com/actualbudget/actual.git
synced 2026-04-28 01:58:40 -05:00
update template docs to match changes (#477)
Matches limit additions in actualbudget/actual#3754. Original PR with descriptions is actualbudget/actual#3714 Tweaks a few other things to retain accuracy.
This commit is contained in:
@@ -7,11 +7,11 @@ This is an **experimental feature**. That means we’re still working on finishi
|
||||
All functionality described here may not be available in the latest stable release. Use the `edge` images for the latest implementation.
|
||||
:::
|
||||
|
||||
Create a template by adding a note to a category and adding a line that begins with `#template`.
|
||||
Create a template by adding a note to a category and adding a line that begins with `#template` or `#goal`.
|
||||
|
||||

|
||||
|
||||
You are welcome to have other lines in your note, but the #template line must match the syntax.
|
||||
You are welcome to have other lines in your note, but the #template/#goal line must match the syntax.
|
||||
|
||||
## Available Templates
|
||||
|
||||
@@ -19,9 +19,11 @@ You are welcome to have other lines in your note, but the #template line must ma
|
||||
|Syntax|Description|Example Application|
|
||||
|---|---|---|
|
||||
|#template $50|Budget $50 each month|Regular monthly bills, such as internet|
|
||||
|#template $50 up to $300|Budget $50 each month up to a maximum of $300|Funding rainy day categories, such as replacement shoes and bicycle repairs
|
||||
|#template up to $150|Budget up to $150 each month, and remove extra funds over $150|Variable expenses, such as petrol and groceries|
|
||||
|#template up to $150 hold|Budget up to $150 each month, but retain any funds over $150 |Variable expenses that may get refunds or reimbursements|
|
||||
|#template $50 up to $300|Budget $50 each month up to a maximum of $300|Funding rainy day categories, such as replacement shoes and bicycle repairs
|
||||
|#template up to $5 per day |Budget up to $5 per day that month, and remove extra funds | Setting a daily coffee budget|
|
||||
|#template up to $100 per week starting 2024-10-07 |Budget $100 per week starting on Mondays, and remove extra funds| Setting a weekly grocery budget |
|
||||
|#template $500 by 2025-03|Break down large, less-frequent expenses into manageable monthly expenses|Saving for a replacement car in a few years
|
||||
|#template $500 by 2025-03 repeat every 6 months|Break down large, less-frequent expenses into manageable monthly expenses|Biannual credit card fees
|
||||
|#template $500 by 2025-03 repeat every year|Break down large, less-frequent expenses into manageable monthly expenses|Annual insurance premium
|
||||
@@ -37,7 +39,7 @@ You are welcome to have other lines in your note, but the #template line must ma
|
||||
|#template 10% of Paycheck|Budget 10% of the "Paycheck" income category| Using a "pay yourself first" strategy, but have income categories you want to ignore|
|
||||
|#template 15% of previous all income|Budget 15% of all income categories using last month's income|Using a "pay yourself first" strategy in conjunction with a "month ahead" strategy |
|
||||
|#template 10% of previous Paycheck|Budget 10% of last month's "Paycheck" income category| Using a "pay yourself first" strategy in conjunction with a "month ahead" strategy, but have income categories you want to ignore|
|
||||
|#template 12% of available funds|Budget 12% of your "To Budget" funds| |
|
||||
|#template 12% of available funds|Budget 12% of your "To Budget" funds available at the current priority level| |
|
||||
|#template schedule {SCHEDULE NAME}|Fund upcoming scheduled transactions over time|Monthly schedules, or larger non-monthly scheduled transactions|
|
||||
|#template schedule full {SCHEDULE NAME}|Fund upcoming scheduled transaction only on needed month| Small schedules that are non-monthly|
|
||||
|#template average 6 months | Budget the average amount spent over the last 6 months. Can set the number to any number > 0. Matches the existing option on the budget page but with flexible month ranges |
|
||||
@@ -54,7 +56,7 @@ You are welcome to have other lines in your note, but the #template line must ma
|
||||
- By default templates do not consider available funds when being applied. Use template priorities to not budget more than is available.
|
||||
- The `hold` flag can be added to any goal that uses the `up to` key word.
|
||||
- A single category with two templates that use `up to` is not supported.
|
||||
- If in a category there are multiple templates within the same priority level and one template uses the `up to` key word, all templates in that priority level will be limited to the maximum amount specified by `up to`.
|
||||
- If any single template contains an `up to`, the whole category will be subject to that limit even if there are later templates and priorities. This excludes remainders which will run after the limit is applied.
|
||||
|
||||
### Multiple Template Lines
|
||||
|
||||
@@ -93,7 +95,6 @@ Templates can be given a priority flag to change the order that the templates ge
|
||||
- Negative priorities are not allowed and will result in the template being skipped.
|
||||
- Template application order is based on the database order, not the view order. To guarantee a specific fill order use separate priorities for each category.
|
||||
- If you have multiple `schedule` or `by` template lines in a single category, they will be forced to match the same priority level as the line run first.
|
||||
- If the `up to` key words are used with a category that has multiple templates with different priorities, the lowest priority will take precedence because it is evaluated last as shown in the following examples.
|
||||
- It is recommended to use the "overwrite with budget template" option when applying templates if you use priorities.
|
||||
|
||||
- **Expected budgeted amount is 200**
|
||||
|
||||
Reference in New Issue
Block a user