Skip to content

Commit 7deef69

Browse files
committed
adding create-portfolio.md
1 parent 0f903ad commit 7deef69

File tree

5 files changed

+52
-8
lines changed

5 files changed

+52
-8
lines changed

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"githubPullRequests.ignoredPullRequestBranches": [
3+
"master"
4+
]
5+
}

config/en/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ nav:
8686
- Getting started:
8787
- Getting started: getting-started/index.md
8888
- Installation: getting-started/installation.md
89+
- Creating a portfolio: getting-started/create-portfolio.md
8990
- Basic concepts:
9091
- Basic concepts: concepts/index.md
9192
- Account: concepts/account.md

docs/en/getting-started/create-portfolio.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,56 @@ title: Creating a portfolio
44

55
With the menu `File > New > File` you can create a new portfolio file. You can have as many portfolios on your system. A wizard will guide you through the setup process.
66

7-
First you need to select the default currency for the portfolio (see figure 1). You can always he the currency for individual securities
8-
7+
First you need to select the default currency for the portfolio (see figure 1). You can always change the currency for individual securities. PP supports almost every possible currency: from AED (United Arab Emirates Dirham) to ZWL (Zimbabwean dollar).
98
![Figure 1: Selecting the default currency for the portfolio.](images/create-portfolio-wizard-step-1.png)
109

11-
PP supports more than xx currencies
10+
Your portfolio must contain at least one security [account](../concepts/account.md) and one associated deposit account (reference).
1211

1312
![Figure 2: Adding security and reference accounts to the portfolio.](images/create-portfolio-wizard-step-2.png)
1413

14+
Sometimes, you need more than one deposit account. In step 3, you can add these extra cash accounts (e.g. in different currencies) to your portfolio.
1515
![Figure 3: Adding additional cash accounts to the portfolio.](images/create-portfolio-wizard-step-3.png)
1616

17+
As part of the creation wizard, you can also add the securities that you want to track in this portfolio. These securities are retrieved from German index trackers such a DAX (Deutscher Aktienindex) , tecDax, SDAX, and MDAX. You can also add the index itself or others (e.g. NASDAQ) with Indizes. Of course, you can add securities later on. Your choice is then much larger.
18+
1719
![Figure 4: Adding instruments to the portfolio.](images/create-portfolio-wizard-step-4.png)
1820

19-
![Figure 1: Adding taxonomies to the portfolio.](images/create-portfolio-wizard-step-5.png)
2021

21-
A file `unamed.xml` is created. You should save it under a different name and location.
22+
Taxonomies such as Asset classes and Regions are used to classify your securities. This classification can then later on be used in performance analysis e.g. show me the performance of all securities from region xxx.
23+
24+
![Figure 5: Adding taxonomies to the portfolio.](images/create-portfolio-wizard-step-5.png)
25+
26+
Only steps 1 and 2 are mandatory: setting the default currency and base portfolio with associated cash account. You can tell this from figure 2 because the `Finish` button becomes available. After that a file `unamed.xml` is created. Of course, you should save it under a different name and location.
27+
28+
# XML
29+
All data of your portfolio is stored in one XML-file (eXtensible Markup Language). This is a human-readable file format. For example, take the following buying transaction of 5 shares of Microsoft at a purchase price of 334.27 USD with 30 USD fees and 45 USD taxes (see figure 6.).
30+
31+
![Figure 6: Example of a buying transaction.](images/create-portfolio-example-buy-transaction.png)
32+
33+
This single buying transaction is represented with the following XML code.
34+
35+
``` xml
36+
<transactions>
37+
<portfolio-transaction>
38+
<uuid>72bf2b32-60a5-4c99-ba6d-d3ab695624e5</uuid>
39+
<date>2023-09-10T00:00</date>
40+
<currencyCode>USD</currencyCode>
41+
<amount>174635</amount>
42+
<security reference="../../../../../../../../../securities/security"/>
43+
<crossEntry class="buysell" reference="../../../.."/>
44+
<shares>500000000</shares>
45+
<note>First buy on advice of ...</note>
46+
<units>
47+
<unit type="FEE">
48+
<amount currency="USD" amount="3000"/>
49+
</unit>
50+
<unit type="TAX">
51+
<amount currency="USD" amount="4500"/>
52+
</unit>
53+
</units>
54+
<updatedAt>2023-09-10T18:43:28.135529700Z</updatedAt>
55+
<type>BUY</type>
56+
</portfolio-transaction>
57+
</transactions>
58+
59+
```
31.5 KB
Loading

docs/en/getting-started/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ PP is available for MacOS, Windows and Linux. You need to download it and do som
99
# Windows
1010
You can download the compressed *Zip-file* and extract it in a directory at your choice. Even a portable USB-stick (about 250 MB free space) is fine (run from stick).
1111

12-
# Windows
13-
You can download the compressed *Zip-file* and extract it in a directory at your choice. Even a portable USB-stick (about 250 MB free space) is fine (run from stick).
14-
1512
You can also download the Windows - Installer (setup.exe). On Windows 11, you get a security warning about the dangers of running an exe-file. After that, double clicking on this file, will start the installation. You can change the destination folder. By default, the c:\user directory is taken. You need about 200 MB of free space (see figure 2).
1613

1714
![Fig 2: Windows Installer dialog box.](images/installation-win-installer-path.png) { .pp-figure}
@@ -21,6 +18,9 @@ TODO: difference between windows installer & zip + adding how to install on macO
2118
TODO: difference between windows installer & zip + adding how to install on macOS & Linux
2219
{: .hidden}
2320

21+
# MacOS
22+
23+
2424
# Github
2525
The installer files are in fact stored in the [author's github repository](https://github.com/portfolio-performance/portfolio/releases). So, you can also download the program from this repository. If you ever should need a previous version, this is also the place to be (click on the version number at the left side).
2626

0 commit comments

Comments
 (0)