A local-first personal finance app
Add Tags documentation (#756)
POGMANcf1cafa46b12
diff --git a/docs-sidebar.js b/docs-sidebar.jsindex 9f4c859d85..88358fa3d4 100644--- a/docs-sidebar.js+++ b/docs-sidebar.js@@ -171,6 +171,7 @@ const sidebars = {'accounts/reconciliation','transactions/payees','transactions/bulk-editing',+ 'transactions/tags',{type: 'category',label: 'Connecting Your Bank',diff --git a/docs/transactions/tags.md b/docs/transactions/tags.mdnew file mode 100644index 0000000000..cc710907ae--- /dev/null+++ b/docs/transactions/tags.md@@ -0,0 +1,36 @@+# Tags++Transactions can be easily flagged and identified in the table by tagging them through their notes.+An example would be to tag all transactions for a trip with a tag like `#Vacation2025`++## Syntax++A tag is a string of any characters (except `#`) prefixed by the `#` symbol; it can be added anywhere within the *Notes* field of a transaction.+It is possible to have multiple tags for a single transaction.+Tags are case-sensitive, meaning that `#tag` and `#TAG` are different.+To use the `#` symbol in the *Notes* field without tagging, you can escape it by inputting it twice: `##do-not-tag-this`.++++++## Filter Transactions++To view transactions with a given tag, you can either:+- Click on the colored tag in the transactions table.+- Use the `has tags` filter on the *Notes* field:++++## Manage Tags++By default, tags use the purple brand color of Actual.+If you use a lot of tags, it can be helpful to customize the color of the tags. You can configure this through the dedicated *Tags* page, located in the sidebar.++++On the Tag management page, you can perform the following actions:+- **Add New** tags. It doesn't matter whether any transactions with this tag already exist or not.+- **Find Existing Tags**, searches for tags already used within transactions and adds them to the list of managed tags.+- Change the color of any tag and/or add a description.+- **View Transactions** which use a given tag.diff --git a/static/img/tags/filter.png b/static/img/tags/filter.pngnew file mode 100644index 0000000000..615ed4ebb4Binary files /dev/null and b/static/img/tags/filter.png differdiff --git a/static/img/tags/input-result.png b/static/img/tags/input-result.pngnew file mode 100644index 0000000000..2fcd72bceeBinary files /dev/null and b/static/img/tags/input-result.png differdiff --git a/static/img/tags/input.png b/static/img/tags/input.pngnew file mode 100644index 0000000000..a6765cbbb2Binary files /dev/null and b/static/img/tags/input.png differdiff --git a/static/img/tags/manage.png b/static/img/tags/manage.pngnew file mode 100644index 0000000000..30880ec6deBinary files /dev/null and b/static/img/tags/manage.png differ