From c06410746fd5f7928bf4e2f4928952c86220018a Mon Sep 17 00:00:00 2001
From: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Date: Tue, 5 Mar 2024 12:00:28 +0000
Subject: [PATCH] [Feature] - Excel help page (#6165)
* create help page
* rename file
* words
* words
* more issues
* less words
* minor fix
* email
* no bare urls
* unused attribute
* ruff
---
website/content/excel/data-connectors.md | 2 +-
website/content/excel/data-slicer.md | 2 +-
.../excel/getting-started/_category_.json | 2 +-
website/content/excel/help.md | 59 +++++++++++++++++++
website/controller_doc_classes.py | 5 --
website/generate_excel_markdown.py | 2 +-
6 files changed, 63 insertions(+), 9 deletions(-)
create mode 100644 website/content/excel/help.md
diff --git a/website/content/excel/data-connectors.md b/website/content/excel/data-connectors.md
index 24bb98376b35..4094df81e404 100644
--- a/website/content/excel/data-connectors.md
+++ b/website/content/excel/data-connectors.md
@@ -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
diff --git a/website/content/excel/data-slicer.md b/website/content/excel/data-slicer.md
index 564d890dcaaa..74b4ff77c4e1 100644
--- a/website/content/excel/data-slicer.md
+++ b/website/content/excel/data-slicer.md
@@ -1,6 +1,6 @@
---
title: Data slicer
-sidebar_position: 5
+sidebar_position: 2
description: Slice Excel ranges by label or index
keywords:
- Microsoft Excel
diff --git a/website/content/excel/getting-started/_category_.json b/website/content/excel/getting-started/_category_.json
index eb95172a470a..437c38a5fa8f 100644
--- a/website/content/excel/getting-started/_category_.json
+++ b/website/content/excel/getting-started/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Getting started",
- "position": 3
+ "position": 1
}
diff --git a/website/content/excel/help.md b/website/content/excel/help.md
new file mode 100644
index 000000000000..46171a7f168b
--- /dev/null
+++ b/website/content/excel/help.md
@@ -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 <support@openbb.finance>.
+
+<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>
diff --git a/website/controller_doc_classes.py b/website/controller_doc_classes.py
index 3066321e564c..d2d762f2603b 100644
--- a/website/controller_doc_classes.py
+++ b/website/controller_doc_classes.py
@@ -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)
@@ -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":
diff --git a/website/generate_excel_markdown.py b/website/generate_excel_markdown.py
index fd672981a680..e92585d9f5db 100644
--- a/website/generate_excel_markdown.py
+++ b/website/generate_excel_markdown.py
@@ -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: