Merge branch 'upstream'

[chaz/homebank] / doc / dlg-curr.html

diff --git a/doc/dlg-curr.html b/doc/dlg-curr.html
index b7443c062678ef2ac569ac76d47d3046736c989c..6da5928892dc469ca6412137d9df90056733a50c 100644 (file)
--- a/doc/dlg-curr.html
+++ b/doc/dlg-curr.html
@@ -13,6 +13,7 @@
   <div class="title">
     <h1>Currencies dialog</h1>
     <p>The currencies dialog is used to edit, modify and manage the currencies available for the wallets.</p>
+
     <h2>Dialog call</h2>
     <ul>
       <li>main window menu: Manage / Currencies</li>
@@ -27,16 +28,24 @@
       <tr>
         <th>Update on-line</th>
         <td>Trigger to update exchanges rate on-line. This is disabled when you only have a single currency.<br>
-        This is an extra feature relying on third party (yahoo).</td>
+        </td>
       </tr>
     </table>
+    <p><img src="images/d-warn.png"/>&nbsp;<span class="warning">
+    <b>Update Online</b> is an extra feature relying on a third party web service.<br>
+    Your currencies may not be supported:<br>
+    - as base currency: and nothing will update<br>
+    - as a target currency: this currency will not be updated<br>
+    See additional notes below</span></p>
+
     <h3><img align="bottom" border="0" height="12" id="graphics6" name="graphics6" src="images/2.png" width="12"> Currencies list</h3>
     <p>display currency ISO code, name, symbol, exchange rate and last modified date</p>
     <h3><img align="bottom" border="0" height="12" id="graphics7" src="images/3.png" width="12"> Buttons</h3>
     <table class="widgetinfo">
       <tr>
         <th>Add</th>
-        <td>open a dialog to add a new currency</td>
+        <td>open a dialog to add a new currency<br>
+        + see the notes below.</td>
       </tr>
       <tr>
         <th>Edit</th>
@@ -51,6 +60,28 @@
         <td>set the selected currency to be the base currency</td>
       </tr>
     </table>
+
+    <h3>Add currency notes</h3>
+    <p>
+    - you can pick up new currencies from the official ISO 4217 list<br>
+    - you can define a custom currency for discontinued or cryptocurrency</p>
+    
+    <p>When you define a custom currency, please take care of the following:<br>
+    - the Name must be at least 3 chars long<br>
+    - the ISO code is optional, but you cannot change it easily later on<br>
+    - the ISO code must be 3 chars long and cannot be the same an existing ISO 4217 one
+    </p>
+
+    <h3>Online Currency Update</h3>
+    <p>The current API is:<br>
+    - <a href="https://frankfurter.app">frankfurter.app</a><br>
+    - <a href="https://frankfurter.app/currencies">list of supported currencies</a></p>
+    <p>
+    <p>Previous third party API service used in the past.<br>
+    - until 5.2:   https://api.fixer.io, see <a href="https://bugs.launchpad.net/homebank/+bug/1785210">#1785210</a><br>
+    - until 5.1.7: yahoo, see <a href="https://bugs.launchpad.net/homebank/+bug/1730527">#1730527</a><br>
+  </p>
+
   </div>
   <div class="rounded content">
     <h2>Using the edit currency dialog</h2>