Debian Codegraph @

doc/dlg-pref.html

raw
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta content="text/html; charset=utf-8" http-equiv="content-type">
5 <meta content="noindex" name="robots">
6 <title>Preferences dialog</title>
7 <link href="help.css" rel="stylesheet" type="text/css">
8 </head>
9 <body id="top">
10 <div class="dochead">
11 HomeBank User manual
12 </div>
13 <div class="title">
14 <h1>Preferences dialog</h1>
15 <p>The preferences dialog can be accessed from the main window menu, as Edit-Preferences. It lets you customize many aspects of the way HomeBank works.<br>
16 The following sections detail the settings that you can customize, and what they affect.</p>
17 <img class="gtkshot left" src="images/dlg-prefs0.png">
18 <ul class="toc">
19 <li><a href="#tab1">General</a></li>
20 <li><a href="#tab2">Interface</a></li>
21 <ul>
22 <li><a href="#tab2a">Theming</a></li>
23 <li><a href="#tab2b">Color</a></li>
24 </ul>
25 <li><a href="#tab3">Locale</a></li>
26 <li><a href="#tab4">Transactions</a></li>
27 <ul>
28 <li><a href="#tab4a">Dialog</a></li>
29 <li><a href="#tab4b">Transfer</a></li>
30 <li><a href="#tab4c">Payment</a></li>
31 </ul>
32 <li><a href="#tab6">Import/Export</a></li>
33 <li><a href="#tab7">Report</a></li>
34 <li><a href="#tabF">Forecast</a></li>
35 <li><a href="#tab8">Backup</a></li>
36 <li><a href="#tab9">Folders</a></li>
37 <li><a href="#tabA">Euro minor</a></li>
38 <li><a href="#tabB">Advanced</a></li>
39 </ul><!-- separator -->
40 </div>
41
42 <div class="row">
43 <div class="gfx">
44 <img class="gtkshot right" src="images/dlg-prefs1.png">
45 </div>
46 <div class="rounded content">
47 <h2 id="tab1">General</h2>
48 <h3>Program start</h3>
49 <table class="widgetinfo">
50 <tr>
51 <th>Show splash screen</th>
52 <td>display a splash screen when HomeBank start</td>
53 </tr>
54 <tr>
55 <th>Load last opened file</th>
56 <td>load the last opened file when HomeBank start</td>
57 </tr>
58 <tr>
59 <th>Post pending scheduled transactions</th>
60 <td>append scheduled transaction to accounts when HomeBank start</td>
61 </tr>
62 <tr>
63 <th>Update currencies on-line</th>
64 <td>trigger a on-line update for currencies exchange rate start</td>
65 </tr>
66 </table>
67
68 <!-- separator -->
69 <div class="clear"></div>
70 <p class="top"><a href="#top">↑ Back to Top</a></p>
71 </div>
72 </div>
73
74 <div class="row">
75 <div class="gfx">
76 <img class="gtkshot right" src="images/dlg-prefs2.png">
77 </div>
78 <div class="rounded content">
79 <h2 id="tab2">Interface</h2>
80 <h3>General</h3>
81 <table class="widgetinfo">
82 <tr>
83 <th>Color the amounts</th>
84 <td>specify if amounts should be displayed with colors below</td>
85 </tr>
86 <tr>
87 <th>Color the background of future transaction <img src="images/new12.png" alt="new"></th>
88 <td>specify if future transaction renders with a color background</td>
89 </tr>
90 <tr>
91 <th>Grid line</th>
92 <td>
93 specify the list grid line option:
94 <ul>
95 <li>None</li>
96 <li>Horizontal</li>
97 <li>Vertical</li>
98 <li>Both</li>
99 </ul>
100 </td>
101 </tr>
102 </table>
103
104 <h3>Charts options</h3>
105 <table class="widgetinfo">
106 <tr>
107 <th>Smaller legend font</th>
108 <td>set the font for scale and legend to be smaller</td>
109 </tr>
110 </table>
111
112 <h3>Deprecated</h3>
113 <table class="widgetinfo">
114 <tr>
115 <th>Tool-bar</th>
116 <td>tool-bar style to be used</td>
117 </tr>
118 </table>
119
120 <!-- separator -->
121 <div class="clear"></div>
122 <p class="top"><a href="#top">↑ Back to Top</a></p>
123 </div>
124 </div>
125
126 <div class="row">
127 <div class="gfx">
128 <img class="gtkshot right" src="images/dlg-prefs2a.png">
129 </div>
130 <div class="rounded content">
131 <h2 id="tab2a">Theming</h2>
132
133 <h3>Theme</h3>
134 <p>On GNU/Linux OS, HomeBank will follow the dark scheme preference if available</p>
135 <table class="widgetinfo">
136 <tr>
137 <th>Dark mode</th>
138 <td>GNU/Linux only<br>
139 will indicate the system preference: no preference, prefer dark, prefer light</td>
140 </tr>
141 <tr>
142 <th>Use dark mode if available</th>
143 <td>GNU/Linux: use dark mode when system has no preference, this will not work otherwise<br><br>
144 For other OS this enable to switch to theme dark mode, if available.</td>
145 </tr>
146 </table>
147
148 <h3>Icons</h3>
149 <table class="widgetinfo">
150 <tr>
151 <th>Icon theme <img src="images/new12.png" alt="new"></th>
152 <td>default icon theme, to be enriched in the future</td>
153 </tr>
154 <tr>
155 <th>Use symbolic icons if available <img src="images/new12.png" alt="new"></th>
156 <td>as it describe, will use symbolic icons if available</td>
157 </table>
158
159 <h3>GTK settings</h3>
160 <table class="widgetinfo">
161 <tr>
162 <th>Override</th>
163 <td>Enable to override the font size</td>
164 </tr>
165 <tr>
166 <th>Font size</th>
167 <td>Define the font size</td>
168 </tr>
169 </table>
170
171 <p class="top"><a href="#top">↑ Back to Top</a></p>
172 </div>
173 </div>
174
175 <div class="row">
176 <div class="gfx">
177 <img class="gtkshot right" src="images/dlg-prefs2b.png">
178 </div>
179 <div class="rounded content">
180 <h2 id="tab2b">Color</h2>
181
182 <h3>Chart</h3>
183 <table class="widgetinfo">
184 <tr>
185 <th>Palette</th>
186 <td>
187 Set the default color scheme to be applied for charts
188 <ul>
189 <li>HomeBank</li>
190 <li>Money</li>
191 <li>SAP</li>
192 <li>Quicken</li>
193 <li>Office 2010</li>
194 <li>Office 2013</li>
195 <li>Analytics</li>
196 <li>YNAB</li>
197 </ul>
198 </td>
199 </tr>
200 </table>
201
202 <h3>Others</h3>
203 <table class="widgetinfo">
204 <tr>
205 <th>Uses colors from the chart palette <img src="images/new12.png" alt="new"></th>
206 <td>specify if amounts should be displayed with colors below</td>
207 </tr>
208 <tr>
209 <th>Expense</th>
210 <td>color to uses for expense</td>
211 </tr>
212 <tr>
213 <th>Income</th>
214 <td>color to uses for income</td>
215 </tr>
216 <tr>
217 <th>Warning</th>
218 <td>color to uses for amount in warning (overdrawn)</td>
219 </tr>
220 <tr>
221 <th>Background future <img src="images/new12.png" alt="new"></th>
222 <td>color to uses for background future transaction</td>
223 </tr>
224 </table>
225
226 <p class="top"><a href="#top">↑ Back to Top</a></p>
227 </div>
228 </div>
229
230 <div class="row">
231 <div class="gfx">
232 <img class="gtkshot right" src="images/dlg-prefs3.png">
233 </div>
234 <div class="rounded content">
235 <h2 id="tab3">Locale</h2>
236
237 <h3>User interface</h3>
238 <table class="widgetinfo">
239 <tr>
240 <th>Language</th>
241 <td>define what language to use for the interface</td>
242 </tr>
243 <tr>
244 <th>Date display</th>
245 <td>A date sample is displayed</td>
246 </tr>
247 <tr>
248 <th>Customize</th>
249 <td>the format used <u>to display the date</u><br>
250 <img src="images/d-warn.png">&nbsp;<span class="warning">the input format rely on your system option, you can see <a href="https://answers.launchpad.net/homebank/+faq/1427">this FAQ</a>.</span>
251 </td>
252 </tr>
253 </table>
254 <h3>Fiscal year</h3>
255 <table class="widgetinfo">
256 <tr>
257 <th>Start on</th>
258 <td>define on which day and month the fiscal year start</td>
259 </tr>
260 </table>
261 <h3>Measurement units</h3>
262 <table class="widgetinfo">
263 <tr>
264 <th>Use miles for meter</th>
265 <td>use the mile labels and abbreviation for the vehicle cost</td>
266 </tr>
267 <tr>
268 <th>Use gallon for fuel</th>
269 <td>use the gallon labels and abbreviation for the vehicle cost</td>
270 </tr>
271 </table>
272
273 <!-- separator -->
274 <div class="clear"></div>
275 <p class="top"><a href="#top">↑ Back to Top</a></p>
276 </div>
277
278 </div>
279 <div class="row">
280 <div class="gfx">
281 <img class="gtkshot right" src="images/dlg-prefs4.png">
282 </div>
283 <div class="rounded content">
284 <h2 id="tab4">Transactions</h2>
285
286 <h3>General</h3>
287 <table class="widgetinfo">
288 <tr>
289 <th>Always show remind</th>
290 <td>set the remind transaction to always be display (ignore filters)</td>
291 </tr>
292 <tr>
293 <th>Always show void</th>
294 <td>set the void transaction to always be display (ignore filters)</td>
295 </tr>
296 <tr>
297 <th>Include remind into balance and report</th>
298 <td>set the remind transaction amount to be computed into the balance, ignored otherwise</td>
299 </tr>
300 </table>
301
302 <h3>Safety</h3>
303 <table class="widgetinfo">
304 <tr>
305 <th>Lock reconciled for any changes</th>
306 <td>set the default value for the lock reconciled for any change of the main window</td>
307 </tr>
308 <tr>
309 <th>Approve additions before last reconciliation <img src="images/new12.png" alt="new"></th>
310 <td>set pending status for transaciton you input before last reconciled date of an account</td>
311 </tr>
312 <tr>
313 <th>Approve addition before XX days before today's date <img src="images/new12.png" alt="new"></th>
314 <td>set pending status for transaction you input past XX days</td>
315 </tr>
316 </table>
317
318 <h3>Ledger window</h3>
319 <table class="widgetinfo">
320 <tr>
321 <th>Range</th>
322 <td>Set the default range to be used for account window</td>
323 </tr>
324 <tr>
325 <th>Show future [xx] days ahead</th>
326 <td>set the number of days to force show future transaction<br>
327 Please note the addition is only effective when the range is:<br>
328 THISMONTH, THISQUARTER, THISYEAR<br>
329 LAST30DAYS, LAST60DAYS, LAST90DAYS, LAST12MONTHS
330 </td>
331 </tr>
332 <tr>
333 <th>Hide reconciled</th>
334 <td>set the filter for account window not to default show reconciled transactions</td>
335 </tr>
336 </table>
337
338 <!-- separator -->
339 <div class="clear"></div>
340 <p class="top"><a href="#top">↑ Back to Top</a></p>
341 </div>
342 </div>
343
344
345 <div class="row">
346 <div class="gfx">
347 <img class="gtkshot right" src="images/dlg-prefs4a.png">
348 </div>
349 <div class="rounded content">
350 <h2 id="tabB">Dialog</h2>
351 <h3>Transaction dialogue</h3>
352 <table class="widgetinfo">
353 <tr>
354 <th>Keep the last date when multiple add</th>
355 <td>
356 When you add several transaction to the chain, set the date to be kept when:<br>
357 - you use the [Add] button from a <a href="dlg-tran.html">Transaction dialog</a> in Add mode<br>
358 - Inherit a transaction from an <a href="win-account.html">Account window</a><br>
359 </td>
360 </tr>
361 <tr>
362 <th>Enable memo autocomplete with [xxx] rolling days</th>
363 <td>Collect and propose memo for autocomplete or not
364 and define how many days into the past to grab memo for autocomplete, if for example 30 days, you will only see the last 30 days autocomplete memo</td>
365 </tr>
366 <tr>
367 <th>Show confirmation text for 5s</th>
368 <td>Will show 5 seconds added confirmation text into the transaction dialog</td>
369 </tr>
370 <tr>
371 <th>Show template list when edit</th>
372 <td>this will show the template dropdown list when you edit a transaction</td>
373 </tr>
374 </table>
375
376 <!-- separator -->
377 <div class="clear"></div>
378 <p class="top"><a href="#top">↑ Back to Top</a></p>
379 </div>
380 </div>
381
382 <div class="row">
383 <div class="gfx">
384 <img class="gtkshot right" src="images/dlg-prefs4b.png">
385 </div>
386 <div class="rounded content">
387 <h2 id="tabB">Transfer</h2>
388
389 <h3>Behavior</h3>
390 <table class="widgetinfo">
391 <tr>
392 <th>When adding, always show selection action for target dialog</th>
393 <td>this will force to show target dialog when you add a transfer</td>
394 </tr>
395 <tr>
396 <th>Date gapto find a target: [xx] days</th>
397 <td>Define the number of +/- days to search for a target transaction for transfer</td>
398 </tr>
399 </table>
400
401
402 <h3>Synchronize</h3>
403 <table class="widgetinfo">
404 <tr>
405 <th>Date <img src="images/new12.png" alt="new"></th>
406 <td>this will force to sync the date of the transfer source and destination when you change it</td>
407 </tr>
408 <tr>
409 <th>Status</th>
410 <td>this will force to sync the status of the transfer source and destination when you change it</td>
411 </tr>
412 </table>
413
414
415
416 <!-- separator -->
417 <div class="clear"></div>
418 <p class="top"><a href="#top">↑ Back to Top</a></p>
419 </div>
420 </div>
421
422 <div class="row">
423 <div class="gfx">
424 <img class="gtkshot right" src="images/dlg-prefs4c.png">
425 </div>
426 <div class="rounded content">
427 <h2 id="tab4c">Payment</h2>
428 <h3>Payment shows & chooses</h3>
429
430 <p>This list enables you to select what payment mode to show/hide and in which order !</p>
431
432
433 <!-- separator -->
434 <div class="clear"></div>
435 <p class="top"><a href="#top">↑ Back to Top</a></p>
436 </div>
437 </div>
438
439 <div class="row">
440 <div class="gfx">
441 <img class="gtkshot right" src="images/dlg-prefs6.png">
442 </div>
443 <div class="rounded content">
444 <h2 id="tab6">Import/Export</h2>
445 <h3>General options</h3>
446 <table class="widgetinfo">
447 <tr>
448 <th>Date order</th>
449 <td>
450 set the default date order for file import
451 <ul>
452 <li>d-m-y</li>
453 <li>m-d-y</li>
454 <li>y-m-d</li>
455 </ul>
456 </td>
457 </tr>
458 <tr>
459 <th>Sentence case memo/payee</th>
460 <td>will change the case for memo and payee (lowercase starting with a capital letter)</td>
461 </tr>
462 </table>
463 <h3>OFX/QFX options</h3>
464 <table class="widgetinfo">
465 <tr>
466 <th>OFX Name</th>
467 <td>
468 define what to do for name field during import:<br>
469 <ul>
470 <li>ignore</li>
471 <li>memo</li>
472 <li>payee</li>
473 </ul>
474 </td>
475 </tr>
476 <tr>
477 <th>OFX Memo</th>
478 <td>
479 define what to do for memo field during import:<br>
480 <ul>
481 <li>ignore</li>
482 <li>append to Info</li>
483 <li>append to Memo</li>
484 <li>append to Payee</li>
485 </ul>
486 </td>
487 </tr>
488 </table>
489 <h3>QIF options</h3>
490 <table class="widgetinfo">
491 <tr>
492 <th>Import memos</th>
493 <td>to import the M field from files</td>
494 </tr>
495 <tr>
496 <th>Swap memos with payees</th>
497 <td>to swap M and P field from files</td>
498 </tr>
499 </table>
500 <h3>CSV options</h3>
501 <table class="widgetinfo">
502 <tr>
503 <th>Separator</th>
504 <td>change the separator for transaction import between:<br>
505 Tab, Comma, Semicolon, Space</td>
506 </tr>
507 </table><!-- separator -->
508 <div class="clear"></div>
509 <p class="top"><a href="#top">↑ Back to Top</a></p>
510 </div>
511 </div>
512
513 <div class="row">
514 <div class="gfx">
515 <img class="gtkshot right" src="images/dlg-prefs7.png">
516 </div>
517 <div class="rounded content">
518 <h2 id="tab7">Report</h2>
519 <h3>Main window reports</h3>
520 <table class="widgetinfo">
521 <tr>
522 <th>Max items</th>
523 <td>default number of slice for the pie chart of the main window reports</td>
524 </tr>
525 </table>
526
527 <h3>Initial filter</h3>
528 <table class="widgetinfo">
529 <tr>
530 <th>Range</th>
531 <td>Set the default range to be used for account window</td>
532 </tr>
533 </table>
534
535
536 <h3>Statistics options</h3>
537 <table class="widgetinfo">
538 <tr>
539 <th>Show by amount</th>
540 <td>set the by amount toggle on the statistics window to default be checked</td>
541 </tr>
542 <tr>
543 <th>Show rate column</th>
544 <td>set the rate column to be displayed by default</td>
545 </tr>
546 <tr>
547 <th>Show details</th>
548 <td>set the detail toggle on the statistics window to default be checked</td>
549 </tr>
550 <tr>
551 <th>Include transfer</th>
552 <td>set the internal transfer to be included into the computing of the report</td>
553 </tr>
554 </table>
555 <h3>Budget options</h3>
556 <table class="widgetinfo">
557 <tr>
558 <th>Show details</th>
559 <td>set the detail toggle on the budget window to default be checked</td>
560 </tr>
561 <tr>
562 <th>Exclude subcategories... <img src="images/new12.png" alt="new"></th>
563 <td>option not to consider subcategories with no budget as unbudgeted if parent category has budget</td>
564 </tr>
565 </table>
566
567 <!-- separator -->
568 <div class="clear"></div>
569 <p class="top"><a href="#top">↑ Back to Top</a></p>
570 </div>
571
572 </div>
573
574 <div class="row">
575 <div class="gfx">
576 <img class="gtkshot right" src="images/dlg-prefs8.png">
577 </div>
578 <div class="rounded content">
579 <h2 id="tabF">Forecast</h2>
580 <h3>Forecast</h3>
581 <table class="widgetinfo">
582 <tr>
583 <th>Enable forecast</th>
584 <td>to activate the forecast</td>
585 </tr>
586 <tr>
587 <th>Month number: [xx]</th>
588 <td>the number of month to forecast</td>
589 </tr>
590 </table>
591 <p>The forecast is based on scheduled transaction, and appear with condition, see the <a href="00-lexicon.html#forecast">forecast</a> lexicon section for more details.</p>
592
593
594 <!-- separator -->
595 <div class="clear"></div>
596 <p class="top"><a href="#top">↑ Back to Top</a></p>
597 </div>
598 </div>
599
600
601 <div class="row">
602 <div class="gfx">
603 <img class="gtkshot right" src="images/dlg-prefs9.png">
604 </div>
605 <div class="rounded content">
606 <h2 id="tab8">Backup</h2>
607 <h3>Backup</h3>
608 <table class="widgetinfo">
609 <tr>
610 <th>Enable automatic backups</th>
611 <td>to activate backup of your .xhb files</td>
612 </tr>
613 <tr>
614 <th>Number of backups to keep [xx]</th>
615 <td>the number of backups to keep</td>
616 </tr>
617 </table>
618 <p>Backup frequency is once a day, see the <a href="00-lexicon.html#backup">backup</a> lexicon section for more details.</p>
619
620
621 <!-- separator -->
622 <div class="clear"></div>
623 <p class="top"><a href="#top">↑ Back to Top</a></p>
624 </div>
625 </div>
626
627 <div class="row">
628 <div class="gfx">
629 <img class="gtkshot right" src="images/dlg-prefsA.png">
630 </div>
631 <div class="rounded content">
632 <h2 id="tab9">Folders</h2>
633 <p class="warning"><img src="images/d-warn.png">&nbsp;When you change those folders, HomeBank will not move nor copy files, including any current opened file.</p>
634 <p>These folders are the location that the file selector will use as a default when it opens.<br>
635 If you want to change the location of your files, change it to the filesystem first, then change it here.</p>
636
637 <h3>HomeBank files</h3>
638 <table class="widgetinfo">
639 <tr>
640 <th>Wallets</th>
641 <td>default folder to load/save HomeBank files</td>
642 </tr>
643 <tr>
644 <th>Backups</th>
645 <td>default folder to load/save HomeBank backup files</td>
646 </tr>
647 </table>
648 <h3>Exchange files</h3>
649 <table class="widgetinfo">
650 <tr>
651 <th>Import</th>
652 <td>default folder to load files to import</td>
653 </tr>
654 <tr>
655 <th>Export</th>
656 <td>default folder to save files to export</td>
657 </tr>
658 </table>
659
660 <!-- separator -->
661 <div class="clear"></div>
662 <p class="top"><a href="#top">↑ Back to Top</a></p>
663 </div>
664
665 </div>
666
667 <div class="row">
668 <div class="gfx">
669 <img class="gtkshot right" src="images/dlg-prefsB.png">
670 </div>
671 <div class="rounded content">
672 <h2 id="tabA">Euro minor</h2>
673 <h3>General</h3>
674 <table class="widgetinfo">
675 <tr>
676 <th>Enable</th>
677 <td>enable Euro minor currency support in HomeBank.<br>
678 see <a href="use-tipsandtricks.html#eurominor">minor currency</a> for more details.</td>
679 </tr>
680 <tr>
681 <th>Preset</th>
682 <td>preselect of parameters for this tab</td>
683 </tr>
684 </table>
685 <h3>Configuration</h3>
686 <p>A remind of the country is displayed</p>
687 <table class="widgetinfo">
688 <tr>
689 <th>1 XXX =</th>
690 <td>change rate (value of 1 Euro in your old national currency)</td>
691 </tr>
692 </table>
693 <h3>Format</h3>
694 <table class="widgetinfo">
695 <p>A sample is displayed and can be customized</p>
696 <tr>
697 <th>Symbol</th>
698 <td>Symbol that prefix the amount</td>
699 </tr>
700 <tr>
701 <th>Is prefix</th>
702 <td>define is the symbol is a prefix symbol</td>
703 </tr>
704 <tr>
705 <th>Decimal char</th>
706 <td>Character to be used as decimal separator</td>
707 </tr>
708 <tr>
709 <th>Frac digits</th>
710 <td>Number of digits after decimal separator</td>
711 </tr>
712 <tr>
713 <th>Grouping char</th>
714 <td>Character to be used as grouping separator</td>
715 </tr>
716 </table>
717
718 <!-- separator -->
719 <div class="clear"></div>
720 <p class="top"><a href="#top">↑ Back to Top</a></p>
721 </div>
722 </div>
723
724 <div class="row">
725 <div class="gfx">
726 <img class="gtkshot right" src="images/dlg-prefsC.png">
727 </div>
728 <div class="rounded content">
729 <h2 id="tabB">Advanced</h2>
730 <h3>Currency API</h3>
731 <table class="widgetinfo">
732 <tr>
733 <th>Url</th>
734 <td>the url of the rate API<br>
735 default value is: https://api.frankfurter.app/latest</td>
736 </tr>
737 <tr>
738 <th>Key</th>
739 <td>the free or paid apikey for other compatible API such as fixer or exchangerate</td>
740 </tr>
741 </table>
742
743 <!-- separator -->
744 <div class="clear"></div>
745 <p class="top"><a href="#top">↑ Back to Top</a></p>
746 </div>
747 </div>
748
749 </body>
750 </html>