Dogcows Code - chaz/homebank/blob - doc/dlg-curr.html

   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>Currencies 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>Currencies dialog</h1>
  15     <p>The currencies dialog is used to edit, modify and manage the currencies available for the wallets.</p>
  16
  17     <h2>Dialog call</h2>
  18     <ul>
  19       <li>main window menu: Manage / Currencies</li>
  20       <li>main window tool bar.</li>
  21     </ul>
  22   </div>
  23   <div class="rounded content">
  24     <h2>Using currencies dialog</h2>
  25     <p><img class="gtkshot right" src="images/dlg-currencies1.png"></p>
  26     <h3><img align="bottom" border="0" height="12" id="graphics5" name="graphics5" src="images/1.png" width="12"> General</h3>
  27     <table class="widgetinfo">
  28       <tr>
  29         <th>Update on-line</th>
  30         <td>Trigger to update exchanges rate on-line. This is disabled when you only have a single currency.<br>
  31         </td>
  32       </tr>
  33     </table>
  34     <p><img src="images/d-warn.png"/>&nbsp;<span class="warning">
  35     <b>Update Online</b> is an extra feature relying on a third party web service.<br>
  36     Your currencies may not be supported:<br>
  37     - as base currency: and nothing will update<br>
  38     - as a target currency: this currency will not be updated<br>
  39     See additional notes below</span></p>
  40
  41     <h3><img align="bottom" border="0" height="12" id="graphics6" name="graphics6" src="images/2.png" width="12"> Currencies list</h3>
  42     <p>display currency ISO code, name, symbol, exchange rate and last modified date</p>
  43     <h3><img align="bottom" border="0" height="12" id="graphics7" src="images/3.png" width="12"> Buttons</h3>
  44     <table class="widgetinfo">
  45       <tr>
  46         <th>Add</th>
  47         <td>open a dialog to add a new currency<br>
  48         + see the notes below.</td>
  49       </tr>
  50       <tr>
  51         <th>Edit</th>
  52         <td>open a dialog to edit the selected currency</td>
  53       </tr>
  54       <tr>
  55         <th>Delete</th>
  56         <td>delete the selected currency</td>
  57       </tr>
  58       <tr>
  59         <th>Set as base</th>
  60         <td>set the selected currency to be the base currency</td>
  61       </tr>
  62     </table>
  63
  64     <h3>Add currency notes</h3>
  65     <p>
  66     - you can pick up new currencies from the official ISO 4217 list<br>
  67     - you can define a custom currency for discontinued or cryptocurrency</p>
  68
  69     <p>When you define a custom currency, please take care of the following:<br>
  70     - the Name must be at least 3 chars long<br>
  71     - the ISO code is optional, but you cannot change it easily later on<br>
  72     - the ISO code must be 3 chars long and cannot be the same an existing ISO 4217 one
  73     </p>
  74
  75     <h3>Online Currency Update</h3>
  76     <p>The current API is:<br>
  77     - <a href="https://frankfurter.app">frankfurter.app</a><br>
  78     - <a href="https://frankfurter.app/currencies">list of supported currencies</a></p>
  79     <p>
  80     <p>Previous third party API service used in the past.<br>
  81     - until 5.2:   https://api.fixer.io, see <a href="https://bugs.launchpad.net/homebank/+bug/1785210">#1785210</a><br>
  82     - until 5.1.7: yahoo, see <a href="https://bugs.launchpad.net/homebank/+bug/1730527">#1730527</a><br>
  83   </p>
  84
  85   </div>
  86   <div class="rounded content">
  87     <h2>Using the edit currency dialog</h2>
  88     <p><img class="gtkshot right" src="images/dlg-currencies2.png"></p>
  89     <h3>Currency</h3>
  90     <p>Display the currency symbol and name</p>
  91     <h3>Exchange rate</h3>
  92     <p>Enable to chnage the exchange rate (if currency is not the base one)</p>
  93     <h3>Format</h3>
  94     <p>Display a sample of the currency format</p>
  95     <p>Customize</p>
  96    <table class="widgetinfo">
  97       <tr>
  98         <th>Symbol</th>
  99         <td>Symbol that prefix the amount</td>
 100       </tr>
 101       <tr>
 102         <th>Is prefix</th>
 103         <td>define is the symbol is a prefix symbol</td>
 104       </tr>
 105       <tr>
 106         <th>Decimal char</th>
 107         <td>Character to be used as decimal separator</td>
 108       </tr>
 109       <tr>
 110         <th>Frac digits</th>
 111         <td>Number of digits after decimal separator</td>
 112       </tr>
 113       <tr>
 114         <th>Grouping char</th>
 115         <td>Character to be used as grouping separator</td>
 116       </tr>
 117     </table>
 118   </div>
 119 </body>
 120 </html>