From c4121280a68fb673afd1a490700a155805506e4a Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 5 Sep 2024 09:41:02 -0700 Subject: [PATCH 1/7] [Word] [PowerPoint] (json) Update 'Get whole doc' tutorial --- ...t-from-an-add-in-for-powerpoint-or-word.md | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md index fbf7bc5ee..0a91d77a1 100644 --- a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md +++ b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md @@ -43,6 +43,84 @@ The manifest file for an Office Add-in provides important information about the 1. In a text editor, add the following code to the manifest file. + # [Unified manifest for Microsoft 365](#tab/jsonmanifest) + + > [!IMPORTANT] + > If you're using a Visual Studio project, select the "Add-in only manifest" option. + + ```json + { + "$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json#", + "manifestVersion": "devPreview", + "version": "1.0.0.0", + "id": "[Replace_With_Your_GUID]", + "localizationInfo": { + "defaultLanguageTag": "en-us" + }, + "developer": { + "name": "[Provider Name e.g., Contoso]", + "websiteUrl": "[Insert the URL for the app e.g., https://www.contoso.com]", + "privacyUrl": "[Insert the URL of a page that provides privacy information for the app e.g., https://www.contoso.com/privacy]", + "termsOfUseUrl": "[Insert the URL of a page that provides terms of use for the app e.g., https://www.contoso.com/servicesagreement]" + }, + "name": { + "short": "Get Doc add-in", + "full": "Get Doc add-in" + }, + "description": { + "short": "My get PowerPoint or Word document add-in.", + "full": "My get PowerPoint or Word document add-in." + }, + "icons": { + "outline": "_layouts/images/general/office_logo.jpg", + "color": "_layouts/images/general/office_logo.jpg" + }, + "accentColor": "#230201", + "validDomains": [ + "https://www.contoso.com" + ], + "showLoadingIndicator": false, + "isFullScreen": false, + "defaultBlockUntilAdminAction": false, + "authorization": { + "permissions": { + "resourceSpecific": [ + { + "name": "Document.ReadWrite.User", + "type": "Delegated" + } + ] + } + }, + "extensions": [ + { + "requirements": { + "scopes": [ + "document", + "presentation" + ] + }, + "alternates": [ + { + "alternateIcons": { + "icon": { + "size": 32, + "url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" + }, + "highResolutionIcon": { + "size": 64, + "url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" + } + } + } + ] + } + ] + } + ``` + + # [Add-in only manifest](#tab/xmlmanifest) + ```xml + @@ -67,6 +146,8 @@ The manifest file for an Office Add-in provides important information about the ``` + --- + 1. Save the file as **GetDoc_App.xml** using UTF-8 encoding to a network location or to an add-in catalog. ## Create the user interface for the add-in From 34815db01a28601139c13abe1ad000bc916aa0b8 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 5 Sep 2024 09:50:57 -0700 Subject: [PATCH 2/7] Tag as preview --- ...-the-whole-document-from-an-add-in-for-powerpoint-or-word.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md index 0a91d77a1..659b232e8 100644 --- a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md +++ b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md @@ -43,7 +43,7 @@ The manifest file for an Office Add-in provides important information about the 1. In a text editor, add the following code to the manifest file. - # [Unified manifest for Microsoft 365](#tab/jsonmanifest) + # [Unified manifest for Microsoft 365 (preview)](#tab/jsonmanifest) > [!IMPORTANT] > If you're using a Visual Studio project, select the "Add-in only manifest" option. From 7a025c8343f8fcb3e7eb7a4c8d7488d8c1a35169 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 5 Sep 2024 10:25:25 -0700 Subject: [PATCH 3/7] Update docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md Co-authored-by: Rick Kirkham --- ...he-whole-document-from-an-add-in-for-powerpoint-or-word.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md index 659b232e8..d1b131c6d 100644 --- a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md +++ b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md @@ -43,8 +43,10 @@ The manifest file for an Office Add-in provides important information about the 1. In a text editor, add the following code to the manifest file. - # [Unified manifest for Microsoft 365 (preview)](#tab/jsonmanifest) + # [Unified manifest for Microsoft 365](#tab/jsonmanifest) +> [!NOTE] +> The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins. > [!IMPORTANT] > If you're using a Visual Studio project, select the "Add-in only manifest" option. From 237453af915f7f30b01cd072724caff35c563af1 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 5 Sep 2024 10:29:55 -0700 Subject: [PATCH 4/7] Fix indentation --- ...e-whole-document-from-an-add-in-for-powerpoint-or-word.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md index d1b131c6d..7b0bb7f60 100644 --- a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md +++ b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md @@ -45,8 +45,9 @@ The manifest file for an Office Add-in provides important information about the # [Unified manifest for Microsoft 365](#tab/jsonmanifest) -> [!NOTE] -> The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins. + > [!NOTE] + > The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins. + > [!IMPORTANT] > If you're using a Visual Studio project, select the "Add-in only manifest" option. From 4793bab061541a0d1ede1e332ebd77b426a3b66d Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 5 Sep 2024 10:50:50 -0700 Subject: [PATCH 5/7] Update step to save manifest --- ...ocument-from-an-add-in-for-powerpoint-or-word.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md index 7b0bb7f60..aa51ab2bc 100644 --- a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md +++ b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md @@ -22,7 +22,7 @@ This article assumes that you are using a text editor to create the task pane ad - A CSS file (**Program.css**) to contain the styles and formatting for the add-in. -- An add-in only manifest file (**GetDoc_App.xml**) for the add-in, available on a shared network folder or add-in catalog. The manifest file must point to the location of the HTML file mentioned previously. +- A manifest file (**GetDoc_App.xml** or **GetDoc_App.json**) for the add-in, available on a shared network folder or add-in catalog. The manifest file must point to the location of the HTML file mentioned previously. Alternatively, you can create an add-in for your Office application using one of the following options. You won't have to create new files as the equivalent of each required file will be available for you to update. For example, the Yeoman generator options include **./src/taskpane/taskpane.html**, **./src/taskpane/taskpane.js**, **./src/taskpane/taskpane.css**, and **./manifest.xml**. @@ -41,16 +41,13 @@ Before you begin creating this add-in for PowerPoint or Word, you should be fami The manifest file for an Office Add-in provides important information about the add-in: what applications can host it, the location of the HTML file, the add-in title and description, and many other characteristics. -1. In a text editor, add the following code to the manifest file. +1. In a text editor, add the following code to the manifest file. If you're using a Visual Studio project, select the "Add-in only manifest" option. # [Unified manifest for Microsoft 365](#tab/jsonmanifest) > [!NOTE] > The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins. - > [!IMPORTANT] - > If you're using a Visual Studio project, select the "Add-in only manifest" option. - ```json { "$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json#", @@ -122,6 +119,8 @@ The manifest file for an Office Add-in provides important information about the } ``` +1. Save the file as **GetDoc_App.json** using UTF-8 encoding to a network location or to an add-in catalog. + # [Add-in only manifest](#tab/xmlmanifest) ```xml @@ -149,10 +148,10 @@ The manifest file for an Office Add-in provides important information about the ``` - --- - 1. Save the file as **GetDoc_App.xml** using UTF-8 encoding to a network location or to an add-in catalog. + --- + ## Create the user interface for the add-in For the user interface of the add-in, you can use HTML written directly into the **GetDoc_App.html** file. The programming logic and functionality of the add-in must be contained in a JavaScript file (for example, **GetDoc_App.js**). From eb88b0612d63a12cfacd6b2cc48aee6a4ed8d2e7 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 5 Sep 2024 10:56:07 -0700 Subject: [PATCH 6/7] Fix formatting --- ...t-from-an-add-in-for-powerpoint-or-word.md | 204 +++++++++--------- 1 file changed, 102 insertions(+), 102 deletions(-) diff --git a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md index aa51ab2bc..2198527b2 100644 --- a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md +++ b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md @@ -41,116 +41,116 @@ Before you begin creating this add-in for PowerPoint or Word, you should be fami The manifest file for an Office Add-in provides important information about the add-in: what applications can host it, the location of the HTML file, the add-in title and description, and many other characteristics. -1. In a text editor, add the following code to the manifest file. If you're using a Visual Studio project, select the "Add-in only manifest" option. +In a text editor, add the following code to the manifest file. If you're using a Visual Studio project, select the "Add-in only manifest" option. - # [Unified manifest for Microsoft 365](#tab/jsonmanifest) +# [Unified manifest for Microsoft 365](#tab/jsonmanifest) - > [!NOTE] - > The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins. - - ```json - { - "$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json#", - "manifestVersion": "devPreview", - "version": "1.0.0.0", - "id": "[Replace_With_Your_GUID]", - "localizationInfo": { - "defaultLanguageTag": "en-us" - }, - "developer": { - "name": "[Provider Name e.g., Contoso]", - "websiteUrl": "[Insert the URL for the app e.g., https://www.contoso.com]", - "privacyUrl": "[Insert the URL of a page that provides privacy information for the app e.g., https://www.contoso.com/privacy]", - "termsOfUseUrl": "[Insert the URL of a page that provides terms of use for the app e.g., https://www.contoso.com/servicesagreement]" - }, - "name": { - "short": "Get Doc add-in", - "full": "Get Doc add-in" - }, - "description": { - "short": "My get PowerPoint or Word document add-in.", - "full": "My get PowerPoint or Word document add-in." - }, - "icons": { - "outline": "_layouts/images/general/office_logo.jpg", - "color": "_layouts/images/general/office_logo.jpg" - }, - "accentColor": "#230201", - "validDomains": [ - "https://www.contoso.com" - ], - "showLoadingIndicator": false, - "isFullScreen": false, - "defaultBlockUntilAdminAction": false, - "authorization": { - "permissions": { - "resourceSpecific": [ - { - "name": "Document.ReadWrite.User", - "type": "Delegated" - } +> [!NOTE] +> The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json#", + "manifestVersion": "devPreview", + "version": "1.0.0.0", + "id": "[Replace_With_Your_GUID]", + "localizationInfo": { + "defaultLanguageTag": "en-us" + }, + "developer": { + "name": "[Provider Name e.g., Contoso]", + "websiteUrl": "[Insert the URL for the app e.g., https://www.contoso.com]", + "privacyUrl": "[Insert the URL of a page that provides privacy information for the app e.g., https://www.contoso.com/privacy]", + "termsOfUseUrl": "[Insert the URL of a page that provides terms of use for the app e.g., https://www.contoso.com/servicesagreement]" + }, + "name": { + "short": "Get Doc add-in", + "full": "Get Doc add-in" + }, + "description": { + "short": "My get PowerPoint or Word document add-in.", + "full": "My get PowerPoint or Word document add-in." + }, + "icons": { + "outline": "_layouts/images/general/office_logo.jpg", + "color": "_layouts/images/general/office_logo.jpg" + }, + "accentColor": "#230201", + "validDomains": [ + "https://www.contoso.com" + ], + "showLoadingIndicator": false, + "isFullScreen": false, + "defaultBlockUntilAdminAction": false, + "authorization": { + "permissions": { + "resourceSpecific": [ + { + "name": "Document.ReadWrite.User", + "type": "Delegated" + } + ] + } + }, + "extensions": [ + { + "requirements": { + "scopes": [ + "document", + "presentation" ] - } - }, - "extensions": [ - { - "requirements": { - "scopes": [ - "document", - "presentation" - ] - }, - "alternates": [ - { - "alternateIcons": { - "icon": { - "size": 32, - "url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" - }, - "highResolutionIcon": { - "size": 64, - "url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" - } + }, + "alternates": [ + { + "alternateIcons": { + "icon": { + "size": 32, + "url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" + }, + "highResolutionIcon": { + "size": 64, + "url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" } } - ] - } - ] - } - ``` + } + ] + } + ] +} +``` -1. Save the file as **GetDoc_App.json** using UTF-8 encoding to a network location or to an add-in catalog. - - # [Add-in only manifest](#tab/xmlmanifest) - - ```xml - - - [Replace_With_Your_GUID] - 1.0 - [Provider Name] - EN-US - - - - - - - - - - - - - ReadWriteDocument - - ``` +Save the file as **GetDoc_App.json** to a network location or to an add-in catalog. + +# [Add-in only manifest](#tab/xmlmanifest) + +```xml + + + [Replace_With_Your_GUID] + 1.0 + [Provider Name] + EN-US + + + + + + + + + + + + + ReadWriteDocument + +``` -1. Save the file as **GetDoc_App.xml** using UTF-8 encoding to a network location or to an add-in catalog. +Save the file as **GetDoc_App.xml** using UTF-8 encoding to a network location or to an add-in catalog. - --- +--- ## Create the user interface for the add-in From 53b7bf1875502303d12ba9e21c598ea8876e3cce Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Fri, 6 Sep 2024 08:55:18 -0700 Subject: [PATCH 7/7] Update based on feedback --- ...-the-whole-document-from-an-add-in-for-powerpoint-or-word.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md index 2198527b2..97b877882 100644 --- a/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md +++ b/docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md @@ -119,8 +119,6 @@ In a text editor, add the following code to the manifest file. If you're using a } ``` -Save the file as **GetDoc_App.json** to a network location or to an add-in catalog. - # [Add-in only manifest](#tab/xmlmanifest) ```xml