Skip to content

Commit

Permalink
adding managing-taxonomies.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hug-sch committed Jul 7, 2024
1 parent c33c80f commit 3a3a080
Show file tree
Hide file tree
Showing 11 changed files with 244 additions and 2 deletions.
4 changes: 3 additions & 1 deletion config/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,9 @@ nav:
- Payments: reference/view/reports/performance/payments.md
- Trades: reference/view/reports/performance/trades.md
- Taxonomies:
- Taxonomies: reference/view/taxonomies/index.md
- Taxonomies: reference/view/taxonomies/index.md
- Managing taxonomies: reference/view/taxonomies/managing-taxonomies.md
- Using taxonomies: reference/view/taxonomies/using-taxonomies.md
- General Data:
- Settings: reference/view/general-data/settings.md
- Currencies: reference/view/general-data/currencies.md
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/help/preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Figure: The General option of the menu of View > Settings. {class=align-right st

By selecting the `General` menu item in the sidebar of the `Preferences dialog box` (see Figure 1), you will be presented with four options:

- `Automatically update quotes after opening a file`: Each security can have an external data source assigned for [downloading historical quotes](../../how-to/downloading-historical-prices/). You can start the download process manually through the [Online menu](../online.md) or enable the option to automatically download historical quotes upon opening the portfolio.
- `Automatically update quotes after opening a file`: Each security can have an external data source assigned for [downloading historical quotes](../../how-to/downloading-historical-prices/index.md). You can start the download process manually through the [Online menu](../online.md) or enable the option to automatically download historical quotes upon opening the portfolio.

<br style="clear:left;">

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
194 changes: 194 additions & 0 deletions docs/en/reference/view/taxonomies/images/taxonomies-new.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/en/reference/view/taxonomies/managing-taxonomies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Managing taxonomies
---


When creating a new portfolio, initially, no taxonomies are displayed in the sidebar (refer to Figure 1, top left). In theory, there is no restriction on the number of taxonomies that can be added. However, in most cases, two or three taxonomies should be sufficient. These taxonomies will be listed not only in the sidebar but also in the `View` menu.

Figure: Adding taxonomies. {class=pp-figure}

![](images/taxonomies-new.svg)

## Adding a new taxonomy

Click the green plus button <span style="color:green">:octicons-plus-circle-16:</span> to add a new taxonomy. You can then utilize one of the [predefined templates](index.md) or create a new taxonomy (see Figure 1), which can be based on one of the existing templates. Choose `Empty taxonomy` if you want to start from scratch and define all categories and sub-categories yourself. Give the new taxonomy a descriptive name. Two taxonomies can have the same name, which is, of course, not ideal. Click "OK" to add the taxonomy in the sidebar.

The context menu of the taxonomies list allows you to rename, copy, or delete existing taxonomies. You can also rearrange the order of items in the list using the the `Move up` or `Move down` options.


## Editing a taxonomy

Selecting a taxonomy in the list will display its structure in the main pane (see Figure 2), which contains two expandable lists: one for the taxonomy's name (e.g. myTaxonomy) and another for `Without Classification`. The first list contains the categories and subcategories with their assigned securities. The second list contains all securities that have not yet been assigned to a taxonomy category.

Figure: Main pane of a taxonomy. {class=pp-figure}

![](images/taxonomies-edit-classification.png)

In Figure 2, both lists are expanded. The `myTaxonomy` list contains two categories `Base currency` and `Foreign currencies` with appropriate securities assigned. The list `Without Classification` contains all unassigned securities. Please note that you **cannot** assign a security to more than one category.

Figure: Context menu. {class=align-right style="width:20%"}

![](images/taxonomies-edit-context-menu.png)

If you selected an empty taxonomy, you must first add categories and subcategories before assigning securities to them. Use the `Add new classification` context menu to create a new classification (see Figure 3). If you select a subcategory, the new classification will be added within it. You can delete a selected category or list using the context menu.

Selected lists can be sorted by: `Type and Name`, `Type and Actual Value`, `Name`, or `Actual Value`. As shown in Figure 2, each taxonomy category has an assigned color, which can be changed using the context menu.

To expand a category list, click the :fontawesome-solid-angle-right: icon to the left of it, which will change to a :fontawesome-solid-angle-down: icon. Click the downward-pointing caret to collapse the list. To expand or collapse all categories at once, use the context menu and select `Expand all` or `Collapse all`.

6 changes: 6 additions & 0 deletions docs/en/reference/view/taxonomies/using-taxonomies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Using taxonomies
---

- taxonomy is comparable to a tag
- different charts
2 changes: 2 additions & 0 deletions todo/snippets.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ less than: &lt;
sigma: &sum; or &#8721;
non-breaking space: &nbsp;
down-pointing triangle :material-triangle-small-down:
plus in circle :octicons-plus-circle-24:
use <spa></span> to change the color

start-up parameter:
PortfolioPerformance.exe -nl de_DE
Expand Down

0 comments on commit 3a3a080

Please sign in to comment.