Skip to content

Commit 99c25a3

Browse files
committed
Revisions per Elizabeth's review
See #2001 for resolutions.
1 parent 9df3733 commit 99c25a3

File tree

67 files changed

+137
-137
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+137
-137
lines changed

Diff for: docs/concepts/browsers-used-by-office-web-add-ins.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ localization_priority: Normal
77

88
# Browsers used by Office Add-ins
99

10-
Office add-ins are web applications that are displayed using iFrames when running in Office for the web and using embedded browser controls in Office for desktop and mobile clients. Add-ins also need a JavaScript engine to run the JavaScript. Both the embedded browser and the engine are supplied by a browser installed on the user's computer.
10+
Office add-ins are web applications that are displayed using iFrames when running in Office on the web and using embedded browser controls in Office for desktop and mobile clients. Add-ins also need a JavaScript engine to run the JavaScript. Both the embedded browser and the engine are supplied by a browser installed on the user's computer.
1111

1212
Which browser is used depends on:
1313

1414
- The computer's operating system.
15-
- Whether the add-in is running in Office for the web, Microsoft 365, or non-subscription Office 2013 or later.
15+
- Whether the add-in is running in Office on the web, Microsoft 365, or non-subscription Office 2013 or later.
1616

1717
The following table shows which browser is used for the various platforms and operating systems.
1818

1919
|**OS / Platform**|**Browser**|
2020
|:-----|:-----|:-----|:-----|:-----|:-----|:-----|
21-
|Office for the web|The browser in which Office is opened.|
21+
|Office on the web|The browser in which Office is opened.|
2222
|Mac|Safari|
2323
|iOS|Safari|
2424
|Android|Chrome|

Diff for: docs/concepts/correlated-objects-pattern.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ localization_priority: Normal
1111
> [!NOTE]
1212
> This article assumes that you're beyond the beginning stage of working with at least one of the four host-specific Office JavaScript APIs—for Excel, Word, OneNote, and Visio—that use a batch system to interact with the Office document. In particular, you should know what a call of `context.sync` does and you should know what a collection object is. If you're not at that stage, please start with [Understanding the Office JavaScript API](../develop/understanding-the-javascript-api-for-office.md) and the documentation linked to under "host-specific" in that article.
1313
14-
For some programming scenarios in Office Add-ins that use one of the host-specific API models (for Excel, Word, OneNote, and Visio), your code needs to read, write, or process some property from every member of a collection object. For example, an Excel add-in that needs to get the values of every cell in a particular table column or a Word add-in that needs to highlight every instance of a string in the document. You need to iterate over the members in the `items` property of the collection object; but, for performance reasons, you need to avoid calling `context.sync` in every iteration of the loop. Every call of `context.sync` is a round trip from the add-in to the Office document. Repeated round trips hurt performance, especially if the add-in is running in Office for the web because the round trips go across the internet.
14+
For some programming scenarios in Office Add-ins that use one of the host-specific API models (for Excel, Word, OneNote, and Visio), your code needs to read, write, or process some property from every member of a collection object. For example, an Excel add-in that needs to get the values of every cell in a particular table column or a Word add-in that needs to highlight every instance of a string in the document. You need to iterate over the members in the `items` property of the collection object; but, for performance reasons, you need to avoid calling `context.sync` in every iteration of the loop. Every call of `context.sync` is a round trip from the add-in to the Office document. Repeated round trips hurt performance, especially if the add-in is running in Office on the web because the round trips go across the internet.
1515

1616
> [!NOTE]
1717
> All examples in this article use `for` loops but the practices described apply to any loop statement that can iterate through an array, including the following:

Diff for: docs/design/add-in-commands.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,18 @@ You can specify whether the command is enabled or disabled when your add-in laun
5959

6060
Add-in commands are currently supported on the following platforms.
6161

62-
- Office for Windows (build 16.0.6769+, connected to Microsoft 365 subscription)
62+
- Office on Windows (build 16.0.6769+, connected to Microsoft 365 subscription)
6363
- Office 2019 on Windows
6464
- Office on Mac (build 15.33+, connected to Microsoft 365 subscription)
6565
- Office 2019 on Mac
66-
- Office for the web
66+
- Office on the web
6767

6868
> [!NOTE]
6969
> For information about support in Outlook, see [Add-in commands for Outlook](../outlook/add-in-commands-for-outlook.md).
7070
7171
## Debugging
7272

73-
To debug an Add-in Command, you must run it in Office for the web. For details, see [Debug add-ins in Office for the web](../testing/debug-add-ins-in-office-online.md).
73+
To debug an Add-in Command, you must run it in Office on the web. For details, see [Debug add-ins in Office on the web](../testing/debug-add-ins-in-office-online.md).
7474

7575
## Best practices
7676

@@ -80,7 +80,7 @@ Apply the following best practices when you develop add-in commands:
8080
- Provide granular actions that make common tasks within your add-in more efficient to perform. Minimize the number of steps an action takes to complete.
8181
- For the placement of your commands in the Office app ribbon:
8282
- Place commands on an existing tab (Insert, Review, and so on) if the functionality provided fits there. For example, if your add-in enables users to insert media, add a group to the Insert tab. Note that not all tabs are available across all Office versions. For more information, see [Office Add-ins XML manifest](../develop/add-in-manifests.md).
83-
- Place commands on the Home tab if the functionality doesn't fit on another tab, and you have fewer than six top-level commands. You can also add commands to the Home tab if your add-in needs to work across Office versions (such as Office for the web or desktop) and a tab is not available in all versions (for example, the Design tab doesn't exist in Office for the web).
83+
- Place commands on the Home tab if the functionality doesn't fit on another tab, and you have fewer than six top-level commands. You can also add commands to the Home tab if your add-in needs to work across Office versions (such as Office on the web or desktop) and a tab is not available in all versions (for example, the Design tab doesn't exist in Office on the web).
8484
- Place commands on a custom tab if you have more than six top-level commands.
8585
- Name your group to match the name of your add-in. If you have multiple groups, name each group based on the functionality that the commands in that group provide.
8686
- Do not add superfluous buttons to increase the real estate of your add-in.

Diff for: docs/design/disable-add-in-commands.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The APIs described in this article are in preview and are currently only availab
2525
2626
## Rules and gotchas
2727

28-
### Single-line ribbon in Office for the web
28+
### Single-line ribbon in Office on the web
2929

30-
In Office for the web, the APIs and manifest markup described in this article only affect the single-line ribbon. They have no effect on the multiline ribbon. They affect both ribbons for desktop Office. For more information about the two ribbons, see [The new look of Office - Simplified Ribbon](https://support.microsoft.com/office/a6cdf19a-b2bd-4be1-9515-d74a37aa59bf).
30+
In Office on the web, the APIs and manifest markup described in this article only affect the single-line ribbon. They have no effect on the multiline ribbon. They affect both ribbons for desktop Office. For more information about the two ribbons, see [The new look of Office - Simplified Ribbon](https://support.microsoft.com/office/a6cdf19a-b2bd-4be1-9515-d74a37aa59bf).
3131

3232
### Shared runtime required
3333

Diff for: docs/design/using-office-ui-fabric-react.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ After you complete the wizard, the generator creates the project and installs su
6969
npm run start:web
7070
```
7171
72-
To use your add-in, open a new document in Word on the web and then sideload your add-in by following the instructions in [Sideload Office Add-ins in Office for the web](../testing/sideload-office-add-ins-for-testing.md#sideload-an-office-add-in-in-office-for-the-web).
72+
To use your add-in, open a new document in Word on the web and then sideload your add-in by following the instructions in [Sideload Office Add-ins in Office on the web](../testing/sideload-office-add-ins-for-testing.md#sideload-an-office-add-in-in-office-on-the-web).
7373
7474
3. In Word, choose the **Home** tab, and then choose the **Show Taskpane** button in the ribbon to open the add-in task pane. Notice the default text and the **Run** button at the bottom of the task pane. In the remainder of this walkthrough, you'll redefine this text and button by creating a React component that uses UX components from Fabric React.
7575

Diff for: docs/develop/add-in-manifests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ Only use the [AppDomains](../reference/manifest/appdomains.md) element to specif
110110

111111
## Specify domains you want to open in the add-in window
112112

113-
When running in Office for the web, your task pane can be navigated to any URL. However, in desktop platforms, if your add-in tries to go to a URL in a domain other than the domain that hosts the start page (as specified in the [SourceLocation](../reference/manifest/sourcelocation.md) element of the manifest file), that URL opens in a new browser window outside the add-in pane of the Office host application.
113+
When running in Office on the web, your task pane can be navigated to any URL. However, in desktop platforms, if your add-in tries to go to a URL in a domain other than the domain that hosts the start page (as specified in the [SourceLocation](../reference/manifest/sourcelocation.md) element of the manifest file), that URL opens in a new browser window outside the add-in pane of the Office host application.
114114

115-
To override this (desktop Office) behavior, specify each domain you want to open in the add-in window in the list of domains specified in the [AppDomains](../reference/manifest/appdomains.md) element of the manifest file. If the add-in tries to go to a URL in a domain that is in the list, then it opens in the task pane in both Office for the web and desktop. If it tries to go to a URL that isn't in the list, then, in desktop Office, that URL opens in a new browser window (outside the add-in pane).
115+
To override this (desktop Office) behavior, specify each domain you want to open in the add-in window in the list of domains specified in the [AppDomains](../reference/manifest/appdomains.md) element of the manifest file. If the add-in tries to go to a URL in a domain that is in the list, then it opens in the task pane in both Office on the web and desktop. If it tries to go to a URL that isn't in the list, then, in desktop Office, that URL opens in a new browser window (outside the add-in pane).
116116

117117
> [!NOTE]
118118
> There are two exceptions to this behavior:

Diff for: docs/develop/auth-with-office-dialog-api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ localization_priority: Priority
77

88
# Authenticate and authorize with the Office dialog API
99

10-
Many identity authorities, also called Secure Token Services (STS), prevent their login page from opening in an iframe. These include Google, Facebook, and services protected by Microsoft Identity Platform (formerly Azure AD V 2.0) such as a Microsoft Account, a Microsoft 365 Education or Work account, or other common account. This creates a problem for Office Add-ins because when the add-in is running in **Office for the web**, the task pane is an iframe. Users of an add-in can only login to one of these services if the add-in can open an entirely separate browser instance. This is why Office provides its [Office dialog API](dialog-api-in-office-add-ins.md), specifically the [displayDialogAsync](/javascript/api/office/office.ui) method.
10+
Many identity authorities, also called Secure Token Services (STS), prevent their login page from opening in an iframe. These include Google, Facebook, and services protected by Microsoft Identity Platform (formerly Azure AD V 2.0) such as a Microsoft Account, a Microsoft 365 Education or work account, or other common account. This creates a problem for Office Add-ins because when the add-in is running in **Office on the web**, the task pane is an iframe. Users of an add-in can only login to one of these services if the add-in can open an entirely separate browser instance. This is why Office provides its [Office dialog API](dialog-api-in-office-add-ins.md), specifically the [displayDialogAsync](/javascript/api/office/office.ui) method.
1111

1212
> [!NOTE]
1313
> This article assumes that you are familiar with [Use the Office dialog API in your Office Add-ins](dialog-api-in-office-add-ins.md).
@@ -72,7 +72,7 @@ Closely related to this is the fact that a library will typically provide both i
7272
As an alternative, your add-in's dialog box browser instance can directly call the library's interactive method. When that method returns a token, your code must explicitly store the token someplace where the task pane's browser instance can retrieve it, such as Local Storage\* or a server-side database. Another option is to pass the token to the task pane with the `messageParent` method. This alternative is only possible if the interactive method stores the access token in a place where your code can read it. Sometimes a library's interactive method is designed to store the token in a private property of an object that is inaccessible to your code.
7373

7474
> [!NOTE]
75-
> \* There is a bug that will effect your strategy for token handling. If the add-in is running in **Office for the web** in either the Safari or Edge browser, the dialog box and task pane do not share the same Local Storage, so it cannot be used to communicate between them.
75+
> \* There is a bug that will effect your strategy for token handling. If the add-in is running in **Office on the web** in either the Safari or Edge browser, the dialog box and task pane do not share the same Local Storage, so it cannot be used to communicate between them.
7676
7777
### You usually cannot use the library's "auth context" object
7878

Diff for: docs/develop/authorize-to-microsoft-graph-without-sso.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ localization_priority: Normal
77

88
# Authorize to Microsoft Graph without SSO
99

10-
Your add-in can get authorization to Microsoft Graph data by obtaining an access token to Graph from Azure Active Directory (AAD). Use either the Authorization Code flow or the Implicit flow just as you would in other web applications but with one exception: AAD does not allow its login page to open in an iframe. When an Office Add-in is running on *Office for the web*, the task pane is an iframe. This means you'll need to open the AAD login screen in a dialog box opened with the Office dialog API. This affects how you use authentication and authorization helper libraries. For more information, see [Authentication with the Office dialog API](auth-with-office-dialog-api.md).
10+
Your add-in can get authorization to Microsoft Graph data by obtaining an access token to Graph from Azure Active Directory (AAD). Use either the Authorization Code flow or the Implicit flow just as you would in other web applications but with one exception: AAD does not allow its login page to open in an iframe. When an Office Add-in is running on *Office on the web*, the task pane is an iframe. This means you'll need to open the AAD login screen in a dialog box opened with the Office dialog API. This affects how you use authentication and authorization helper libraries. For more information, see [Authentication with the Office dialog API](auth-with-office-dialog-api.md).
1111

1212
For information about programming authentication with AAD, begin with [Microsoft identity platform (v2.0) overview](/azure/active-directory/develop/v2-overview), where you'll find tutorials and guides in that documentation set, as well as links to relevant samples. Once again, you may need to adjust the code in the samples to run in the Office dialog box to account for the fact that the Office dialog box runs in a separate process from the task pane.
1313

Diff for: docs/develop/authorize-to-microsoft-graph.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ localization_priority: Normal
77

88
# Authorize to Microsoft Graph with SSO (preview)
99

10-
Users sign in to Office (online, mobile, and desktop platforms) using either their personal Microsoft account or their Microsoft 365 Education or Work account. The best way for an Office Add-in to get authorized access to [Microsoft Graph](https://developer.microsoft.com/graph/docs) is to use the credentials from the user's Office sign on. This enables them to access their Microsoft Graph data without needing to sign in a second time.
10+
Users sign in to Office (online, mobile, and desktop platforms) using either their personal Microsoft account or their Microsoft 365 Education or work account. The best way for an Office Add-in to get authorized access to [Microsoft Graph](https://developer.microsoft.com/graph/docs) is to use the credentials from the user's Office sign on. This enables them to access their Microsoft Graph data without needing to sign in a second time.
1111

1212
> [!NOTE]
1313
> The Single Sign-on API is currently supported in preview for Word, Excel, Outlook, and PowerPoint. For more information about where the Single Sign-on API is currently supported, see [IdentityAPI requirement sets](../reference/requirement-sets/identity-api-requirement-sets.md).

Diff for: docs/develop/automatically-open-a-task-pane-with-a-document.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The autoopen feature is currently <!-- in **developer preview** and it is only -
2525

2626
|**Products**|**Platforms**|
2727
|:-----------|:------------|
28-
|<ul><li>Word</li><li>Excel</li><li>PowerPoint</li></ul>|Supported platforms for all products:<ul><li>Office for Windows Desktop. Build 16.0.8121.1000+</li><li>Office on Mac. Build 15.34.17051500+</li><li>Office for the web</li></ul>|
28+
|<ul><li>Word</li><li>Excel</li><li>PowerPoint</li></ul>|Supported platforms for all products:<ul><li>Office on Windows Desktop. Build 16.0.8121.1000+</li><li>Office on Mac. Build 15.34.17051500+</li><li>Office on the web</li></ul>|
2929

3030

3131
## Best practices

Diff for: docs/develop/create-addin-commands.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The following example shows how to use the **VersionOverrides** element and its
115115

116116
The **Hosts** element contains one or more **Host** elements. A **Host** element specifies a particular Office host. The **Host** element contains child elements that specify the add-in commands to display after your add-in is installed in that Office host. To show the same add-in commands in two or more different Office hosts, you must duplicate the child elements in each **Host**.
117117

118-
The **DesktopFormFactor** element specifies the settings for an add-in that runs in Office for the web (in a browser) and Windows.
118+
The **DesktopFormFactor** element specifies the settings for an add-in that runs in Office on the web (in a browser) and Windows.
119119

120120
The following is an example of **Hosts**, **Host**, and **DesktopFormFactor** elements.
121121

0 commit comments

Comments
 (0)