Skip to content

Commit

Permalink
adding check-for-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@hug-sch
hug-sch committed Jan 8, 2024
1 parent fea106a commit c8a8bad
Show file tree
Hide file tree
Showing 11 changed files with 193 additions and 23 deletions.
3 changes: 3 additions & 0 deletions config/en/mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,6 @@ nav:
- Statement of Assets: reference/view/reports/statement.md
- Chart: reference/view/reports/statement-chart.md
- Holdings: reference/view/reports/holdings.md
- Help Menu:
- Check for Updates: reference/help/check-updates.md

71 changes: 66 additions & 5 deletions docs/en/assets/demo-portfolio-03.backup-after-open.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2651,8 +2651,36 @@
<price t="2023-11-03" v="2139000000"/>
<price t="2023-11-06" v="2135000000"/>
<price t="2023-11-07" v="2123000000"/>
<price t="2023-11-08" v="2133500000"/>
<price t="2023-11-09" v="2152000000"/>
<price t="2023-11-10" v="2143500000"/>
<price t="2023-11-13" v="2164500000"/>
<price t="2023-11-14" v="2155000000"/>
<price t="2023-11-15" v="2141000000"/>
<price t="2023-11-16" v="2146500000"/>
<price t="2023-11-17" v="2155500000"/>
<price t="2023-11-20" v="2162000000"/>
<price t="2023-11-21" v="2159000000"/>
<price t="2023-11-22" v="2174000000"/>
<price t="2023-11-23" v="2180000000"/>
<price t="2023-11-24" v="2190000000"/>
<price t="2023-11-27" v="2195500000"/>
<price t="2023-11-28" v="2187500000"/>
<price t="2023-11-29" v="2193500000"/>
<price t="2023-11-30" v="2197500000"/>
<price t="2023-12-01" v="2224500000"/>
<price t="2023-12-04" v="2235000000"/>
<price t="2023-12-05" v="2259000000"/>
<price t="2023-12-06" v="2263500000"/>
<price t="2023-12-07" v="2260000000"/>
<price t="2023-12-08" v="2261500000"/>
<price t="2023-12-11" v="2278500000"/>
<price t="2023-12-12" v="2278000000"/>
<price t="2023-12-13" v="2255500000"/>
<price t="2023-12-14" v="2174000000"/>
<price t="2023-12-15" v="2189000000"/>
</prices>
<latest t="2023-11-07" v="2123000000">
<latest t="2023-12-15" v="2183000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down Expand Up @@ -3717,8 +3745,36 @@
<price t="2023-11-03" v="1419000000"/>
<price t="2023-11-06" v="1419000000"/>
<price t="2023-11-07" v="1439500000"/>
<price t="2023-11-08" v="1460500000"/>
<price t="2023-11-09" v="1480500000"/>
<price t="2023-11-10" v="1460000000"/>
<price t="2023-11-13" v="1470000000"/>
<price t="2023-11-14" v="1487000000"/>
<price t="2023-11-15" v="1486500000"/>
<price t="2023-11-16" v="1464000000"/>
<price t="2023-11-17" v="1485500000"/>
<price t="2023-11-20" v="1496000000"/>
<price t="2023-11-21" v="1310000000"/>
<price t="2023-11-22" v="1346000000"/>
<price t="2023-11-23" v="1337500000"/>
<price t="2023-11-24" v="1339500000"/>
<price t="2023-11-27" v="1347000000"/>
<price t="2023-11-28" v="1330000000"/>
<price t="2023-11-29" v="1337000000"/>
<price t="2023-11-30" v="1328500000"/>
<price t="2023-12-01" v="1330000000"/>
<price t="2023-12-04" v="1307000000"/>
<price t="2023-12-05" v="1315000000"/>
<price t="2023-12-06" v="1299000000"/>
<price t="2023-12-07" v="1310500000"/>
<price t="2023-12-08" v="1352000000"/>
<price t="2023-12-11" v="1353500000"/>
<price t="2023-12-12" v="1344500000"/>
<price t="2023-12-13" v="1348500000"/>
<price t="2023-12-14" v="1393000000"/>
<price t="2023-12-15" v="1389000000"/>
</prices>
<latest t="2023-11-07" v="1439500000">
<latest t="2023-12-15" v="1378000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down Expand Up @@ -3976,8 +4032,13 @@
<configuration/>
</widget>
<widget type="IRR">
<label>Internal Rate of Return (IRR)</label>
<configuration/>
<label>Internal Rate of Return (IRR), Entire portfolio</label>
<configuration>
<entry>
<string>DATA_SERIES</string>
<string>Client-totals</string>
</entry>
</configuration>
</widget>
<widget type="ABSOLUTE_CHANGE">
<label>Absolute Change</label>
Expand Down Expand Up @@ -4250,7 +4311,7 @@
<config>
<uuid>3580a087-a144-41e6-b45e-351eb5535064</uuid>
<name>Standard</name>
<data>{&quot;items&quot;:[{&quot;id&quot;:&quot;shares&quot;,&quot;width&quot;:87},{&quot;id&quot;:&quot;name&quot;,&quot;width&quot;:114},{&quot;id&quot;:&quot;pv&quot;,&quot;width&quot;:235},{&quot;id&quot;:&quot;pp&quot;,&quot;width&quot;:228},{&quot;id&quot;:&quot;quote&quot;,&quot;width&quot;:103},{&quot;id&quot;:&quot;5&quot;,&quot;width&quot;:104},{&quot;id&quot;:&quot;changeonpreviousamount&quot;,&quot;width&quot;:120},{&quot;id&quot;:&quot;mv&quot;,&quot;width&quot;:160},{&quot;id&quot;:&quot;sumdiv&quot;,&quot;width&quot;:130},{&quot;id&quot;:&quot;izf&quot;,&quot;sortDirection&quot;:128,&quot;width&quot;:177},{&quot;id&quot;:&quot;delta&quot;,&quot;width&quot;:143}]}</data>
<data>{&quot;items&quot;:[{&quot;id&quot;:&quot;shares&quot;,&quot;width&quot;:87},{&quot;id&quot;:&quot;name&quot;,&quot;width&quot;:106},{&quot;id&quot;:&quot;quote&quot;,&quot;width&quot;:68},{&quot;id&quot;:&quot;mv&quot;,&quot;width&quot;:127},{&quot;id&quot;:&quot;izf&quot;,&quot;sortDirection&quot;:128,&quot;width&quot;:120},{&quot;id&quot;:&quot;twror&quot;,&quot;width&quot;:134},{&quot;id&quot;:&quot;ttwror_pa&quot;,&quot;width&quot;:144},{&quot;id&quot;:&quot;pv&quot;,&quot;width&quot;:194},{&quot;id&quot;:&quot;pp&quot;,&quot;width&quot;:188},{&quot;id&quot;:&quot;sumdiv&quot;,&quot;width&quot;:72}]}</data>
</config>
</configurations>
</config-set>
Expand Down
67 changes: 62 additions & 5 deletions docs/en/assets/demo-portfolio-03.backup.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2651,8 +2651,34 @@
<price t="2023-11-03" v="2139000000"/>
<price t="2023-11-06" v="2135000000"/>
<price t="2023-11-07" v="2123000000"/>
<price t="2023-11-08" v="2133500000"/>
<price t="2023-11-09" v="2152000000"/>
<price t="2023-11-10" v="2143500000"/>
<price t="2023-11-13" v="2164500000"/>
<price t="2023-11-14" v="2155000000"/>
<price t="2023-11-15" v="2141000000"/>
<price t="2023-11-16" v="2146500000"/>
<price t="2023-11-17" v="2155500000"/>
<price t="2023-11-20" v="2162000000"/>
<price t="2023-11-21" v="2159000000"/>
<price t="2023-11-22" v="2174000000"/>
<price t="2023-11-23" v="2180000000"/>
<price t="2023-11-24" v="2190000000"/>
<price t="2023-11-27" v="2195500000"/>
<price t="2023-11-28" v="2187500000"/>
<price t="2023-11-29" v="2193500000"/>
<price t="2023-11-30" v="2197500000"/>
<price t="2023-12-01" v="2224500000"/>
<price t="2023-12-04" v="2235000000"/>
<price t="2023-12-05" v="2259000000"/>
<price t="2023-12-06" v="2263500000"/>
<price t="2023-12-07" v="2260000000"/>
<price t="2023-12-08" v="2261500000"/>
<price t="2023-12-11" v="2278500000"/>
<price t="2023-12-12" v="2278000000"/>
<price t="2023-12-13" v="2255500000"/>
</prices>
<latest t="2023-11-07" v="2123000000">
<latest t="2023-12-14" v="2169000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down Expand Up @@ -3717,8 +3743,34 @@
<price t="2023-11-03" v="1419000000"/>
<price t="2023-11-06" v="1419000000"/>
<price t="2023-11-07" v="1439500000"/>
<price t="2023-11-08" v="1460500000"/>
<price t="2023-11-09" v="1480500000"/>
<price t="2023-11-10" v="1460000000"/>
<price t="2023-11-13" v="1470000000"/>
<price t="2023-11-14" v="1487000000"/>
<price t="2023-11-15" v="1486500000"/>
<price t="2023-11-16" v="1464000000"/>
<price t="2023-11-17" v="1485500000"/>
<price t="2023-11-20" v="1496000000"/>
<price t="2023-11-21" v="1310000000"/>
<price t="2023-11-22" v="1346000000"/>
<price t="2023-11-23" v="1337500000"/>
<price t="2023-11-24" v="1339500000"/>
<price t="2023-11-27" v="1347000000"/>
<price t="2023-11-28" v="1330000000"/>
<price t="2023-11-29" v="1337000000"/>
<price t="2023-11-30" v="1328500000"/>
<price t="2023-12-01" v="1330000000"/>
<price t="2023-12-04" v="1307000000"/>
<price t="2023-12-05" v="1315000000"/>
<price t="2023-12-06" v="1299000000"/>
<price t="2023-12-07" v="1310500000"/>
<price t="2023-12-08" v="1352000000"/>
<price t="2023-12-11" v="1353500000"/>
<price t="2023-12-12" v="1344500000"/>
<price t="2023-12-13" v="1348500000"/>
</prices>
<latest t="2023-11-07" v="1439500000">
<latest t="2023-12-14" v="1387000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down Expand Up @@ -3976,8 +4028,13 @@
<configuration/>
</widget>
<widget type="IRR">
<label>Internal Rate of Return (IRR)</label>
<configuration/>
<label>Internal Rate of Return (IRR), Entire portfolio</label>
<configuration>
<entry>
<string>DATA_SERIES</string>
<string>Client-totals</string>
</entry>
</configuration>
</widget>
<widget type="ABSOLUTE_CHANGE">
<label>Absolute Change</label>
Expand Down Expand Up @@ -4250,7 +4307,7 @@
<config>
<uuid>3580a087-a144-41e6-b45e-351eb5535064</uuid>
<name>Standard</name>
<data>{&quot;items&quot;:[{&quot;id&quot;:&quot;shares&quot;,&quot;width&quot;:87},{&quot;id&quot;:&quot;name&quot;,&quot;width&quot;:114},{&quot;id&quot;:&quot;pv&quot;,&quot;width&quot;:235},{&quot;id&quot;:&quot;pp&quot;,&quot;width&quot;:228},{&quot;id&quot;:&quot;quote&quot;,&quot;width&quot;:103},{&quot;id&quot;:&quot;5&quot;,&quot;width&quot;:104},{&quot;id&quot;:&quot;changeonpreviousamount&quot;,&quot;width&quot;:120},{&quot;id&quot;:&quot;mv&quot;,&quot;width&quot;:160},{&quot;id&quot;:&quot;sumdiv&quot;,&quot;width&quot;:130},{&quot;id&quot;:&quot;izf&quot;,&quot;sortDirection&quot;:128,&quot;width&quot;:177},{&quot;id&quot;:&quot;delta&quot;,&quot;width&quot;:143}]}</data>
<data>{&quot;items&quot;:[{&quot;id&quot;:&quot;shares&quot;,&quot;width&quot;:87},{&quot;id&quot;:&quot;name&quot;,&quot;width&quot;:106},{&quot;id&quot;:&quot;quote&quot;,&quot;width&quot;:68},{&quot;id&quot;:&quot;mv&quot;,&quot;width&quot;:127},{&quot;id&quot;:&quot;izf&quot;,&quot;sortDirection&quot;:128,&quot;width&quot;:120},{&quot;id&quot;:&quot;twror&quot;,&quot;width&quot;:134},{&quot;id&quot;:&quot;ttwror_pa&quot;,&quot;width&quot;:144},{&quot;id&quot;:&quot;pv&quot;,&quot;width&quot;:194},{&quot;id&quot;:&quot;pp&quot;,&quot;width&quot;:188},{&quot;id&quot;:&quot;sumdiv&quot;,&quot;width&quot;:72}]}</data>
</config>
</configurations>
</config-set>
Expand Down
8 changes: 6 additions & 2 deletions docs/en/assets/demo-portfolio-03.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2677,8 +2677,10 @@
<price t="2023-12-11" v="2278500000"/>
<price t="2023-12-12" v="2278000000"/>
<price t="2023-12-13" v="2255500000"/>
<price t="2023-12-14" v="2174000000"/>
<price t="2023-12-15" v="2189000000"/>
</prices>
<latest t="2023-12-14" v="2169000000">
<latest t="2023-12-15" v="2183000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down Expand Up @@ -3769,8 +3771,10 @@
<price t="2023-12-11" v="1353500000"/>
<price t="2023-12-12" v="1344500000"/>
<price t="2023-12-13" v="1348500000"/>
<price t="2023-12-14" v="1393000000"/>
<price t="2023-12-15" v="1389000000"/>
</prices>
<latest t="2023-12-14" v="1387000000">
<latest t="2023-12-15" v="1378000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down
9 changes: 1 addition & 8 deletions docs/en/getting-started/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,4 @@ The installer files are in fact stored in the [author's github repository](https

![Github repository for downloading (previous) releases](images/installation-download-github.svg){.pp-figure}

You can edit and compile the source code; see [Contributing to Portfolio Performance](https://github.com/portfolio-performance/portfolio/blob/master/CONTRIBUTING.md#project-setup).

# Updating the software
After the first installation, the program will check on each start-up for new updates and install these automatically (see figure 1). You can change this setting with the menu `Help > Settings > Updates > Check for updates on start`.

![Automatic updating with newer version](images/installation-update.png){.pp-figure}

Also, you can update manually with the menu `Help > Check for updates ...`.
You can edit and compile the source code; see [Contributing to Portfolio Performance](https://github.com/portfolio-performance/portfolio/blob/master/CONTRIBUTING.md#project-setup).
47 changes: 47 additions & 0 deletions docs/en/reference/help/check-updates.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Help > Check for Updates ...
---

After the first installation, you can either check manually for updates or allow the program to check each time it starts.

## Manual check for updates

To manually check for updates, navigate to the menu `Help > Check for Updates ...`. Figure 1 will briefly appear.

Figure: Checking for updates.{class=pp-figure}

![](images/check-for-updates.png)

Either no updates are available; indicating that your version is up-to-date or figure 2 will be shown; the correct version will of course be different in the future.

Figure: Checking for updates.{class=pp-figure}

![](images/installation-update.png)

To install the updated version, click `OK`. To cancel the update and stay with the old version, click `Cancel`.

There is link to [New & Noteworthy](https://forum.portfolio-performance.info/t/neues-nennenswertes/23/148). This webpage provides detailed information about the changes in each program version. Unfortunately, the link in the program directs to the German website. An [English version](https://forum.portfolio-performance.info/t/new-noteworthy/17945/1) is also available.

The second link leads to the [Change Log](https://www.portfolio-performance.info/versions.html). Although this webpage is in German, a bilingual version (German-English) can be found on[Github](https://github.com/portfolio-performance/portfolio/releases).

The [download link](https://www.portfolio-performance.info/) takes you to the homepage (German version); where you can download the program in different versions; see [Getting Started > Installation](../../getting-started/installation.md).

Below the links, you can find an overview of the changes in the last few releases. At the bottom right, you can enable the automatic check for updates (see below).

## Automatic check for updates

Automatic checking for updates is enabled by default. You can change this behavior in the menu `Help > Settings > Updates > Check for updates on start` (see figure 3).

Figure: Setting for automatic check for updates.{class=pp-figure}
![](images/automatic-check-for-update.png)


## Updating error

If the program is corrupted or some files are missing, automatic updates are not feasible. An error message (see figure 4) is displayed, and the automatic update is no longer possible.

The simplest workaround is to delete the program and reinstall it.

Figure: Error message upon manual check for updates.{class=pp-figure}

![](images/error-on-updating.png)
Binary file added docs/en/reference/help/images/automatic-check-for-update.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/reference/help/images/check-for-updates.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/reference/help/images/error-on-updating.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 ...ng-started/images/installation-update.png → ...rence/help/images/installation-update.png
View file
File renamed without changes
11 changes: 8 additions & 3 deletions todo/todo.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Some screenshots contain text fields that are not aligned (see figure below). Th

This issue seems to be related with the changing of the default font (`Help > Settings > Presentation > Formatting > Font size`). Setting it to 9px (Default) removes the issue.

### 2023-09-10 (question)
### 2023-09-10 (question)[solved]
Images are stored in a subdirectory of the one where the md file resides.
```
concepts
Expand Down Expand Up @@ -44,7 +44,7 @@ Upon creating a security, you can specify a Calendar in the Security Master Data

(3) What's the difference between the `Apply` and `Apply and close` in the panel `Help > Preferences > Calendar`. Necessary?

### 2023-09-16 (question)
### 2023-09-16 (question)[solved]
At the moment there is a top-level menu item called "Tips & tricks". Isn't this too informal? Replacing with "Advanced topics"?

Also the top-level item "Common procedures" may seem too generic. Other suggestions?
Expand Down Expand Up @@ -91,7 +91,7 @@ mkdocs == 1.5.3
mkdocs-material == 9.4.2
mkdocs-caption == 0.0.9

### 2023-09-28
### 2023-09-28 [solved]
Refering to a header in another page doesn't seem to work. For example:
[convert](deposit.md#transferbetweentwocurrencies) will jump to the correct page but not the header. The TOC extension is activated.

Expand Down Expand Up @@ -123,4 +123,9 @@ This gives 4 chapters: Tutorials (practical-learning), How-to (practical-working
The current structure goes in the right direction: getting-started = tutorial, common procedure and tips & tricks = how-to, basic concepts = explanation.
The section reference seems to be missing.

### 2023-12-16
Spending a few weeks trying to describe the performance indicators IRR and TTWROR.
Also restructured the manual according to the principles of divio.com (see above).
Historical prices: many of the presets don't seem to function?


0 comments on commit c8a8bad

Please sign in to comment.