From 45b12633a4dfa780881b3e199d9ae40f1f65a3f9 Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Mon, 12 Aug 2024 16:30:11 -0700 Subject: [PATCH 1/7] [All Hosts] (manifest) reorg the manifest part of the TOC --- docs/includes/manifest-guidance.md | 7 +++++- docs/toc.yml | 38 +++++++++++++++++------------- 2 files changed, 27 insertions(+), 18 deletions(-) diff --git a/docs/includes/manifest-guidance.md b/docs/includes/manifest-guidance.md index 91409152c..0890e2f8c 100644 --- a/docs/includes/manifest-guidance.md +++ b/docs/includes/manifest-guidance.md @@ -1,7 +1,12 @@ > [!TIP] > If you'll be testing your add-in across multiple environments (for example, in development, staging, demo, etc.), we recommend that you maintain a different manifest file for each environment. In each manifest file, you can: +> > - Specify the URLs that correspond to the environment. -> - Customize metadata values like `DisplayName` and labels within `Resources` to indicate the environment, so that end users will be able to identify a sideloaded add-in's corresponding environment. +> - Customize metadata values so that end users will be able to identify a sideloaded add-in's corresponding environment. For example: + + - In the unified manifest for Microsoft 365, customize the "name" property and the "label" properties for various UI controls to indicate the environment. + - In the add-in only manifest, customize the `DisplayName` element and and labels within `Resources` element to indicate the environment. + > - Customize the custom functions `namespace` to indicate the environment, if your add-in defines custom functions. > > By following this guidance, you'll streamline the testing process and avoid issues that would otherwise occur when an add-in is simultaneously sideloaded for multiple environments. \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml index 1cfa00f0f..096426ab9 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -116,23 +116,27 @@ items: items: - name: Overview href: develop/add-in-manifests.md - - name: Office Add-ins with the add-in only manifest - href: develop/xml-manifest-overview.md - - name: Office Add-ins with the unified manifest for Microsoft 365 - href: develop/unified-manifest-overview.md - - name: Compare the add-in only manifest with the unified manifest for Microsoft 365 - href: develop/json-manifest-overview.md - - name: Convert an add-in to use the unified manifest for Microsoft 365 - href: develop/convert-xml-to-json-manifest.md - - name: Add-in only manifest reference - href: reference/manifest-reference.md - - name: Extended overrides - href: develop/extended-overrides.md - - name: Find the proper order of manifest elements - href: develop/manifest-element-ordering.md - - name: Update API and manifest version - href: develop/update-your-javascript-api-for-office-and-manifest-schema-version.md - displayName: manifest + - name: Unified manifest for Microsoft 365 + items: + - name: Office Add-ins with the unified manifest for Microsoft 365 + href: develop/unified-manifest-overview.md + - name: Compare the add-in only manifest with the unified manifest for Microsoft 365 + href: develop/json-manifest-overview.md + - name: Convert an add-in to use the unified manifest for Microsoft 365 + href: develop/convert-xml-to-json-manifest.md + - name: Add-in only manifest + items: + - name: Office Add-ins with the add-in only manifest + href: develop/xml-manifest-overview.md + - name: Add-in only manifest reference + href: reference/manifest-reference.md + - name: Extended overrides + href: develop/extended-overrides.md + - name: Find the proper order of manifest elements + href: develop/manifest-element-ordering.md + - name: Update API and manifest version + href: develop/update-your-javascript-api-for-office-and-manifest-schema-version.md + displayName: manifest - name: Privacy, security, and storage items: - name: Overview of add-in privacy and security From 4cdad34f7e03d01ae2d0f1db70f70547fb518a3d Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Mon, 12 Aug 2024 16:36:53 -0700 Subject: [PATCH 2/7] format --- docs/includes/manifest-guidance.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/includes/manifest-guidance.md b/docs/includes/manifest-guidance.md index 0890e2f8c..8d6feac80 100644 --- a/docs/includes/manifest-guidance.md +++ b/docs/includes/manifest-guidance.md @@ -4,8 +4,8 @@ > - Specify the URLs that correspond to the environment. > - Customize metadata values so that end users will be able to identify a sideloaded add-in's corresponding environment. For example: - - In the unified manifest for Microsoft 365, customize the "name" property and the "label" properties for various UI controls to indicate the environment. - - In the add-in only manifest, customize the `DisplayName` element and and labels within `Resources` element to indicate the environment. + - In the unified manifest for Microsoft 365, customize the "name" property and the "label" properties for various UI controls to indicate the environment. + - In the add-in only manifest, customize the `DisplayName` element and and labels within `Resources` element to indicate the environment. > - Customize the custom functions `namespace` to indicate the environment, if your add-in defines custom functions. > From 3cf8d6463bfb5c1f9a585044f5e039d27453407f Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Mon, 12 Aug 2024 16:43:30 -0700 Subject: [PATCH 3/7] format --- docs/includes/manifest-guidance.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/includes/manifest-guidance.md b/docs/includes/manifest-guidance.md index 8d6feac80..594e80ca7 100644 --- a/docs/includes/manifest-guidance.md +++ b/docs/includes/manifest-guidance.md @@ -3,10 +3,10 @@ > > - Specify the URLs that correspond to the environment. > - Customize metadata values so that end users will be able to identify a sideloaded add-in's corresponding environment. For example: - - - In the unified manifest for Microsoft 365, customize the "name" property and the "label" properties for various UI controls to indicate the environment. - - In the add-in only manifest, customize the `DisplayName` element and and labels within `Resources` element to indicate the environment. - +> +> - In the unified manifest for Microsoft 365, customize the "name" property and the "label" properties for various UI controls to indicate the environment. +> - In the add-in only manifest, customize the `DisplayName` element and and labels within `Resources` element to indicate the environment. +> > - Customize the custom functions `namespace` to indicate the environment, if your add-in defines custom functions. > > By following this guidance, you'll streamline the testing process and avoid issues that would otherwise occur when an add-in is simultaneously sideloaded for multiple environments. \ No newline at end of file From 909aa0578d3536ae1d80b0d532b1969e4e2ec39d Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Mon, 12 Aug 2024 16:48:09 -0700 Subject: [PATCH 4/7] typos --- docs/includes/manifest-guidance.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/includes/manifest-guidance.md b/docs/includes/manifest-guidance.md index 594e80ca7..081ae43f3 100644 --- a/docs/includes/manifest-guidance.md +++ b/docs/includes/manifest-guidance.md @@ -4,8 +4,8 @@ > - Specify the URLs that correspond to the environment. > - Customize metadata values so that end users will be able to identify a sideloaded add-in's corresponding environment. For example: > -> - In the unified manifest for Microsoft 365, customize the "name" property and the "label" properties for various UI controls to indicate the environment. -> - In the add-in only manifest, customize the `DisplayName` element and and labels within `Resources` element to indicate the environment. +> - In the unified manifest for Microsoft 365, customize the "name" property of the add-in and the "label" properties for various UI controls to indicate the environment. +> - In the add-in only manifest, customize the `DisplayName` element and and labels within the `Resources` element to indicate the environment. > > - Customize the custom functions `namespace` to indicate the environment, if your add-in defines custom functions. > From 2cb30b9a4693a0f715da8c9f3bbaf9d8bd552419 Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Wed, 14 Aug 2024 10:08:25 -0700 Subject: [PATCH 5/7] Update docs/includes/manifest-guidance.md Co-authored-by: Alison McKay --- docs/includes/manifest-guidance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/includes/manifest-guidance.md b/docs/includes/manifest-guidance.md index 081ae43f3..d5280b894 100644 --- a/docs/includes/manifest-guidance.md +++ b/docs/includes/manifest-guidance.md @@ -2,7 +2,7 @@ > If you'll be testing your add-in across multiple environments (for example, in development, staging, demo, etc.), we recommend that you maintain a different manifest file for each environment. In each manifest file, you can: > > - Specify the URLs that correspond to the environment. -> - Customize metadata values so that end users will be able to identify a sideloaded add-in's corresponding environment. For example: +> - Customize metadata values so that end users are able to identify a sideloaded add-in's corresponding environment. For example: > > - In the unified manifest for Microsoft 365, customize the "name" property of the add-in and the "label" properties for various UI controls to indicate the environment. > - In the add-in only manifest, customize the `DisplayName` element and and labels within the `Resources` element to indicate the environment. From 57d8d9b851cde5d285acfeda00614dfee88f62bd Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Thu, 10 Oct 2024 12:27:57 -0700 Subject: [PATCH 6/7] Update docs/toc.yml --- docs/toc.yml | 38 +++++++++++++++++--------------------- 1 file changed, 17 insertions(+), 21 deletions(-) diff --git a/docs/toc.yml b/docs/toc.yml index 096426ab9..1cfa00f0f 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -116,27 +116,23 @@ items: items: - name: Overview href: develop/add-in-manifests.md - - name: Unified manifest for Microsoft 365 - items: - - name: Office Add-ins with the unified manifest for Microsoft 365 - href: develop/unified-manifest-overview.md - - name: Compare the add-in only manifest with the unified manifest for Microsoft 365 - href: develop/json-manifest-overview.md - - name: Convert an add-in to use the unified manifest for Microsoft 365 - href: develop/convert-xml-to-json-manifest.md - - name: Add-in only manifest - items: - - name: Office Add-ins with the add-in only manifest - href: develop/xml-manifest-overview.md - - name: Add-in only manifest reference - href: reference/manifest-reference.md - - name: Extended overrides - href: develop/extended-overrides.md - - name: Find the proper order of manifest elements - href: develop/manifest-element-ordering.md - - name: Update API and manifest version - href: develop/update-your-javascript-api-for-office-and-manifest-schema-version.md - displayName: manifest + - name: Office Add-ins with the add-in only manifest + href: develop/xml-manifest-overview.md + - name: Office Add-ins with the unified manifest for Microsoft 365 + href: develop/unified-manifest-overview.md + - name: Compare the add-in only manifest with the unified manifest for Microsoft 365 + href: develop/json-manifest-overview.md + - name: Convert an add-in to use the unified manifest for Microsoft 365 + href: develop/convert-xml-to-json-manifest.md + - name: Add-in only manifest reference + href: reference/manifest-reference.md + - name: Extended overrides + href: develop/extended-overrides.md + - name: Find the proper order of manifest elements + href: develop/manifest-element-ordering.md + - name: Update API and manifest version + href: develop/update-your-javascript-api-for-office-and-manifest-schema-version.md + displayName: manifest - name: Privacy, security, and storage items: - name: Overview of add-in privacy and security From 4af28a6c92ba0288098c6a4bce899dfc7a4a4071 Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Tue, 12 Nov 2024 13:33:55 -0800 Subject: [PATCH 7/7] add support note --- docs/develop/json-manifest-overview.md | 5 ++--- docs/develop/unified-manifest-overview.md | 6 ++---- docs/includes/unified-manifest-support-note.md | 2 ++ 3 files changed, 6 insertions(+), 7 deletions(-) create mode 100644 docs/includes/unified-manifest-support-note.md diff --git a/docs/develop/json-manifest-overview.md b/docs/develop/json-manifest-overview.md index 87d50b099..e6d36e5c4 100644 --- a/docs/develop/json-manifest-overview.md +++ b/docs/develop/json-manifest-overview.md @@ -2,7 +2,7 @@ title: Compare the add-in only manifest with the unified manifest for Microsoft 365 description: Get a comparison of the add-in only manifest with the unified manifest for Microsoft 365. ms.topic: overview -ms.date: 04/12/2024 +ms.date: 12/11/2024 ms.localizationpriority: high --- @@ -10,8 +10,7 @@ ms.localizationpriority: high This article is intended to help readers who are familiar with the add-in only manifest understand the unified manifest by comparing the two. Readers should also see [Office Add-ins with the unified manifest for Microsoft 365](unified-manifest-overview.md). -> [!NOTE] -> The unified manifest currently only supports Outlook add-ins and only in Office linked to a Microsoft 365 subscription and installed on Windows, on a mobile device, or in Outlook on the web. We're working on extending support to Excel, PowerPoint, and Word, as well as to Outlook on Mac, and to perpetual versions of Office. +[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)] ## Schemas and general points diff --git a/docs/develop/unified-manifest-overview.md b/docs/develop/unified-manifest-overview.md index 358de89de..40b881487 100644 --- a/docs/develop/unified-manifest-overview.md +++ b/docs/develop/unified-manifest-overview.md @@ -2,7 +2,7 @@ title: Office Add-ins with the unified app manifest for Microsoft 365 description: Get an overview of the unified app manifest for Microsoft 365 for Office Add-ins and its uses. ms.topic: overview -ms.date: 04/12/2024 +ms.date: 12/11/2024 ms.localizationpriority: high --- @@ -20,9 +20,7 @@ One important improvement is the ability to create a single unit of distribution We've taken an important first step toward these goals by making it possible for you to create Outlook add-ins with a unified manifest for Microsoft 365. -> [!NOTE] -> - The unified manifest currently only supports Outlook add-ins and only in Office linked to a Microsoft 365 subscription and installed on Windows, on a mobile device, or in Outlook on the web. We're working on extending support to Excel, PowerPoint, and Word, as well as to Outlook on Mac, and to perpetual versions of Office. -> - The unified manifest requires Office Version 2304 (Build 16320.00000) or later. +[!include[Unified manifest host application support note](../includes/unified-manifest-support-note.md)] > [!TIP] > Ready to get started with the unified manifest? Begin with [Build an Outlook add-in with the unified manifest for Microsoft 365](../quickstarts/outlook-quickstart-json-manifest.md). diff --git a/docs/includes/unified-manifest-support-note.md b/docs/includes/unified-manifest-support-note.md new file mode 100644 index 000000000..f85f25d74 --- /dev/null +++ b/docs/includes/unified-manifest-support-note.md @@ -0,0 +1,2 @@ +> [!NOTE] +> The [unified manifest for Microsoft 365](../develop/unified-manifest-overview.md) can be used in production Outlook add-ins. It's available only as a preview for Excel, PowerPoint, and Word add-ins. \ No newline at end of file