Skip to content

Commit

Permalink
[Outlook] (quickstart) update unified manifest quickstart (#4341)
Browse files Browse the repository at this point in the history
* [Outlook] (quickstart) update unified manifest quickstart

* a single quickstart for both manifests

* fix build warnings

* add unified manifest value proposition and feedback request

* Apply suggestions from code review

Co-authored-by: Sam Ramon <15154970+samantharamon@users.noreply.github.com>

* make 'Explore the project' section manifest-agnostic

* Update outlook-quickstart-json-manifest-typescript.md

* metadata date

---------

Co-authored-by: Sam Ramon <15154970+samantharamon@users.noreply.github.com>
  • Loading branch information
Rick-Kirkham and samantharamon committed May 3, 2024
1 parent da50a37 commit eec44ad
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 25 deletions.
4 changes: 4 additions & 0 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"redirections": [
{
"source_path": "docs/quickstarts/outlook-quickstart-json-manifest.md",
"redirect_url": "/office/dev/add-ins/quickstarts/outlook-quickstart"
},
{
"source_path": "docs/design/using-office-ui-fabric-react.md",
"redirect_url": "/office/dev/add-ins/quickstarts/fluent-react-quickstart"
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/json-manifest-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,4 @@ For a full sample unified manifest, see [Sample unified manifest](unified-manife

## Next steps

- [Build an Outlook add-in with the unified manifest for Microsoft 365](../quickstarts/outlook-quickstart-json-manifest.md).
- [Build your first Outlook add-in](../quickstarts/outlook-quickstart.md).
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
---
title: Build an Outlook add-in with the unified manifest for Microsoft 365 (preview)
title: Build an Outlook add-in with the unified manifest for Microsoft 365
description: Learn how to build a simple Outlook task pane add-in with the unified manifest for Microsoft 365.
ms.date: 12/11/2023
ms.date: 01/26/2024
ms.service: outlook
ms.localizationpriority: high
---

# Build an Outlook add-in with the unified manifest for Microsoft 365 (preview)
# Build an Outlook add-in with the unified manifest for Microsoft 365

There are two tools that you can use to create an Outlook Add-in project that uses the unified manifest for Microsoft 365. This article describes how to do it with the Yeoman generator for Office (also called "Yo Office"). Alternatively, you can create an Outlook add-in project with the Teams Toolkit as described at [Create Office Add-in projects with Teams Toolkit (preview)](../develop/teams-toolkit-overview.md).
There are two tools that you can use to create an Outlook Add-in project that uses the unified manifest for Microsoft 365. This article describes how to do it with the Yeoman generator for Office (also called "Yo Office"). Alternatively, you can create an Outlook add-in project with the Teams Toolkit as described at [Create Office Add-in projects with Teams Toolkit](../develop/teams-toolkit-overview.md).

In this article, you'll walk through the process of building an Outlook task pane add-in that displays a property of a selected message, triggers a notification on the reading pane, and inserts text into a message on the compose pane. This add-in will use a preview version of the unified, JSON-formatted manifest that Teams extensions, like custom tabs and messaging extensions, use. For more information about this manifest, see [Unified manifest for Microsoft 365 (preview)](../develop/unified-manifest-overview.md).
In this article, you'll walk through the process of building an Outlook task pane add-in that displays a property of a selected message, triggers a notification on the reading pane, and inserts text into a message on the compose pane. This add-in will use the unified manifest for Microsoft 365. For more information about this manifest, see [Unified manifest for Microsoft 365](../develop/unified-manifest-overview.md).

> [!NOTE]
> The new manifest is available for preview and is supported only on Outlook for Windows. It is subject to change based on feedback. We encourage experienced add-in developers to experiment with it. The preview manifest should not be used in production add-ins.
The preview is only supported in Office downloaded from a Microsoft 365 subscription and installed on Windows.
> The unified manifest is supported on Outlook for Windows, Outlook on the web, and Outlook on mobile platforms. We are working to support it in Outlook on Mac and in other Office applications.
> [!TIP]
> If you want to build an Outlook add-in using the XML manifest, see [Build your first Outlook add-in](outlook-quickstart.md).
Expand All @@ -26,7 +24,7 @@ You can create an Office Add-in with the unified manifest by using the [Yeoman g

### Prerequisites

- [.NET runtime](https://dotnet.microsoft.com/download/dotnet/6.0/runtime) for Windows. One of the tools used in the preview runs on .NET.
- [.NET runtime](https://dotnet.microsoft.com/download/dotnet/6.0/runtime) for Windows. One of the tools used for the unified manifest runs on .NET.

[!INCLUDE [Yeoman generator prerequisites](../includes/quickstart-yo-prerequisites.md)]

Expand All @@ -38,14 +36,13 @@ You can create an Office Add-in with the unified manifest by using the [Yeoman g

1. [!include[Yeoman generator create project guidance](../includes/yo-office-command-guidance.md)]

- **Choose a project type** - `Outlook Add-in with unified Microsoft 365 Manifest (preview)`
- **Choose a project type** - `Outlook Add-in with unified Microsoft 365 Manifest`

- **What do you want to name your add-in?** - `Add-in with Unified Manifest`
- **Choose a script type** - `TypeScript`

![The prompts and answers for the Yeoman generator in a command line interface with unified manifest option chosen.](../images/yo-office-outlook-json-manifest.png)
- **What do you want to name your add-in?** - `Add-in with Unified Manifest`

> [!NOTE]
> For this preview, the add-in name cannot be more than 30 characters.
![The prompts and answers for the Yeoman generator with unified manifest and TypeScript options chosen.](../images/yo-office-outlook-json-manifest-typescript.png)

After you complete the wizard, the generator will create the project and install supporting Node components.

Expand Down Expand Up @@ -259,5 +256,5 @@ Add a custom button to the ribbon that inserts text into a message body.

## See also

- [Unified manifest for Microsoft 365 (preview)](../develop/unified-manifest-overview.md)
- [Unified manifest for Microsoft 365](../develop/unified-manifest-overview.md)
- [Using Visual Studio Code to publish](../publish/publish-add-in-vs-code.md#using-visual-studio-code-to-publish)
Binary file modified docs/images/yo-office-outlook-json-manifest-javascript.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/outlook/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ landingContent:
links:
- text: Build your first Outlook add-in
url: ../quickstarts/outlook-quickstart.md
- text: Build your first Outlook add-in with a unified manifest for Microsoft 365 (preview)
url: ../quickstarts/outlook-quickstart-json-manifest.md
- text: Explore Office JavaScript API using Script Lab
url: ../overview/explore-with-script-lab.md
- linkListType: how-to-guide
Expand Down
16 changes: 12 additions & 4 deletions docs/quickstarts/outlook-quickstart.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Build your first Outlook add-in
description: Learn how to build a simple Outlook task pane add-in by using the Office JS API.
ms.date: 04/04/2024
ms.date: 04/12/2024
ms.service: outlook
ms.localizationpriority: high
---
Expand Down Expand Up @@ -34,7 +34,15 @@ You can create an Office Add-in by using the Yeoman generator for Office Add-ins

- **Which Office client application would you like to support?** - `Outlook`

![The prompts and answers for the Yeoman generator in a command line interface.](../images/yo-office-outlook-1.png)
- **Which manifest would you like to use?** - Choose either `unified manifest for Microsoft 365` or `XML manifest`

[!INCLUDE [Unified manifest value proposition and feedback request](../includes/unified-manifest-value-prop-feedback.md)]

Depending on your choice of manifest, the prompts and answers should look like one of the following.

![The prompts and answers for the Yeoman generator when task pane, JavaScript, Outlook, and XML manifest are chosen.](../images/yo-office-outlook-xml-manifest-javascript.png)

![The prompts and answers for the Yeoman generator when task pane, JavaScript, Outlook, and unified manifest are chosen.](../images/yo-office-outlook-json-manifest-javascript.png)

After you complete the wizard, the generator will create the project and install supporting Node components.

Expand All @@ -50,9 +58,9 @@ You can create an Office Add-in by using the Yeoman generator for Office Add-ins

### Explore the project

The add-in project that you've created with the Yeoman generator contains sample code for a very basic task pane add-in.
The Yeoman generator creates a project in a folder with the project name that you chose. The project contains sample code for a very basic task pane add-in. The following are the most important files.

- The **./manifest.xml** file in the root directory of the project defines the settings and capabilities of the add-in.
- The **./manifest.json** or **./manifest.xml** file in the root directory of the project defines the settings and capabilities of the add-in.
- The **./src/taskpane/taskpane.html** file contains the HTML markup for the task pane.
- The **./src/taskpane/taskpane.css** file contains the CSS that's applied to content in the task pane.
- The **./src/taskpane/taskpane.js** file contains the Office JavaScript API code that facilitates interaction between the task pane and Outlook.
Expand Down
3 changes: 0 additions & 3 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -656,9 +656,6 @@ items:
- name: Build your first Outlook add-in
href: quickstarts/outlook-quickstart.md
displayName: Outlook
- name: Build an Outlook add-in with the unified manifest for Microsoft 365
href: quickstarts/outlook-quickstart-json-manifest.md
displayName: Outlook
- name: Outlook add-in tutorial
href: tutorials/outlook-tutorial.md
displayName: Outlook
Expand Down

0 comments on commit eec44ad

Please sign in to comment.