Skip to content

Commit

Permalink
update how-to (index.md)
Browse files Browse the repository at this point in the history
  • Loading branch information
hug-sch committed Sep 9, 2024
1 parent 1822480 commit b2d2c7d
Show file tree
Hide file tree
Showing 9 changed files with 106 additions and 154 deletions.
19 changes: 9 additions & 10 deletions config/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ nav:
- Trouble-shooting: reference/help/trouble-shooting.md
- How-to:
- How-to: how-to/index.md
- User Interface: how-to/user-interface.md
- Troubleshooting / Request for a new PDF importer: how-to/requesting-new-importer.md
- Benchmarking your portfolio: how-to/benchmarking.md
- Copy securities between portfolios: how-to/copy-securities.md
- Downloading historical prices:
- Downloading historical prices: how-to/downloading-historical-prices/index.md
- Alpha Vantage: how-to/downloading-historical-prices/alpha-vantage.md
Expand All @@ -198,17 +198,16 @@ nav:
- CSV File: how-to/downloading-historical-prices/csv-file.md
- JSON: how-to/downloading-historical-prices/json.md
- Table on Website: how-to/downloading-historical-prices/table-website.md
#- Importing CSV-files: how-to/importing.md
- Import fund data from Morningstar: how-to/downloading-historical-prices/morningstar.md
- Handling a choice dividend: how-to/handling-choice-dividend.md
- Import fund data from Morningstar: how-to/morningstar.md
- Hack data file to add default Quote Feed: how-to/quote-feed.md
- Copy securities between portfolios: how-to/copy-securities.md
- Importing GBX priced securities: how-to/import-gbx.md
- Inspecting the source code: how-to/inspect-source-code.md
- Recording a spin-off operation: how-to/recording-spin-off.md
- Recording a stock split operation: how-to/recording-stock-split.md
- Insolvency: how-to/insolvency.md
- Recording a merger: how-to/recording-merger.md
- Recording insolvency: how-to/insolvency.md
- Request for a new PDF importer: how-to/requesting-new-importer.md
- Retrieving gold prices: how-to/gold-prices.md
- Benchmarking your portfolio: how-to/benchmarking.md
- Importing GBX priced securities: how-to/import-gbx.md
- Inspecting the source code: how-to/inspect-source-code.md
- User Interface: how-to/user-interface.md
- About: about.md

78 changes: 74 additions & 4 deletions docs/en/assets/demo-portfolio-03.backup-after-open.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<client>
<version>60</version>
<version>62</version>
<baseCurrency>EUR</baseCurrency>
<securities>
<security>
Expand Down Expand Up @@ -2794,8 +2794,43 @@
<price t="2024-05-29" v="2162000000"/>
<price t="2024-05-30" v="2201000000"/>
<price t="2024-05-31" v="2229000000"/>
<price t="2024-06-03" v="2264000000"/>
<price t="2024-06-04" v="2225000000"/>
<price t="2024-06-05" v="2261000000"/>
<price t="2024-06-06" v="2263000000"/>
<price t="2024-06-07" v="2259000000"/>
<price t="2024-06-10" v="2261000000"/>
<price t="2024-06-11" v="2261000000"/>
<price t="2024-06-12" v="2254000000"/>
<price t="2024-06-13" v="2253000000"/>
<price t="2024-06-14" v="2263000000"/>
<price t="2024-06-17" v="2257000000"/>
<price t="2024-06-18" v="2257000000"/>
<price t="2024-06-19" v="2289000000"/>
<price t="2024-06-20" v="2289000000"/>
<price t="2024-06-21" v="2288000000"/>
<price t="2024-06-24" v="2315000000"/>
<price t="2024-06-25" v="2332000000"/>
<price t="2024-06-26" v="2332000000"/>
<price t="2024-06-27" v="2337000000"/>
<price t="2024-06-28" v="2348000000"/>
<price t="2024-07-01" v="2368000000"/>
<price t="2024-07-02" v="2351000000"/>
<price t="2024-07-03" v="2376000000"/>
<price t="2024-07-04" v="2375000000"/>
<price t="2024-07-05" v="2383000000"/>
<price t="2024-07-08" v="2390000000"/>
<price t="2024-07-09" v="2364000000"/>
<price t="2024-07-10" v="2385000000"/>
<price t="2024-07-11" v="2376000000"/>
<price t="2024-07-12" v="2388000000"/>
<price t="2024-07-15" v="2380000000"/>
<price t="2024-07-16" v="2381000000"/>
<price t="2024-07-17" v="2404000000"/>
<price t="2024-07-18" v="2426000000"/>
<price t="2024-07-19" v="2419000000"/>
</prices>
<latest t="2024-05-31" v="2229000000">
<latest t="2024-07-19" v="2419000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down Expand Up @@ -4007,8 +4042,43 @@
<price t="2024-05-29" v="1178500000"/>
<price t="2024-05-30" v="1167000000"/>
<price t="2024-05-31" v="1159000000"/>
<price t="2024-06-03" v="1164000000"/>
<price t="2024-06-04" v="1147500000"/>
<price t="2024-06-05" v="1156000000"/>
<price t="2024-06-06" v="1156500000"/>
<price t="2024-06-07" v="1152500000"/>
<price t="2024-06-10" v="1146500000"/>
<price t="2024-06-11" v="1129000000"/>
<price t="2024-06-12" v="1137000000"/>
<price t="2024-06-13" v="1090500000"/>
<price t="2024-06-14" v="1058500000"/>
<price t="2024-06-17" v="1061000000"/>
<price t="2024-06-18" v="1061000000"/>
<price t="2024-06-19" v="1063000000"/>
<price t="2024-06-20" v="1079500000"/>
<price t="2024-06-21" v="1081500000"/>
<price t="2024-06-24" v="1105500000"/>
<price t="2024-06-25" v="1115000000"/>
<price t="2024-06-26" v="1117500000"/>
<price t="2024-06-27" v="1117500000"/>
<price t="2024-06-28" v="1047500000"/>
<price t="2024-07-01" v="1078000000"/>
<price t="2024-07-02" v="1090500000"/>
<price t="2024-07-03" v="1088000000"/>
<price t="2024-07-04" v="1094000000"/>
<price t="2024-07-05" v="1101500000"/>
<price t="2024-07-08" v="1090000000"/>
<price t="2024-07-09" v="1063500000"/>
<price t="2024-07-10" v="1067000000"/>
<price t="2024-07-11" v="1082000000"/>
<price t="2024-07-12" v="1098500000"/>
<price t="2024-07-15" v="1096500000"/>
<price t="2024-07-16" v="1101000000"/>
<price t="2024-07-17" v="1098000000"/>
<price t="2024-07-18" v="1090500000"/>
<price t="2024-07-19" v="1070000000"/>
</prices>
<latest t="2024-05-31" v="1159000000">
<latest t="2024-07-19" v="1070000000">
<high>-1</high>
<low>-1</low>
<volume>-1</volume>
Expand Down Expand Up @@ -4609,7 +4679,7 @@
<config>
<uuid>69cff468-3eb7-413a-aa63-51726c5415e5</uuid>
<name>benchmark</name>
<data>Security0152978e-2ea2-436f-b07a-0333b988ea8b;#e279a6;SOLID;false;2,[b]Security0152978e-2ea2-436f-b07a-0333b988ea8b;#00ff40;SOLID;false;2</data>
<data>Security0152978e-2ea2-436f-b07a-0333b988ea8b;#e279a6;SOLID;false;2</data>
</config>
</configurations>
</config-set>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ Path to Date = $.TimeSeries.Security[*].HistoryDetail[*].EndDate
Path to Close = $.TimeSeries.Security[*].HistoryDetail[*].Value
```

![Example of JSON provider for historical quotes](images/morningstar.png){.pp-figure}
![Example of JSON provider for historical quotes](../images/morningstar.png){.pp-figure}

Always worth double-checking the displayed values against the Morningstar chart.
23 changes: 17 additions & 6 deletions docs/en/how-to/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
---
title: How-to
---
The *how-to* section demonstrates the features and functions of the *Portfolio Performance* program in a real-world context. Check the sidebar (or click the <span style="color:red">:material-menu:</span> menu if it is collapsed) to view all topics. A brief summary of each topic, listed in alphabetical order, is provided below.

- [Benchmarking your portfolio](./benchmarking.md): Benchmarking involves comparing your portfolio's performance against financial indexes like the *S&P 500*. This section explains how to find and add indexes from sources like Yahoo Finance and investing.com. It also covers displaying benchmarks in performance charts and comparing your portfolio's performance to these benchmarks.

Figure: Documentation framework.{class="align-right" style="width:50%"}
- [Copy securities between portfolios](./copy-securities.md): This page explains how to transfer securities between different portfolios in the Portfolio Performance software. It covers methods like *Drag & Drop*, *Exporting & Importing*, and *Copy and Paste* (with intermediate CSV-file). The page also discusses the complexities of copying between XML files.

![](../images/documentation-framework.svg)
- [Downloading Historical Prices](./downloading-historical-prices/index.md) provides various methods and sources for obtaining historical stock prices. Most securities are covered by [Portfolio Report](downloading-historical-prices/portfolioreport.md) or [Yahoo Finance](downloading-historical-prices/yahoo-finance.md). In some cases, more sophisticated methods may be required, such as downloading from a [CSV File](downloading-historical-prices/csv-file.md), utilizing a [JSON Quote Feed Provider](downloading-historical-prices/json.md) to fetch data, or scraping a [table on a website](downloading-historical-prices/table-website.md). There are many other sources such as [Alpha Vantage](downloading-historical-prices/alpha-vantage.md), [EODHD](downloading-historical-prices/eodhd.md), and [Morningstar ](downloading-historical-prices/morningstar.md).

The how-to section covers topics such as [importing stock data](../reference/file/import/csv-import.md), [reinvesting dividends](./handling-choice-dividend.md), recording [stock splits](./recording-stock-split.md) and [spin-offs](./recording-spin-off.md), [downloading historical data](./downloading-historical-prices/index.md) from various sources, and many more. Check the sidebar or click the <span style="color:red">:material-menu:</span> menu to view all topics.
- [Handling Choice Dividends](handling-choice-dividend.md) focuses on choice dividends where shareholders can choose between cash or stock payments. It includes practical methods for booking these transactions in Portfolio Performance.

This how-to section is designed to help you use all features and functions of the *Portfolio Performance* program in a real working context. Unlike the "Getting-started" section, which is more general and uses simplified examples, the how-to section shows you how to handle the program in a real environment with real data.
- [Import GBX Priced Securities](import-gbx.md) is a short guide for importing transactions and securities priced in GBX (pence). It emphasizes creating securities with the correct currency and preparing transaction data for import as CSV files.

The how-to section is not a substitute for the tutorials, which provide a more comprehensive and pedagogical introduction to the program. Nor is it a substitute for the basic concepts and the reference manual sections, which explain the theoretical foundations and the technical details of the program. The how-to section is meant to complement these other sections by providing practical guidance and tips for using the program effectively.
- [Inspecting Source Code](inspect-source-code.md) provides instructions on examining the Portfolio Performance source code on GitHub to understand calculation methods, such as the volatility indicator.

- Recording a [Merger](recording-merger.md), [Spin-Off](recording-spin-off.md), or [Stock Split](recording-stock-split.md) is quite common in portfolio management. These pages discuss various methods, applied to some real examples such as the Amazon stock split, the Daimler Truck Holding AG spin-off, and the Unipol Gruppo's merger. The section about [Insolvency](insolvency.md) explains how to handle securities of insolvent companies, including disabling automatic quote updates, deleting historical prices, and manually adjusting security values.

- Importing PDF-bank notes can be a significant time-saver. [Requesting a New PDF Importer](requesting-new-importer.md) provides guidance for specific bank or broker transactions, including how to extract and anonymize PDF text, submit requests on the PP forum, and wait for developer integration.

- [Retrieving gold and other precious metals prices](./gold-prices.md): This page discusses various methods to invest in gold, including physical gold, ETFs, and shares of gold mining companies. It explains how to download historical gold prices from websites like Ariva.de, LBMA, and Gold.org.

- [User Interface Overview](user-interface.md)
Describes the elements of the PP user interface, such as the menu bar, sidebar, dual-pane layouts, tables within the main pane, and keyboard shortcuts for essential functions.

Most tips and tricks are initially discussed on the [PP forum](https://forum.portfolio-performance.info). Regularly checking this forum will provide you with valuable insights into the PP program. It's worth noting that a significant portion of the information on the forum is in German, but you can use your browser's translation function to understand it in your preferred language.

We have added also some tips and tricks, with many of them initially discussed on the [PP forum](https://forum.portfolio-performance.info). It's worth noting that a significant portion of the information on the forum is in German, but you can utilize your browser's Translate function to comprehend it in your preferred language.

7 changes: 3 additions & 4 deletions docs/en/how-to/inspect-source-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Inspecting the source code

While using the PP program, you may sometimes encounter results that you don't fully understand. PP already goes a long way to explain its calculations and results by offering intermediate results, popovers with detailed information, and possibilities to export the data in various forms to further analyze with other tools, such as Excel.

Another possibility is to inspect the source code. The beauty of open-source software like PP is that the source code is readily available. Inspecting the code offers a unique insight into how things are measured and calculated.
Another possibility is to inspect the source code or the XML-file. The beauty of open-source software like PP is that the source code is readily available. Inspecting the code offers a unique insight into how things are measured and calculated.

# Example 1: How is the volatility indicator calculated?
## Example 1: How is the volatility indicator calculated?

The performance dashboard (View > Reports > Performance) displays several indices of performance and risk, including the volatility indicator. From other sources, such as [Investopedia's How Do You Calculate Volatility in Excel?](https://www.investopedia.com/ask/answers/021015/how-can-you-calculate-volatility-excel.asp), you know that volatility is often measured by the standard deviation between returns of an investment. A typical Excel formula looks like: `= STDEV.S(A1:A100) * SQRT(100)`, assuming that the daily returns are within the range A1:A100 in Excel.

Expand All @@ -15,7 +15,7 @@ Upon trying this on your portfolio, you get different results. So, you decide to
1. Navigate to the GitHub source code: [https://github.com/portfolio-performance/portfolio](https://github.com/portfolio-performance/portfolio). The software is written in Java and structured in several modules.
2. Use the search bar at the very top of the window to search in the repository: `portfolio-performance/portfolio`. Enter a relevant search term, such as "volatility," to find the source code where this term is mentioned. Scroll through the different modules to get the feeling. It will be rather evident why `volatility` appears in these modules.

Figure: Result of the Saerch 'Volatility' in the github repo of PP. {class=pp-figure}
Figure: Result of the Search 'Volatility' in the github repo of PP. {class=pp-figure}

![](./images/source-code-search-volatility.png)

Expand All @@ -27,4 +27,3 @@ Upon trying this on your portfolio, you get different results. So, you decide to




45 changes: 0 additions & 45 deletions docs/en/how-to/quote-feed.md

This file was deleted.

Loading

0 comments on commit b2d2c7d

Please sign in to comment.