- rewritten assistant tutorial texts

This commit is contained in:
Cioraneanu Mihai
2024-12-18 14:15:48 +02:00
parent f56a3fa1b6
commit 43a63dbb59
7 changed files with 39 additions and 30 deletions

View File

@@ -2,28 +2,22 @@
Easily turn words into a transaction. You can even use phone's dictation for a hands free experience :loudspeaker:
Expected format: ```[Tag / category / template] [amount?] [description?]"```
### Format
`[Tag / category / template] [amount?] [description?] [todo?]`
- All _words_ until the first numerical value is the "**search phrase**". This phrase is searched in your list of Tags, Categories and Templates. It supports entering just part of the name and even getting some of the letters wrong (fuzzy search).
If multiple matches are found the priority is `Templates > Tags > Categories`.
- The "**amount**" part can be a single or multiple numbers. Multiple numbers separated by a space get automatically added up
`Ex. electr 20 10 1` => `electricity 31`
This field supports decimal values and mathematical expressions (just make sure to not use spaces): `Ex. 100/4+24.5*6`.
<br> This field is optional. If you have a Template, that has the amount set, you can omit this and only write the
template name. Specifying it overwrite the Template amount.
- The "description" is the phrase found after the numerical part. It is also optional and will also overwrite any
Template description if one is provided.
<h3>Summary</h3>
1. The <b>search</b> looks in the name of your tags, categories and transaction-templates. It supports entering just part of the name and even getting some of the letters wrong.<br><code> elct => electricity</code>
2. The <b>amount</b> supports mathematical expressions. Numbers separated by a space get automatically added up.</p>
3. The <b>description</b> is optional. Using this will overwrite the default value (tag name / template description).</p>
4. The <b>todo</b> makes it easy to add your custom "todo-tag" by appending a custom string (default "!!"). This can be changed in "Settings"</p>
### Examples
"electricity" = tag<br>
"swimming" = template <br><br>
```
template 23
templ 12 22 33
tmplat 12+2*3
tmplat 12+2*3 custom description
electricity 23
elc 12*2+33
elc 12+2*3 custom description
elc 25 !!
swim
```

View File

@@ -21,7 +21,7 @@ export function useForm(props) {
const title = computed(() => (route.params.id ? titleEdit : titleAdd))
let itemId = ref(null)
let formName = ref(`form-${crypto.randomUUID()}`)
let formName = ref(`form-${crypto.randomUUID ? crypto.randomUUID() : Utils.getGUID()}`)
// let itemId = computed(() => route.params.id)

View File

@@ -62,6 +62,7 @@ export const icons = {
fieldText1: 'IconBlockquote',
fieldText2: 'IconWriting',
article: 'IconArticle',
key: 'IconKey',

View File

@@ -3,11 +3,25 @@ export const TUTORIAL_CONSTANTS = {
title: 'Transaction assistant',
body: `
<p>Easily create transactions by typing text here (or using your phone's dictation).</p>
<p>Expected format: "[Name of tag / category / template] [amount] [description]"</p>
<p>This searches your tags, categories and transaction-templates. It supports entering just part of the name and even getting some of the letters wrong.</p>
<p>The "amount" part supports mathematical expressions(<code>Ex. 100/4+24*7</code>). Numbers separated by a space get automatically added up.</p>
<div>Examples</div>
<p><code>"template 23" <br> "templ 12 22 33" <br> "tmplat 12+2*3"<br> "tmplat 12+2*3 custom description"</code></p>
<p>Expected format:<br> <b>[search]&nbsp; [amount?]&nbsp; [description?]&nbsp; [todo?]</b></p>
<p>1. The <b>search</b> looks in the name of your tags, categories and transaction-templates. It supports entering just part of the name and even getting some of the letters wrong.<br><code> elct => electricity</code></p>
<p>2. The <b>amount</b> supports mathematical expressions. Numbers separated by a space get automatically added up.</p>
<p>3. The <b>description</b> is optional. Use this to overwrite the default tag name.</p>
<p>4. The <b>todo</b> makes it easy to add the user defined "todo-tag" by appending a custom string(default "!!"). This can be changed in "Settings"</p>
<p><b>Examples</b><br>
"electricity" = tag<br>
"swimming" = template <br><br>
<code>
electricity 23<br>
elc 12*2+33<br>
elc 12+2*3 custom description<br>
elc 25 !!<br>
swim<br>
</code>
</p>
`,
},

View File

@@ -22,7 +22,7 @@ export default defineNuxtConfig({
devServer: {
// host: '192.168.1.10',
// host: '0'
host: '0'
},
vite: {

View File

@@ -6,7 +6,7 @@
<van-cell-group inset>
<div class="van-cell-group-title">General:</div>
<app-field left-icon="link-o" v-model="assistantTodoTagMatcher" label="Trailing substring to auto add the todo tag" :rules="[{ required: true, message: 'This field is required' }]" required />
<app-field :icon="TablerIconConstants.fieldText2" v-model="assistantTodoTagMatcher" label="Substring which adds the todo tag" :rules="[{ required: true, message: 'This field is required' }]" required />
</van-cell-group>
<app-button-form-save />

View File

@@ -6,7 +6,7 @@
<app-field-link label="Setup" :icon="TablerIconConstants.settings" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_SETUP)" />
<app-field-link label="User interface" :icon="TablerIconConstants.settingsUI" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_UI)" />
<app-field-link label="Assistant" :icon="TablerIconConstants.assistant" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_ASSISTANT)" />
<app-field-link label="Formatting" :icon="TablerIconConstants.settingsUserPreferences" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_FORMATTING)" />
<app-field-link label="Formatting" :icon="TablerIconConstants.fieldText1" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_FORMATTING)" />
<app-field-link label="Dashboard" :icon="TablerIconConstants.dashboard" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_DASHBOARD)" />
<app-field-link label="Transactions" :icon="TablerIconConstants.transaction" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_TRANSACTION)" />
<app-field-link label="About" :icon="TablerIconConstants.settingsAbout" @click="navigateTo(RouteConstants.ROUTE_SETTINGS_ABOUT)" />