Skip to content

Commit

Permalink
[Feature] - Excel help page (#6165)
Browse files Browse the repository at this point in the history
* create help page

* rename file

* words

* words

* more issues

* less words

* minor fix

* email

* no bare urls

* unused attribute

* ruff
  • Loading branch information
montezdesousa authored Mar 5, 2024
1 parent 47541d4 commit c064107
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 9 deletions.
2 changes: 1 addition & 1 deletion website/content/excel/data-connectors.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Data connectors
sidebar_position: 4
sidebar_position: 3
description: Access your data connectors from OpenBB Terminal Pro inside OpenBB Add-in for Excel.
keywords:
- Microsoft Excel
Expand Down
2 changes: 1 addition & 1 deletion website/content/excel/data-slicer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Data slicer
sidebar_position: 5
sidebar_position: 2
description: Slice Excel ranges by label or index
keywords:
- Microsoft Excel
Expand Down
2 changes: 1 addition & 1 deletion website/content/excel/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Getting started",
"position": 3
"position": 1
}
59 changes: 59 additions & 0 deletions website/content/excel/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Help
sidebar_position: 5
description: Help for OpenBB Add-in for Excel.
keywords:
- Microsoft Excel
- Add-in
- Help
---

<!-- markdownlint-disable MD033 -->
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Help | Get help" />

If you face specific issues while using the add-in and the solutions provided here don't resolve them, don't hesitate to reach out to us for further assistance. You can contact us through <[email protected]>.

<details>
<summary>Running an OBB. function returns '#VALUE!'</summary>

* Make sure you are using the correct syntax for the function. You can find the correct syntax for each function [here](https://docs.openbb.co/excel/reference)
* If you have just opened your workbook and the OBB. function returns '#VALUE!', try recalculating the cell again - this is an ongoing issue with Excel add-ins

</details>

<details>
<summary>OBB. functions are not available after installing the add-in</summary>

* Make sure OpenBB Add-in for Excel shows in the ribbon
* Go to **Insert** > **Get Add-ins** > **My Add-ins** > Click '...' when hovering OpenBB add-in > remove the add-in and install it again
* Restart your computer or manually [clear the Office cache](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/clear-cache)

</details>

<details>
<summary>Task pane displays "You don’t have permission to use this add-in. Contact your system administrator to request access."</summary>

* Make sure your account has the necessary permissions to use add-in
* Restart your computer or manually [clear the Office cache](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/clear-cache)

</details>

<details>
<summary>Editing a workbook in the browser and then on desktop app duplicates the 'OpenBB' tab in the ribbon</summary>

This is a known Excel issue. Currently, there is no definitive fix for the problem, but there are workarounds you can apply to fix the file depending on your operating system:

* **Windows**: File > Info > Inspect Workbook > Check ‘Task Pane Add-ins’ > Click ‘OK’. This will scan your workbook and remove the stale add-in reference created by Excel in the browser
* **Mac**: rename your file from .xlsx to .zip > unzip it using WinZip for Mac (don’t use the default unzip tool, otherwise it won’t work) > look for webextensions folder and delete webextension1.xml > rename the file back to .xlsx

</details>

<details>
<summary>Cannot retrieve the data added to Terminal Pro through custom backend using OBB.BYOD</summary>

* Make sure your backend is running and accessible
* If you are using Mac or Safari make sure your backend is using HTTPS and has a valid SSL certificate

</details>
5 changes: 0 additions & 5 deletions website/controller_doc_classes.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
)
from openbb_terminal.parent_classes import BaseController
from openbb_terminal.sdk import openbb
from openbb_terminal.stocks.comparison_analysis import finviz_compare_model

set_system_variable("TEST_MODE", True)
set_system_variable("LOG_COLLECT", False)
Expand Down Expand Up @@ -295,10 +294,6 @@ def __init__(self, controller: BaseController, trailmap: str):

if self.name == "options" and hasattr(self.controller, "selected_date"):
self.controller.selected_date = get_expiration_date()
elif self.name == "ca" and hasattr(self.controller, "similar"):
self.controller.similar = finviz_compare_model.get_similar_companies(
self.symbol, ["Sector", "Industry"]
)
if hasattr(self.controller, "current_currency"):
self.controller.current_currency = "usdt"
if hasattr(self.controller, "source") and trailmap.split(".")[0] == "crypto":
Expand Down
2 changes: 1 addition & 1 deletion website/generate_excel_markdown.py
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ def recursive(path: Path):
recursive(p)
position += 1

write_mdx_and_category(self.target_dir, self.main_folder, 5)
write_mdx_and_category(self.target_dir, self.main_folder, 6)
recursive(self.target_dir)

def dump(self, reference_map: Dict) -> None:
Expand Down

0 comments on commit c064107

Please sign in to comment.