A local-first personal finance app
Fixing #728 - add command palette documentation in Tips and Tricks page. (#731)
Ruben Olsen Lærk7402e4bb66bf
diff --git a/docs/getting-started/tips-tricks.md b/docs/getting-started/tips-tricks.mdindex b6ce5f2bf9..e1a36cdfb2 100644--- a/docs/getting-started/tips-tricks.md+++ b/docs/getting-started/tips-tricks.md@@ -9,27 +9,39 @@ If you ever make a mistake, pressing <Key mod="cmd" k="z" /> will undo, and pres## Keyboard Shortcuts-Firstly, a few global shortcuts for the Electron App that is still in development. Please be aware that these global shortcuts do not work in the web app:+Actual has a number of keyboard shortcuts that can help you navigate and manage the application more efficiently.+Below is a list of the most useful shortcuts.-- <Key mod="cmd" k="1" /> will show the budget-- <Key mod="cmd" k="2" /> will show reports-- <Key mod="cmd" k="3" /> will show all accounts+### The Command Palette-BUT here is one that WILL work in the web app as well:-- <Key mod="cmd" k="O" /> (O not zero) this will close the file and list other available files to open+The Command Palette is a powerful tool which allows you to quickly access various features and functions within Actual.+- On Windows and Linux, you can open it by pressing the <Key mod="ctrl" k="k" /> combination to open the Command Palette.+- On macOS, you can use the <Key mod="cmd" k="k" /> or the <Key mod="ctrl" k="k" /> key combinations to open the Command Palette.-### Budget+++Once open, you can start typing to search for the functions in the sidebar, or you can use the arrow keys to navigate+through the list of available commands. You can also quickly move to any of the available accounts by typing their name.+++### Other Global Shortcuts++- <Key mod="ctrl" k="O" /> (the letter O, not zero) this will close the file and list other available files to open.+ On macOS, you can also use the <Key mod="cmd" k="O" /> key combination.+++### Within the Budget View- <Key k="enter" /> while editing a budget amount will move to the next category.- <Key mod="shift" k="enter" /> will move to the previous category.-### Transaction Editing+### When Editing Transactions- When editing, <Key k="enter" /> and <Key mod="shift" k="enter" /> will move down and up. If a dropdown is open and you've typed a new value, this will instead save the value and close the dropdown.- When editing, <Key k="tab" /> and <Key mod="shift" k="tab" /> will move left and right- When adding a new transaction, <Key mod="cmd" k="enter" /> will add it regardless of where you are editing. Pressing <Key k="enter" /> in either the Payment or Deposit columns will add it as well.-### Transaction Management+### When Managing Transactions- <Key k="f" /> Show only selected transactions.- <Key k="d" /> Delete selected transactions.@@ -46,7 +58,7 @@ The following require a transaction to have been selected first:- <Key k="space" /> Toggle selection of current transaction.- <Key mod="shift" k="space" /> Add all transactions between current transaction and most recently selected transaction.-## View Multiple Months at Once+## How to View Multiple Months at OnceIn the top left of the budget, you will see this control:@@ -87,9 +99,7 @@ its original form.---## Show Running Balance+## Show The Running BalanceA "running balance" is the balance of the account after every transaction over time. This is very useful for reconciling accounts with banks because you can see the balance at a specific date and use it to compare it with your bank. Note that the "Show running balance" option and column is only available when the list of transactions is sorted by date in descending order.diff --git a/static/img/tips-tricks/command-palette.png b/static/img/tips-tricks/command-palette.pngnew file mode 100644index 0000000000..30e9af0234Binary files /dev/null and b/static/img/tips-tricks/command-palette.png differ