Skip to content

Commit 687de5a

Browse files
[All Hosts] (refresh) review 4 low engagement articles (#5233)
* [All Hosts] (refresh) review 4 low engagement articles * fix link * Apply suggestions from code review Co-authored-by: Sam Ramon <[email protected]> --------- Co-authored-by: Sam Ramon <[email protected]>
1 parent ea47d21 commit 687de5a

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

docs/reference/overview/onenote-add-ins-javascript-reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
title: OneNote JavaScript API overview
33
description: Learn more about the OneNote JavaScript API.
4-
ms.date: 07/28/2020
4+
ms.date: 06/17/2025
55
ms.service: onenote
66
ms.localizationpriority: high
77
---
88

99
# OneNote JavaScript API overview
1010

11-
A OneNote add-in interacts with objects in OneNote on the web by using the Office JavaScript API, which includes two JavaScript object models:
11+
A OneNote add-in interacts with objects in OneNote on the web by using the [Office JavaScript API Library](../../develop/understanding-the-javascript-api-for-office.md), which includes two JavaScript object models:
1212

1313
* **OneNote JavaScript API**: These are the [application-specific APIs](../../develop/application-specific-api-model.md) for OneNote. Introduced with Office 2016, the [OneNote JavaScript API](/javascript/api/onenote) provides strongly-typed objects that you can use to access objects in OneNote on the web.
1414

1515
* **Common APIs**: Introduced with Office 2013, the [Common API](/javascript/api/office) can be used to access features such as UI, dialogs, and client settings that are common across multiple types of Office applications.
1616

17-
This section of the documentation focuses on the OneNote JavaScript API, which you'll use to develop the majority of functionality in add-ins that target OneNote on the web. For information about the Common API, see [Common JavaScript API object model](../../develop/office-javascript-api-object-model.md).
17+
This section of the documentation focuses on the OneNote JavaScript API, which you'll use to develop most of the functionality in add-ins that target OneNote on the web. For information about the Common API, see [Common JavaScript API object model](../../develop/office-javascript-api-object-model.md).
1818

1919
## Learn programming concepts
2020

21-
See the following articles for information about important programming concepts.
21+
See the following articles for information about important programming concepts related to OneNote extensibility.
2222

2323
* [OneNote JavaScript API programming overview](../../onenote/onenote-add-ins-programming-overview.md)
2424
* [Work with OneNote page content](../../onenote/onenote-add-ins-page-content.md)

docs/testing/debug-add-ins-using-devtools-edge-legacy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Debug add-ins using developer tools for Microsoft Edge Legacy
33
description: Debug add-ins using the developer tools in Microsoft Edge Legacy.
4-
ms.date: 07/14/2024
4+
ms.date: 06/17/2025
55
ms.localizationpriority: medium
66
---
77

@@ -26,15 +26,15 @@ To determine which browser or webview you're using, see [Browsers and webview co
2626
2727
1. [Sideload](test-debug-non-local-server.md) and run the add-in.
2828
1. Run the Microsoft Edge DevTools.
29-
1. In the tools, open the **Local** tab. Your add-in will be listed by its name. (Only processes that are running in EdgeHTML appear on the tab. The tool can't attach to processes that are running in other browsers or webviews, including Microsoft Edge (WebView2) and Internet Explorer (Trident).)
29+
1. In the tools, open the **Local** tab. Your add-in is listed by its name. (Only processes that are running in EdgeHTML appear on the tab. The tool can't attach to processes that are running in other browsers or webviews, including Microsoft Edge (WebView2) and Internet Explorer (Trident).)
3030

3131
:::image type="content" source="../images/edge-devtools-with-add-in-process.png" alt-text="Edge DevTools showing a process named legacy-edge-debugging.":::
3232

3333
1. Select the add-in name to open it in the tools.
3434
1. Open the **Debugger** tab.
3535
1. Open the file that you want to debug with the following steps.
3636

37-
1. On the debugger task bar, select **Show find in files**. This will open a search window.
37+
1. On the debugger task bar, select **Show find in files**. This action opens a search window.
3838
1. Enter a line of code from the file you want to debug in the search box. It should be something that's not likely to be in any other file.
3939
1. Select the refresh button.
4040
1. In the search results, select the line to open the code file in the pane above the search results.

docs/testing/debug-function-command.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
22
title: Debug a function command with a non-shared runtime
33
description: Learn how to debug function commands.
4-
ms.date: 08/18/2023
4+
ms.date: 06/17/2025
55
ms.localizationpriority: medium
66
---
77

88
# Debug a function command with a non-shared runtime
99

1010
> [!IMPORTANT]
11-
> If your add-in is [configured to use a shared runtime](../develop/configure-your-add-in-to-use-a-shared-runtime.md), you debug the code behind the function command just as you would the code behind a task pane. See [Debug Office Add-ins](debug-add-ins-overview.md) and note that a function command in an add-in with a [shared runtime](runtimes.md#shared-runtime) is *not* a special case as described in that article.
11+
> If your add-in is [configured to use a shared runtime](../develop/configure-your-add-in-to-use-a-shared-runtime.md), debug the code behind the function command just as you would the code behind a task pane. See [Debug Office Add-ins](debug-add-ins-overview.md) and note that a function command in an add-in with a [shared runtime](runtimes.md#shared-runtime) is *not* a special case as described in that article.
1212
1313
> [!NOTE]
14-
> This article assumes that you are familiar with [function commands](../design/add-in-commands.md#types-of-add-in-commands).
14+
> This article assumes that you're familiar with [function commands](../design/add-in-commands.md#types-of-add-in-commands).
1515
1616
Function commands don't have a UI, so a debugger can't be attached to the process in which the function runs on desktop Office. (Outlook add-ins being developed on Windows are an exception to this. See [Debug function commands in Outlook add-ins on Windows](#debug-function-commands-in-outlook-add-ins-on-windows) later in this article.) So function commands, in add-ins with a non-shared runtime, must be debugged in Office on the web where the function runs in the overall browser process. Use the following steps.
1717

18-
1. Sideload the add-in in Office on the web, and then select the button or menu item that runs the function command. This is necessary to load the code file for the function command.
18+
1. [Sideload the add-in in Office on the web](sideload-office-add-ins-for-testing.md), and then select the button or menu item that runs the function command. This is necessary to load the code file for the function command.
1919
1. Open the browser's developer tools. This is usually done by pressing <kbd>F12</kbd>. The debugger in the tools attaches to the browser process.
2020
1. Apply breakpoints to the code as needed for the function command.
2121
1. Rerun the function command. The process stops on your breakpoints.

docs/testing/debug-initialize-onready.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Debug the initialize and onReady functions
33
description: Learn how to debug the Office.initialize and Office.onReady functions.
4-
ms.date: 08/18/2023
4+
ms.date: 06/17/2025
55
ms.localizationpriority: medium
66
---
77

88
# Debug the initialize and onReady functions
99

1010
> [!NOTE]
11-
> This article assumes that you are familiar with [Initialize your Office Add-in](../develop/initialize-add-in.md).
11+
> This article assumes that you're familiar with [Initialize your Office Add-in](../develop/initialize-add-in.md).
1212
1313
The paradox of debugging the [Office.initialize](/javascript/api/office#office-office-initialize-function(1)) and [Office.onReady](/javascript/api/office#office-office-onready-function(1)) functions is that a debugger can only attach to a process that's running, but these functions run immediately as the add-in's runtime process starts up, before a debugger can attach. In most situations, restarting the add-in after a debugger is attached doesn't help because restarting the add-in closes the original runtime process *and the attached debugger* and starts a new process that has no debugger attached.
1414

0 commit comments

Comments
 (0)